<html> <head> <title>Interface XDocumentMetadataAccess</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="XDocumentMetadataAccess-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 XDocumentMetadataAccess</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDocumentMetadataAccess</strong> ┣ <a href="XURI.html">XURI</a> ┃ ┗ <a href="XResource.html">XResource</a> ┃ ┗ <a href="XNode.html">XNode</a> ┗ <a href="XRepositorySupplier.html">XRepositorySupplier</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XURI.html">XURI</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>represents an URI node that may occur in a RDF graph. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XRepositorySupplier.html">XRepositorySupplier</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>provides access to an RDF Repository. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>document metadata functionality related to the "manifest.rdf". </dd> <dd><p> This interface contains some methods that create connections between the content and the RDF metadata of an ODF document. The main idea is to make querying and manipulating the data in the metadata manifest easier. Among other things, the metadata manifest contains a mapping between ODF elements (in the "content.xml" and "styles.xml" streams) and URIs. Such a mapping works by associating the XML ID of the ODF element with the URI by an RDF statement of the form: <code>URI pkg:idref XmlId.</code> </p> <p> Note that this interface inherits from <a href="XResource.html">XResource</a>: the UUID of the package is the string value of the RDF node. This is so that you can easily make RDF statements about the package. </p> </dd> <dt><b/></dt> <dd/><dt><b/></dt> <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="#getPackageUUID">getPackageUUID</a></td> <td class="imsum_right">get the UUID for the ODF package. </td> </tr> <tr> <td class="imsum_left"><a href="#getElementByXmlId">getElementByXmlId</a></td> <td class="imsum_right">get the unique ODF element with the given XML ID. </td> </tr> <tr> <td class="imsum_left"><a href="#getElementByURI">getElementByURI</a></td> <td class="imsum_right">get the ODF element that corresponds to an URI. </td> </tr> <tr> <td class="imsum_left"><a href="#getURIForElement">getURIForElement</a></td> <td class="imsum_right">find the URI that is associated with an ODF element in the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#getOrCreateURIForElement">getOrCreateURIForElement</a></td> <td class="imsum_right">create an URI for an ODF element. </td> </tr> <tr> <td class="imsum_left"><a href="#createMappingForElement">createMappingForElement</a></td> <td class="imsum_right">establish mapping between an ODF Element and an URI in the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#removeMappingForElement">removeMappingForElement</a></td> <td class="imsum_right">removes mapping for an ODF element from the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#getMetadataGraphsWithType">getMetadataGraphsWithType</a></td> <td class="imsum_right">get the names of all metadata files with a given type. </td> </tr> <tr> <td class="imsum_left"><a href="#addMetadataFile">addMetadataFile</a></td> <td class="imsum_right">add a metadata file to the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#importMetadataFile">importMetadataFile</a></td> <td class="imsum_right">import a metadata file into the document repository, and add it to the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#removeMetadataFile">removeMetadataFile</a></td> <td class="imsum_right">remove a metadata file from the manifest and the repository. </td> </tr> <tr> <td class="imsum_left"><a href="#addContentOrStylesFile">addContentOrStylesFile</a></td> <td class="imsum_right">add a content or styles file to the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#removeContentOrStylesFile">removeContentOrStylesFile</a></td> <td class="imsum_right">remove a content or styles file from the manifest. </td> </tr> <tr> <td class="imsum_left"><a href="#loadMetadataFromStorage">loadMetadataFromStorage</a></td> <td class="imsum_right">initialize document metadata from a storage. </td> </tr> <tr> <td class="imsum_left"><a href="#storeMetadataToStorage">storeMetadataToStorage</a></td> <td class="imsum_right">store document metadata to a storage. </td> </tr> <tr> <td class="imsum_left"><a href="#loadMetadataFromMedium">loadMetadataFromMedium</a></td> <td class="imsum_right">loads document metadata from a medium. </td> </tr> <tr> <td class="imsum_left"><a href="#storeMetadataToMedium">storeMetadataToMedium</a></td> <td class="imsum_right">stores document metadata to a medium. </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="getPackageUUID" class="membertitle">getPackageUUID</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">string</td> </tr> <tr> <td valign="top"><b>getPackageUUID</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the UUID for the ODF package. </dd> <dt><b>Returns</b></dt> <dd>a universally unique ID that identifies this ODF package </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getElementByXmlId" class="membertitle">getElementByXmlId</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"><a href="XMetadatable.html">XMetadatable</a></td> </tr> <tr> <td valign="top"><b>getElementByXmlId</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> XmlId );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the unique ODF element with the given XML ID. </dd> <dt><b>Parameter XmlId</b></dt> <dd>an XML ID, comprising the stream name and the "xml:id" attribute. For example: "content.xml#foo-element-1" </dd> <dt><b>Returns</b></dt> <dd>the ODF element with the given XML ID if it exists, else <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getElementByURI" class="membertitle">getElementByURI</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"><a href="XMetadatable.html">XMetadatable</a></td> </tr> <tr> <td valign="top"><b>getElementByURI</b>(</td> <td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> URI )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the ODF element that corresponds to an URI. </dd> <dd><p> Convenience method that uses the mapping established in the "manifest.rdf" to locate the ODF element corresponding to an URI. </p> </dd> <dt><b>Parameter URI</b></dt> <dd>an URI that may identify an ODF element </dd> <dt><b>Returns</b></dt> <dd>the ODF element that corresponds to the given URI, or <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given URI is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getURIForElement" class="membertitle">getURIForElement</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"><a href="XURI.html">XURI</a></td> </tr> <tr> <td valign="top"><b>getURIForElement</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>find the URI that is associated with an ODF element in the manifest. </dd> <dt><b>Parameter Element</b></dt> <dd>the ODF element for which the URI should be returned </dd> <dt><b>Returns</b></dt> <dd>the URI associated with the element, or <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Element is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getOrCreateURIForElement" class="membertitle">getOrCreateURIForElement</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"><a href="XURI.html">XURI</a></td> </tr> <tr> <td valign="top"><b>getOrCreateURIForElement</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>create an URI for an ODF element. </dd> <dd><p> Convenience method that generates an URI for the given ODF element, and inserts a mapping between the URI and the XML ID of the ODF element into the manifest. If the element does not have a XML ID yet, a new XML ID will be generated. If an URI for the element already exists, it will be returned. </p> </dd> <dt><b>Parameter Element</b></dt> <dd>the ODF element for which an URI should be created. </dd> <dt><b>Returns</b></dt> <dd>the URI associated with the element </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Element is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createMappingForElement" class="membertitle">createMappingForElement</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>createMappingForElement</b>(</td> <td valign="top">[in] <a href="XMetadatable.html">XMetadatable</a></td> <td valign="bottom"> Element,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> URI )</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> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>establish mapping between an ODF Element and an URI in the manifest. </dd> <dd><p> This method Convenience method that generates an URI for the given ODF element, and inserts a mapping between the URI and the XML ID of the ODF element into the manifest. If the element does not have a XML ID yet, a new XML ID will be generated. If there already exists an URI for the element, the mapping will not be changed, and an ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> will be thrown. </p> <p> Note that the mapping maintained by this method is a one-to-one mapping, even though the specification technically permits mapping an XML ID to multiple URIs. </p> </dd> <dt><b>Parameter Element</b></dt> <dd>the ODF element with which an URI should be associated </dd> <dt><b>Parameter URI</b></dt> <dd>the URI which should be associated with the Element </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if any argument is <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if either the URI or the XML ID of the Element is already mapped </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeMappingForElement" class="membertitle">removeMappingForElement</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>removeMappingForElement</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes mapping for an ODF element from the manifest. </dd> <dt><b>Parameter Element</b></dt> <dd>the ODF element for which the mapping should be removed </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Element is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMetadataGraphsWithType" class="membertitle">getMetadataGraphsWithType</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="XURI.html">XURI</a> ></td> </tr> <tr> <td valign="top"><b>getMetadataGraphsWithType</b>(</td> <td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> Type )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the names of all metadata files with a given type. </dd> <dt><b>Parameter Type</b></dt> <dd>the <code>rdf:type</code> property of the requested named graphs </dd> <dt><b>Returns</b></dt> <dd>the names of all metadata graphs that have a <code>rdf:type</code> property with the given Type as object </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given Type is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addMetadataFile" class="membertitle">addMetadataFile</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>addMetadataFile</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> GraphName,</td> </tr> <tr> <td/><td valign="top">[in] sequence< <a href="XURI.html">XURI</a> ></td> <td valign="bottom"> Types )</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> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>add a metadata file to the manifest. </dd> <dd><p> This convenience method does the following: <ul> <li>create a new graph with the given GraphName in the repository</li> <li>insert the required statements declaring the new graph to be a metadata file into the manifest graph</li> <li>insert statements declaring <code>rdf:type</code> properties for the new graph into the manifest graph</li> </ul> </p> </dd> <dt><b>Parameter FileName</b></dt> <dd>the name of the stream in the ODF package where the graph will be stored </dd> <dt><b>Parameter GraphName</b></dt> <dd>the name of the graph that is to be created </dd> <dt><b>Parameter Types</b></dt> <dd>a list of types that will be inserted as <code>rdf:type</code> properties for the graph </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given GraphName is <b>NULL</b>, or the FileName is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if a graph with the given GraphName, or a stream with the given FileName, already exists </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="importMetadataFile" class="membertitle">importMetadataFile</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>importMetadataFile</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Format,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td> <td valign="bottom"> InStream,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> FileName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> GraphName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> BaseURI,</td> </tr> <tr> <td/><td valign="top">[in] sequence< <a href="XURI.html">XURI</a> ></td> <td valign="bottom"> Types )</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> ::com::sun::star::<a href="../datatransfer/module-ix.html">datatransfer</a>::<a href="../datatransfer/UnsupportedFlavorException.html">UnsupportedFlavorException</a>,<br> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> <a href="ParseException.html">ParseException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>import a metadata file into the document repository, and add it to the manifest. </dd> <dd><p> This convenience method does the following: <li>import the given file into a graph with the given GraphName in the repository</li> <li>insert the required statements declaring the new graph to be a metadata file into the manifest graph</li> </p> </dd> <dt><b>Parameter FileName</b></dt> <dd>the name of the stream in the ODF package where the graph will be stored </dd> <dt><b>Parameter GraphName</b></dt> <dd>the name of the graph that is to be created </dd> <dt><b>Parameter BaseURI</b></dt> <dd>a base URI to resolve relative URI references </dd> <dt><b>Parameter Types</b></dt> <dd>a list of types that will be inserted as <code>rdf:type</code> properties for the graph </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given stream or the GraphName is <b>NULL</b>, or BaseURI is <b>NULL</b> and the format requires use of a base URI, or the FileName is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::datatransfer::UnsupportedFlavorException if the format requested is unknown or not supported </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if a graph with the given GraphName, or a stream with the given FileName, already exists </dd> <dt><b>Throws</b></dt> <dd>ParseException if the input does not conform to the specified file format. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if an I/O error occurs. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeMetadataFile" class="membertitle">removeMetadataFile</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>removeMetadataFile</b>(</td> <td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> GraphName )</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> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove a metadata file from the manifest and the repository. </dd> <dd><p> This convenience method does the following: <li>delete the graph with the given GraphName in the repository</li> <li>remove the statements declaring the graph to be a metadata file from the manifest graph</li> </p> </dd> <dt><b>Parameter GraphName</b></dt> <dd>the name of the graph that is to be removed </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given GraphName is <b>NULL</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::NoSuchElementException if a graph with the given GraphName does not exist </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addContentOrStylesFile" class="membertitle">addContentOrStylesFile</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>addContentOrStylesFile</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileName )</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> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>add a content or styles file to the manifest. </dd> <dd><p> This convenience method adds the required statements declaring a content or styles file to the manifest graph. <ul> <li>If the FileName ends in "content.xml", an <code>odf:ContentFile</code> is added.</li> <li>If the FileName ends in "styles.xml" , an <code>odf:StylesFile</code> is added.</li> <li>Other FileNames are invalid.</li> </ul> </p> </dd> <dt><b>Parameter FileName</b></dt> <dd>the name of the stream in the ODF package </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the FileName is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if a stream with the given FileName already exists </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeContentOrStylesFile" class="membertitle">removeContentOrStylesFile</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>removeContentOrStylesFile</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileName )</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> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove a content or styles file from the manifest. </dd> <dd><p> This convenience method removes the statements declaring a content or styles file from the manifest graph, as well as all mappings that refer to the file. </p> </dd> <dt><b>Parameter FileName</b></dt> <dd>the name of the stream in the ODF package </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the FileName is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::NoSuchElementException if a graph with the given GraphName does not exist </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadMetadataFromStorage" class="membertitle">loadMetadataFromStorage</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>loadMetadataFromStorage</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td> <td valign="bottom"> Storage,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XURI.html">XURI</a></td> <td valign="bottom"> BaseURI )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>initialize document metadata from a storage. </dd> <dd><p> This method re-initializes the document metadata, loads the stream named "manifest.rdf" from the storage, and then loads all metadata streams mentioned in the manifest. </p> <p> Note that it is not an error if the storage does not contain a manifest. In this case, the document metadata will be default initialized. </p> </dd> <dt><b>Parameter Storage</b></dt> <dd>a storage, representing e.g. an ODF package file </dd> <dt><b>Parameter BaseURI</b></dt> <dd>a base URI to resolve relative URI references </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if any argument is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeMetadataToStorage" class="membertitle">storeMetadataToStorage</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>storeMetadataToStorage</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td> <td valign="bottom"> Storage )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>store document metadata to a storage. </dd> <dd><p> This method stores all the graphs in the document metadata repository to the given storage. </p> <p> Note that to be stored correctly, a named graph must have a complete entry in the manifest graph, with a <code>pkg:path</code> property that denotes a legal stream name. </p> </dd> <dt><b>Parameter Storage</b></dt> <dd>a storage, representing e.g. an ODF package file </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if any argument is <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadMetadataFromMedium" class="membertitle">loadMetadataFromMedium</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>loadMetadataFromMedium</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</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> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>loads document metadata from a medium. </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the source </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the argument does not contain a URL or Stream property </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to access the medium </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when trying to access the medium </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeMetadataToMedium" class="membertitle">storeMetadataToMedium</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>storeMetadataToMedium</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Medium )</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> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores document metadata to a medium. </dd> <dt><b>Parameter Medium</b></dt> <dd>the com::sun::star::document::MediaDescriptor representing the target </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the argument does not contain a URL or Stream property </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if thrown when trying to access the medium </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if thrown when trying to access the medium </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2010 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
