<html> <head> <title>Interface XDocumentRepository</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDocumentRepository-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rdf</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XDocumentRepository</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDocumentRepository</strong> ┗ <a href="XRepository.html">XRepository</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XRepository.html">XRepository</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>provides access to a set of named RDF graphs. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>extends <a href="XRepository.html">XRepository</a> with document-specific functionality. </dd> <dd><p> This subclass of <a href="XRepository.html">XRepository</a> provides some methods which only make sense for repositories that are attached to a document. For example, the methods allow for manipulating in-content metadata, which is stored as RDFa. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.2</dd> <dt><b>See also</b></dt> <dd><a href="XRepositorySupplier.html">XRepositorySupplier</a>, <a href="XDocumentMetadataAccess.html">XDocumentMetadataAccess</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#setStatementRDFa">setStatementRDFa</a></td> <td class="imsum_right">update the RDFa statement(s) that correspond to an ODF element in the repository. </td> </tr> <tr> <td class="imsum_left"><a href="#removeStatementRDFa">removeStatementRDFa</a></td> <td class="imsum_right">remove the RDFa statement(s) that correspond to an ODF element from the repository. </td> </tr> <tr> <td class="imsum_left"><a href="#getStatementRDFa">getStatementRDFa</a></td> <td class="imsum_right">find the RDFa statement(s) associated with an ODF element. </td> </tr> <tr> <td class="imsum_left"><a href="#getStatementsRDFa">getStatementsRDFa</a></td> <td class="imsum_right">gets matching RDFa statements from the repository. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="setStatementRDFa" class="membertitle">setStatementRDFa</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStatementRDFa</b>(</td> <td valign="top">[in] <a href="XResource.html">XResource</a></td> <td valign="bottom"> Subject,</td> </tr> <tr> <td/><td valign="top">[in] sequence< <a href="XURI.html">XURI</a> ></td> <td valign="bottom"> Predicates,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XMetadatable.html">XMetadatable</a></td> <td valign="bottom"> Object,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> RDFaContent,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> RDFaDatatype )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="RepositoryException.html">RepositoryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>update the RDFa statement(s) that correspond to an ODF element in the repository. </dd> <dd><p> This method will do the following steps: <ol> <li>Remove all previously set RDFa statements for the Object parameter from the repository</li> <li>If the RDFaContent parameter is the empty <code>string</code>, for every Predicate in the given list of Predicates, add the following RDF statement to an unspecified named graph: <ul> <li><code>Subject Predicate XLiteral(Object->getText()^^RDFaDatatype)</code></li> </ul> </li> <li>If the RDFaContent parameter is not the empty <code>string</code>, for every Predicate in the given list of Predicates, add the following RDF statement to an unspecified named graph: <ul> <li> <code>Subject Predicate XLiteral(RDFaContent^^RDFaDatatype)</code> </li> </ul> Further, add the following RDF statement to the same unspecified named graph: <ul> <li> <code>Subject rdfs:label XLiteral(Object->getText())</code> </li> </ul> </li> </ol> </p> <p> RDFa statements are handled specially because they are not logically part of any named graph in the repository. Also, they have rather unusual semantics; just using <a href="XNamedGraph.html">XNamedGraph</a>::<a href="XNamedGraph.html#addStatement">addStatement</a> would be ambiguous: if the object is a <a href="XMetadatable.html">XMetadatable</a>, do we insert the object itself (URI) or its literal content (RDFa)? </p> </dd> <dt><b>Parameter Subject</b></dt> <dd>the subject of the RDF triple(s). </dd> <dt><b>Parameter Predicates</b></dt> <dd>the predicates of the RDF triple(s). </dd> <dt><b>Parameter Object</b></dt> <dd>the object of the RDF triple(s) is the text content of this parameter. </dd> <dt><b>Parameter RDFaContent</b></dt> <dd>the <code>rdfa:content</code> attribute (may be the empty <code>string</code>). </dd> <dt><b>Parameter RDFaDatatype</b></dt> <dd>the <code>rdfa:datatype</code> attribute (may be <b>NULL</b>) </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if any parameter is <b>NULL</b>, Predicates is empty, or Object is of a type that can not have RDFa metadata attached. </dd> <dt><b>Throws</b></dt> <dd>RepositoryException if an error occurs when accessing the repository. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeStatementRDFa" class="membertitle">removeStatementRDFa</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeStatementRDFa</b>(</td> <td valign="top">[in] <a href="XMetadatable.html">XMetadatable</a></td> <td valign="bottom"> Element )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="RepositoryException.html">RepositoryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove the RDFa statement(s) that correspond to an ODF element from the repository. </dd> <dd><p> RDFa statements are handled specially because they are not logically part of any graph. </p> </dd> <dt><b>Parameter Element</b></dt> <dd>the element whose RDFa statement(s) should be removed </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Element is <b>NULL</b>, or of a type that can not have RDFa metadata attached. </dd> <dt><b>Throws</b></dt> <dd>RepositoryException if an error occurs when accessing the repository. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStatementRDFa" class="membertitle">getStatementRDFa</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="Statement.html">Statement</a> ></td> </tr> <tr> <td valign="top"><b>getStatementRDFa</b>(</td> <td valign="top">[in] <a href="XMetadatable.html">XMetadatable</a></td> <td valign="bottom"> Element )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="RepositoryException.html">RepositoryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>find the RDFa statement(s) associated with an ODF element. </dd> <dt><b>Parameter Element</b></dt> <dd>the ODF element for which RDFa statements should be found </dd> <dt><b>Returns</b></dt> <dd><ul> <li>if the element has no RDFa meta-data attributes: the empty sequence.</li> <li>if the element has RDFa meta-data attributes: and no <code>rdfa:content</code> attached: a sequence with the RDFa-statements corresponding to the attributes</li> <li>if the element has RDFa meta-data attributes, and also <code>rdfa:content</code> attached: a sequence with the RDFa-statements corresponding to the attributes, including the RDFa-labels-statement</li> </ul> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Element is <b>NULL</b>, or of a type that can not have RDFa metadata attached. </dd> <dt><b>Throws</b></dt> <dd>RepositoryException if an error occurs when accessing the repository. </dd> <dt><b>See also</b></dt> <dd><a href="Statement.html">Statement</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStatementsRDFa" class="membertitle">getStatementsRDFa</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumeration.html">XEnumeration</a></td> </tr> <tr> <td valign="top"><b>getStatementsRDFa</b>(</td> <td valign="top">[in] <a href="XResource.html">XResource</a></td> <td valign="bottom"> Subject,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> Predicate,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XNode.html">XNode</a></td> <td valign="bottom"> Object )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="RepositoryException.html">RepositoryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets matching RDFa statements from the repository. </dd> <dd><p> This method exists because RDFa statements are not part of any named graph, and thus they cannot be enumerated with <a href="XNamedGraph.html">XNamedGraph</a>::<a href="XNamedGraph.html#getStatements">getStatements</a>. </p> <p> Any parameter may be <b>NULL</b>, which acts as a wildcard. For example, to get all statements about myURI: <code>getStatementsRDFa(myURI, null, null)</code> </p> </dd> <dt><b>Parameter Subject</b></dt> <dd>the subject of the RDF triple. </dd> <dt><b>Parameter Predicate</b></dt> <dd>the predicate of the RDF triple. </dd> <dt><b>Parameter Object</b></dt> <dd>the object of the RDF triple. </dd> <dt><b>Returns</b></dt> <dd>an iterator over all RDFa statements in the repository that match the parameters, represented as an enumeration of <a href="Statement.html">Statement</a> </dd> <dt><b>Throws</b></dt> <dd>RepositoryException if an error occurs when accessing the repository. </dd> <dt><b>See also</b></dt> <dd><a href="Statement.html">Statement</a>, <a href="XRepository.html">XRepository</a>::<a href="XRepository.html#getStatements">getStatements</a>, <a href="XNamedGraph.html">XNamedGraph</a>::<a href="XNamedGraph.html#getStatements">getStatements</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>