summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/rdf/XNamedGraph.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/rdf/XNamedGraph.idl')
-rw-r--r--offapi/com/sun/star/rdf/XNamedGraph.idl229
1 files changed, 229 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl
new file mode 100644
index 000000000000..d71c5a599e9e
--- /dev/null
+++ b/offapi/com/sun/star/rdf/XNamedGraph.idl
@@ -0,0 +1,229 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_rdf_XNamedGraph_idl__
+#define __com_sun_star_rdf_XNamedGraph_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_container_NoSuchElementException_idl__
+#include <com/sun/star/container/NoSuchElementException.idl>
+#endif
+
+#ifndef __com_sun_star_container_XEnumeration_idl__
+#include <com/sun/star/container/XEnumeration.idl>
+#endif
+
+#ifndef __com_sun_star_rdf_RepositoryException_idl__
+#include <com/sun/star/rdf/RepositoryException.idl>
+#endif
+
+#ifndef __com_sun_star_rdf_XURI_idl__
+#include <com/sun/star/rdf/XURI.idl>
+#endif
+
+
+//=============================================================================
+
+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 <type>XResource</type>: 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
+ <member>XRepository::destroyGraph</member>.
+ If a graph is destroyed, subsequent calls to <member>addStatement</member>,
+ <member>removeStatements</member> will fail with an
+ <type scope="com::sun::star::container">NoSuchElementException</type>.
+ </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 <type>XMetadatable</type>, which inherits
+ from <type>XResource</type>, 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 <type>XMetadatable</type>, which inherits
+ from <type>XResource</type>, 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 <type>XMetadatable</type>, which inherits
+ from <type>XResource</type>, 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 <type>Statement</type>
+
+ @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)...
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-14 14:43:30 +0000