190 lines
6 KiB
Text
190 lines
6 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
|
|
|
|
module com { module sun { module star { module rdf {
|
|
|
|
/** represents an RDF named graph that is stored in an RDF Repository.
|
|
|
|
<p>
|
|
Note that this interface inherits from XResource: the
|
|
name of the graph is the string value of the RDF node.
|
|
This is so that you can easily make RDF statements about named graphs.
|
|
</p>
|
|
|
|
<p>
|
|
Note that instances may be destroyed via
|
|
XRepository::destroyGraph().
|
|
If a graph is destroyed, subsequent calls to addStatement(),
|
|
removeStatements() will fail with an
|
|
com::sun::star::container::NoSuchElementException.
|
|
</p>
|
|
|
|
@since OOo 3.2
|
|
|
|
@see XRepository
|
|
*/
|
|
interface XNamedGraph : XURI
|
|
{
|
|
|
|
/** returns the name of the graph.
|
|
|
|
<p>
|
|
The name is unique within the repository.
|
|
</p>
|
|
|
|
@returns
|
|
the name of the graph
|
|
*/
|
|
XURI getName();
|
|
|
|
/** removes all statements from the graph.
|
|
|
|
@throws com::sun::star::container::NoSuchElementException
|
|
if this graph does not exist in the repository any more
|
|
|
|
@throws RepositoryException
|
|
if an error occurs when accessing the repository.
|
|
*/
|
|
void clear()
|
|
raises( com::sun::star::container::NoSuchElementException,
|
|
RepositoryException );
|
|
|
|
/** adds a RDF statement to the graph.
|
|
|
|
<p>
|
|
Note that the ODF elements that can have metadata attached all
|
|
implement the interface XMetadatable, which inherits
|
|
from XResource, meaning that you can simply pass them
|
|
in as arguments here, and it will magically work.
|
|
</p>
|
|
|
|
@param Subject
|
|
the subject of the RDF triple.
|
|
|
|
@param Predicate
|
|
the predicate of the RDF triple.
|
|
|
|
@param Object
|
|
the object of the RDF triple.
|
|
|
|
@throws com::sun::star::lang::IllegalArgumentException
|
|
if any parameter is `NULL`
|
|
|
|
@throws com::sun::star::container::NoSuchElementException
|
|
if this graph does not exist in the repository any more
|
|
|
|
@throws RepositoryException
|
|
if an error occurs when accessing the repository.
|
|
*/
|
|
void addStatement([in] XResource Subject,
|
|
[in] XURI Predicate,
|
|
[in] XNode Object)
|
|
raises( com::sun::star::lang::IllegalArgumentException,
|
|
com::sun::star::container::NoSuchElementException,
|
|
RepositoryException );
|
|
|
|
/** removes matching RDF statements from the graph.
|
|
|
|
<p>
|
|
Note that the ODF elements that can have metadata attached all
|
|
implement the interface XMetadatable, which inherits
|
|
from XResource, meaning that you can simply pass them
|
|
in as arguments here, and it will magically work.
|
|
</p>
|
|
|
|
<p>
|
|
Any parameter may be `NULL`, which acts as a wildcard.
|
|
For example, to remove all statements about myURI:
|
|
<code>removeStatement(myURI, null, null)</code>
|
|
</p>
|
|
|
|
@param Subject
|
|
the subject of the RDF triple.
|
|
|
|
@param Predicate
|
|
the predicate of the RDF triple.
|
|
|
|
@param Object
|
|
the object of the RDF triple.
|
|
|
|
@throws com::sun::star::container::NoSuchElementException
|
|
if this graph does not exist in the repository any more
|
|
|
|
@throws RepositoryException
|
|
if an error occurs when accessing the repository.
|
|
*/
|
|
void removeStatements([in] XResource Subject,
|
|
[in] XURI Predicate,
|
|
[in] XNode Object)
|
|
raises( com::sun::star::container::NoSuchElementException,
|
|
RepositoryException );
|
|
|
|
/** gets matching RDF statements from a graph.
|
|
|
|
<p>
|
|
Note that the ODF elements that can have metadata attached all
|
|
implement the interface XMetadatable, which inherits
|
|
from XResource, meaning that you can simply pass them
|
|
in as arguments here, and it will magically work.
|
|
</p>
|
|
|
|
<p>
|
|
Any parameter may be `NULL`, which acts as a wildcard.
|
|
For example, to get all statements about myURI:
|
|
<code>getStatements(myURI, null, null)</code>
|
|
</p>
|
|
|
|
@param Subject
|
|
the subject of the RDF triple.
|
|
|
|
@param Predicate
|
|
the predicate of the RDF triple.
|
|
|
|
@param Object
|
|
the object of the RDF triple.
|
|
|
|
@returns
|
|
an iterator over all RDF statements in the graph that match
|
|
the parameters, represented as an
|
|
enumeration of Statement
|
|
|
|
@throws com::sun::star::container::NoSuchElementException
|
|
if this graph does not exist in the repository any more
|
|
|
|
@throws RepositoryException
|
|
if an error occurs when accessing the repository.
|
|
|
|
@see Statement
|
|
*/
|
|
com::sun::star::container::XEnumeration/*<Statement>*/ getStatements(
|
|
[in] XResource Subject,
|
|
[in] XURI Predicate,
|
|
[in] XNode Object)
|
|
raises( com::sun::star::container::NoSuchElementException,
|
|
RepositoryException );
|
|
|
|
//FIXME reification: addReifiedStatement(Statement)...
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|