Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 4579

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<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>
&#x2523 <a href="XURI.html">XURI</a>
&#x2503 &#x2517 <a href="XResource.html">XResource</a>
&#x2503    &#x2517 <a href="XNode.html">XNode</a>
&#x2517 <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>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<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.
 </p>

 <p>
 Note that this interface inherits from <a href="XURI.html">XURI</a>: the
 base URI of the document is the string value of the RDF node.
 This is so that you can easily make RDF statements about the document.
 </p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.2</dd>
<dt><b>See also</b></dt>
<dd><a href="XDocumentRepository.html">XDocumentRepository</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="#getElementByMetadataReference">getElementByMetadataReference</a></td>
<td class="imsum_right">get the unique ODF element with the given metadata reference.

 &nbsp;</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.

 &nbsp;</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.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addMetadataFile">addMetadataFile</a></td>
<td class="imsum_right">add a metadata file to the manifest.

 &nbsp;</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.

 &nbsp;</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.

 &nbsp;</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.

 &nbsp;</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.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#loadMetadataFromStorage">loadMetadataFromStorage</a></td>
<td class="imsum_right">initialize document metadata from a storage.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#storeMetadataToStorage">storeMetadataToStorage</a></td>
<td class="imsum_right">store document metadata to a storage.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#loadMetadataFromMedium">loadMetadataFromMedium</a></td>
<td class="imsum_right">loads document metadata from a medium.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#storeMetadataToMedium">storeMetadataToMedium</a></td>
<td class="imsum_right">stores document metadata to a medium.

 &nbsp;</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="getElementByMetadataReference" class="membertitle">getElementByMetadataReference</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>getElementByMetadataReference</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a></td>
<td valign="bottom">&nbsp;MetadataReference );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the unique ODF element with the given metadata reference.

 </dd>
<dt><b>Parameter MetadataReference</b></dt>
<dd>a metadata reference, comprising the stream name and the XML ID
 For example: Pair("content.xml", "foo-element-1")

 </dd>
<dt><b>Returns</b></dt>
<dd>the ODF element with the given metadata references 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">&nbsp;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>
<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="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&lt; <a href="XURI.html">XURI</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getMetadataGraphsWithType</b>(</td>
<td valign="top">[in] <a href="XURI.html">XURI</a></td>
<td valign="bottom">&nbsp;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"><a href="XURI.html">XURI</a></td>
</tr>
<tr>
<td valign="top"><b>addMetadataFile</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;FileName,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; <a href="XURI.html">XURI</a> &gt;</td>
<td valign="bottom">&nbsp;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 name in the repository</li>
 <li>insert 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 storage where the graph will
 be stored

 </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>Returns</b></dt>
<dd>the name of the new graph

 </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="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"><a href="XURI.html">XURI</a></td>
</tr>
<tr>
<td valign="top"><b>importMetadataFile</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;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">&nbsp;InStream,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;FileName,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XURI.html">XURI</a></td>
<td valign="bottom">&nbsp;BaseURI,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; <a href="XURI.html">XURI</a> &gt;</td>
<td valign="bottom">&nbsp;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 name
 in the repository</li>
 <li>insert 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>
 </p>

 </dd>
<dt><b>Parameter FileName</b></dt>
<dd>the name of the stream in the ODF storage where the graph will
 be stored

 </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>Returns</b></dt>
<dd>the name of the new graph

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the given stream 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 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>See also</b></dt>
<dd><a href="FileFormat.html">FileFormat</a></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">&nbsp;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">&nbsp;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 storage

 </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">&nbsp;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.
 </p>

 </dd>
<dt><b>Parameter FileName</b></dt>
<dd>the name of the stream in the ODF storage

 </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">&nbsp;Storage,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XURI.html">XURI</a></td>
<td valign="bottom">&nbsp;BaseURI,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionHandler.html">XInteractionHandler</a></td>
<td valign="bottom">&nbsp;InteractionHandler )</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> );</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>

 <p>
 If an InteractionHandler argument is given, it will be used for
 error reporting. Otherwise, errors will be reported as exceptions.
 </p>

 </dd>
<dt><b>Parameter Storage</b></dt>
<dd>a storage, representing e.g. an ODF package file, or sub-document

 </dd>
<dt><b>Parameter BaseURI</b></dt>
<dd>a base URI to resolve relative URI references
 <p>N.B.: when loading from an ODF package, the base URI is not the
 URI of the package, but the URI of the directory in the package
 that contains the metadata.rdf</p>

 </dd>
<dt><b>Parameter InteractionHandler</b></dt>
<dd>an InteractionHandler, used for error reporting

 </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::lang::WrappedTargetException
 if an error occurs while loading and no InteractionHandler given
 </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">&nbsp;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>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</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.
 </p>

 </dd>
<dt><b>Parameter Storage</b></dt>
<dd>a storage, representing e.g. an ODF package file, or sub-document

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if Storage argument is <b>NULL</b>

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::WrappedTargetException
 if an error occurs while loading
 </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&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;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> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>loads document metadata from a medium.

 </dd>
<dd><p>If the Medium contains an InteractionHandler, it will be used for
 error reporting.</p>

 </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 an error occurs while loading

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a></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&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;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> );</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 an error occurs while storing

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</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 &copy; 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>