| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:26:20 CET 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>OdfPackage (ODFDOM API v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)</title> |
| <meta name="date" content="2013-02-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OdfPackage (ODFDOM API v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OdfPackage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/odftoolkit/odfdom/pkg/OdfNamespace.html" title="class in org.odftoolkit.odfdom.pkg"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/odfdom/pkg/OdfPackage.html" target="_top">Frames</a></li> |
| <li><a href="OdfPackage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.odftoolkit.odfdom.pkg</div> |
| <h2 title="Class OdfPackage" class="title">Class OdfPackage</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.odftoolkit.odfdom.pkg.OdfPackage</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">OdfPackage</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre> |
| <div class="block">OdfPackage represents the package view to an OpenDocument document. The |
| OdfPackage will be created from an ODF document and represents a copy of the |
| loaded document, where files can be inserted and deleted. The changes take |
| effect, when the OdfPackage is being made persisted by save().</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg">OdfPackage.OdfFile</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#close()">close</a></strong>()</code> |
| <div class="block">Close the OdfPackage after it is no longer needed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#contains(java.lang.String)">contains</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Check existence of a file in the package.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getBaseURI()">getBaseURI</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getBytes(java.lang.String)">getBytes</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Get package (sub-) content as byte array</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getCachedDocument(java.lang.String)">getCachedDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>This method is only added temporary as workaround for the IBM |
| fork using different DOC classes. Until the registering of |
| DOC documents to the PKG layer has been finished.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDocumentPaths()">getDocumentPaths</a></strong>()</code> |
| <div class="block">Method returns the paths of all document within the package.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDocumentPaths(java.lang.String)">getDocumentPaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaTypeString)</code> |
| <div class="block">Method returns the paths of all document within the package matching the |
| given criteria.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDom(java.lang.String)">getDom</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Gets org.w3c.dom.Document for XML file contained in package.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getEntityResolver()">getEntityResolver</a></strong>()</code> |
| <div class="block">Get EntityResolver to be used in XML Parsers which can resolve content |
| inside the OdfPackage</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()">getErrorHandler</a></strong>()</code> |
| <div class="block">Return the current error handler used for ODF validation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfFileEntry.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfFileEntry</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getFileEntry(java.lang.String)">getFileEntry</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Get an OdfFileEntry for the internalPath NOTE: This method should be |
| better moved to a DOM inherited Manifest class</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getFilePaths()">getFilePaths</a></strong>()</code> |
| <div class="block">Get a OdfFileEntries from the manifest file (i.e.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream()">getInputStream</a></strong>()</code> |
| <div class="block">Gets the InputStream containing whole OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream(java.lang.String)">getInputStream</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Get the latest version of package content as InputStream, as it would be |
| saved.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream(java.lang.String, boolean)">getInputStream</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| boolean useOriginal)</code> |
| <div class="block">Get the latest version of package content as InputStream, as it would be |
| saved.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfManifestDom.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfManifestDom</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getManifestDom()">getManifestDom</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getMediaTypeString()">getMediaTypeString</a></strong>()</code> |
| <div class="block">Get the media type of the ODF package (equal to media type of ODF root |
| document)</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getMediaTypeString(java.lang.String)">getMediaTypeString</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Get the media type of the ODF file or document (ie. a directory).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getRootDocument()">getRootDocument</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getURIResolver()">getURIResolver</a></strong>()</code> |
| <div class="block">Get URIResolver to be used in XSL Transformations which can resolve |
| content inside the OdfPackage</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insert(byte[], java.lang.String, java.lang.String)">insert</a></strong>(byte[] fileBytes, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaTypeString)</code> |
| <div class="block">Inserts a byte array into OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insert(org.w3c.dom.Document, java.lang.String, java.lang.String)">insert</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a> fileDOM, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> |
| <div class="block">Insert DOM tree into OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insert(java.io.InputStream, java.lang.String, java.lang.String)">insert</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> fileStream, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> |
| <div class="block">Inserts InputStream into an OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insert(java.net.URI, java.lang.String, java.lang.String)">insert</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> sourceURI, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> |
| <div class="block">Inserts an external file into an OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</a></strong>(<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a> sourceDocument, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Embed an OdfPackageDocument to the current OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insertOutputStream(java.lang.String)">insertOutputStream</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Insert the OutputStream for into OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insertOutputStream(java.lang.String, java.lang.String)">insertOutputStream</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> |
| <div class="block">Insert the OutputStream - to be filled after method - when stream is |
| closed into OdfPackage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#isExternalReference(java.lang.String)">isExternalReference</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Checks if the given reference is a reference, which points outside the |
| ODF package</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadDocument(java.lang.String)">loadDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Returns on ODF documents based a given mediatype.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile)</code> |
| <div class="block">Loads an OdfPackage from the OpenDocument provided by a File.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File, org.xml.sax.ErrorHandler)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler)</code> |
| <div class="block">Loads an OdfPackage from the given File.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File, java.lang.String, org.xml.sax.ErrorHandler)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler)</code> |
| <div class="block">Loads an OdfPackage from the given File.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.InputStream)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> packageStream)</code> |
| <div class="block">Creates an OdfPackage from the given InputStream.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.InputStream, java.lang.String, org.xml.sax.ErrorHandler)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> packageStream, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseURI, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler)</code> |
| <div class="block">Creates an OdfPackage from the given InputStream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.lang.String)">loadPackage</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> |
| <div class="block">Loads an OdfPackage from the given documentURL.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#remove(java.lang.String)">remove</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Removes a single file from the package.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#removeDocument(java.lang.String)">removeDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</code> |
| <div class="block">Removes a document from the package via its path.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#save(java.io.File)">save</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile)</code> |
| <div class="block">Save package to a given File.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#save(java.io.OutputStream)">save</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> odfStream)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#save(java.lang.String)">save</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> odfPath)</code> |
| <div class="block">Save the package to given documentURL.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#setErrorHandler(org.xml.sax.ErrorHandler)">setErrorHandler</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> handler)</code> |
| <div class="block">Allow an application to register an error event handler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#setPassword(java.lang.String)">setPassword</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> |
| <div class="block">Sets the password of this package. if password is not null, package will |
| be encrypted when save.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="loadPackage(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Loads an OdfPackage from the given documentURL. |
| <p> |
| OdfPackage relies on the file being available for read access over the |
| whole lifecycle of OdfPackage. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - - the documentURL to the ODF package</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the OpenDocument document represented as an OdfPackage</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be loaded</dd></dl> |
| </li> |
| </ul> |
| <a name="loadPackage(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Loads an OdfPackage from the OpenDocument provided by a File. |
| <p> |
| OdfPackage relies on the file being available for read access over the |
| whole lifecycle of OdfPackage. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pkgFile</code> - - the ODF Package</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the OpenDocument document represented as an OdfPackage</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be loaded</dd></dl> |
| </li> |
| </ul> |
| <a name="loadPackage(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> packageStream) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Creates an OdfPackage from the given InputStream. |
| <p> |
| Since an InputStream does not provide the arbitrary (non sequentiell) |
| read access needed by OdfPackage, the InputStream is cached. This usually |
| takes more time compared to the other loadPackage methods. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>packageStream</code> - - an inputStream representing the ODF package</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the OpenDocument document represented as an OdfPackage</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be loaded</dd></dl> |
| </li> |
| </ul> |
| <a name="loadPackage(java.io.InputStream, java.lang.String, org.xml.sax.ErrorHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> packageStream, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseURI, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Creates an OdfPackage from the given InputStream. |
| <p> |
| OdfPackage relies on the file being available for read access over the |
| whole lifecycle of OdfPackage. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>packageStream</code> - - an inputStream representing the ODF package</dd><dd><code>baseURI</code> - allows to explicitly set the base URI from the document, As |
| the URL can not be derived from a stream. In addition it is |
| possible to set the baseURI to any arbitrary URI, e.g. an URN. |
| One usage of the baseURI to describe the source of validation |
| exception thrown by the ErrorHandler.</dd><dd><code>errorHandler</code> - - SAX ErrorHandler used for ODF validation</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be created</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><code>getErrorHandler()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="loadPackage(java.io.File, org.xml.sax.ErrorHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Loads an OdfPackage from the given File. |
| <p> |
| OdfPackage relies on the file being available for read access over the |
| whole lifecycle of OdfPackage. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pkgFile</code> - - the ODF Package. A baseURL is being generated based on its |
| location.</dd><dd><code>errorHandler</code> - - SAX ErrorHandler used for ODF validation.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be created</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><code>getErrorHandler()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="loadPackage(java.io.File, java.lang.String, org.xml.sax.ErrorHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadPackage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a> loadPackage(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password, |
| <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> errorHandler) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Loads an OdfPackage from the given File. |
| <p> |
| OdfPackage relies on the file being available for read access over the |
| whole lifecycle of OdfPackage. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pkgFile</code> - - the ODF Package. A baseURL is being generated based on its |
| location.</dd><dd><code>password</code> - - the ODF Package password.</dd><dd><code>errorHandler</code> - - SAX ErrorHandler used for ODF validation.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be created</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><code>getErrorHandler()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getBaseURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBaseURI</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBaseURI()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The URI to the ODF package, usually the URL, where this ODF |
| package is located. If the package has not URI NULL is returned. |
| This is the case if the package was new created without an URI |
| and not saved before.</dd></dl> |
| </li> |
| </ul> |
| <a name="loadDocument(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadDocument</h4> |
| <pre>public <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a> loadDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Returns on ODF documents based a given mediatype.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - path relative to the package root, where the document should |
| be inserted.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The ODF document, which mediatype dependends on the parameter or |
| NULL if media type were not supported.</dd></dl> |
| </li> |
| </ul> |
| <a name="getCachedDocument(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCachedDocument</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a> getCachedDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>This method is only added temporary as workaround for the IBM |
| fork using different DOC classes. Until the registering of |
| DOC documents to the PKG layer has been finished.</i></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - path relative to the package root, where the document should |
| be inserted.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an already open OdfPackageDocument via its path, otherwise NULL.</dd></dl> |
| </li> |
| </ul> |
| <a name="removeDocument(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDocument</h4> |
| <pre>public void removeDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Removes a document from the package via its path. Independent if it was |
| already opened or not.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - path relative to the package root, where the document should |
| be removed.</dd></dl> |
| </li> |
| </ul> |
| <a name="getRootDocument()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootDocument</h4> |
| <pre>public <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a> getRootDocument()</pre> |
| </li> |
| </ul> |
| <a name="getManifestDom()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManifestDom</h4> |
| <pre>public <a href="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfManifestDom.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfManifestDom</a> getManifestDom()</pre> |
| </li> |
| </ul> |
| <a name="getMediaTypeString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMediaTypeString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMediaTypeString(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Get the media type of the ODF file or document (ie. a directory). A |
| directory with a mediatype can be loaded as |
| <code>OdfPackageDocument</code>. Note: A directoy is represented by in |
| the package as directory with media type</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - within the package of the file or document.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the mediaType for the resource of the given path</dd></dl> |
| </li> |
| </ul> |
| <a name="getMediaTypeString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMediaTypeString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMediaTypeString()</pre> |
| <div class="block">Get the media type of the ODF package (equal to media type of ODF root |
| document)</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the mediaType string of this ODF package</dd></dl> |
| </li> |
| </ul> |
| <a name="getFileEntry(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFileEntry</h4> |
| <pre>public <a href="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfFileEntry.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfFileEntry</a> getFileEntry(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Get an OdfFileEntry for the internalPath NOTE: This method should be |
| better moved to a DOM inherited Manifest class</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - The relative package path within the ODF package</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The manifest file entry will be returned.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFilePaths()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilePaths</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFilePaths()</pre> |
| <div class="block">Get a OdfFileEntries from the manifest file (i.e. /META/manifest.xml")</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The paths of the manifest file entries will be returned.</dd></dl> |
| </li> |
| </ul> |
| <a name="contains(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contains</h4> |
| <pre>public boolean contains(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Check existence of a file in the package.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - The relative package documentURL within the ODF package</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>True if there is an entry and a file for the given documentURL</dd></dl> |
| </li> |
| </ul> |
| <a name="save(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>public void save(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> odfPath) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Save the package to given documentURL.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>odfPath</code> - - the path to the ODF package destination</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be saved</dd></dl> |
| </li> |
| </ul> |
| <a name="save(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>public void save(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pkgFile) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Save package to a given File. After saving it is still necessary to close |
| the package to have again full access about the file.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pkgFile</code> - - the File to save the ODF package to</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be saved</dd></dl> |
| </li> |
| </ul> |
| <a name="save(java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>public void save(<a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> odfStream) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="setPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPassword</h4> |
| <pre>public void setPassword(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</pre> |
| <div class="block">Sets the password of this package. if password is not null, package will |
| be encrypted when save.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - password</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.8.9</dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Close the OdfPackage after it is no longer needed. Even after saving it |
| is still necessary to close the package to have again full access about |
| the file. Closing the OdfPackage will release all temporary created data. |
| Do this as the last action to free resources. Closing an already closed |
| document has no effect.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="insert(org.w3c.dom.Document, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>public void insert(<a href="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a> fileDOM, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</pre> |
| <div class="block">Insert DOM tree into OdfPackage. An existing file will be replaced.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileDOM</code> - - XML DOM tree to be inserted as file.</dd><dd><code>internalPath</code> - - relative documentURL where the DOM tree should be inserted |
| as XML file</dd><dd><code>mediaType</code> - - media type of stream. Set to null if unknown</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when the DOM tree could not be inserted</dd></dl> |
| </li> |
| </ul> |
| <a name="insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insertDocument</h4> |
| <pre>public void insertDocument(<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a> sourceDocument, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Embed an OdfPackageDocument to the current OdfPackage. All the file |
| entries of child document will be inserted.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceDocument</code> - the OdfPackageDocument to be embedded.</dd><dd><code>internalPath</code> - path to the directory the ODF document should be inserted |
| (relative to ODF package root).</dd></dl> |
| </li> |
| </ul> |
| <a name="getDocumentPaths()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDocumentPaths</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getDocumentPaths()</pre> |
| <div class="block">Method returns the paths of all document within the package.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A set of paths of all documents of the package, including the |
| root document.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDocumentPaths(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDocumentPaths</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getDocumentPaths(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaTypeString)</pre> |
| <div class="block">Method returns the paths of all document within the package matching the |
| given criteria.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mediaTypeString</code> - limits the desired set of document paths to documents of the |
| given mediaType</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A set of paths of all documents of the package, including the |
| root document, that match the given parameter.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDom(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDom</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a> getDom(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/javax/xml/parsers/ParserConfigurationException.html?is-external=true" title="class or interface in javax.xml.parsers">ParserConfigurationException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerConfigurationException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Gets org.w3c.dom.Document for XML file contained in package.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - to a file within the Odf Package (eg. content.xml)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an org.w3c.dom.Document</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/javax/xml/parsers/ParserConfigurationException.html?is-external=true" title="class or interface in javax.xml.parsers">ParserConfigurationException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerConfigurationException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="insert(java.net.URI, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>public void insert(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> sourceURI, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Inserts an external file into an OdfPackage. An existing file will be |
| replaced.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceURI</code> - - the source URI to the file to be inserted into the package.</dd><dd><code>internalPath</code> - - relative documentURL where the tree should be inserted as |
| XML file</dd><dd><code>mediaType</code> - - media type of stream. Set to null if unknown</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - In case the file could not be saved</dd></dl> |
| </li> |
| </ul> |
| <a name="insert(java.io.InputStream, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>public void insert(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> fileStream, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Inserts InputStream into an OdfPackage. An existing file will be |
| replaced.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileStream</code> - - the stream of the file to be inserted into the ODF package.</dd><dd><code>internalPath</code> - - relative documentURL where the tree should be inserted as |
| XML file</dd><dd><code>mediaType</code> - - media type of stream. Set to null if unknown</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="insert(byte[], java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>public void insert(byte[] fileBytes, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaTypeString)</pre> |
| <div class="block">Inserts a byte array into OdfPackage. An existing file will be replaced. |
| If the byte array is NULL a directory with the given mimetype will be |
| created.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileBytes</code> - - data of the file stream to be stored in package. If NULL a |
| directory with the given mimetype will be created.</dd><dd><code>internalPath</code> - - path of the file or directory relative to the package root.</dd><dd><code>mediaTypeString</code> - - media type of stream. If unknown null can be used.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBytes(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre>public byte[] getBytes(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Get package (sub-) content as byte array</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - relative documentURL to the package content</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the unzipped package content as byte array</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getInputStream(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> getInputStream(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Get the latest version of package content as InputStream, as it would be |
| saved. This might not be the original version once loaded from the |
| package.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - of the desired stream.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Inputstream of the ODF file within the package for the given |
| path.</dd></dl> |
| </li> |
| </ul> |
| <a name="getInputStream(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> getInputStream(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| boolean useOriginal)</pre> |
| <div class="block">Get the latest version of package content as InputStream, as it would be |
| saved. This might not be the original version once loaded from the |
| package.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - of the desired stream.</dd><dd><code>useOriginal</code> - true uses the stream as loaded from the ZIP. False will return |
| even modified file content as a stream.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Inputstream of the ODF file within the package for the given |
| path.</dd></dl> |
| </li> |
| </ul> |
| <a name="getInputStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> getInputStream() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Gets the InputStream containing whole OdfPackage.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the ODF package as input stream</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the package could not be read</dd></dl> |
| </li> |
| </ul> |
| <a name="insertOutputStream(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insertOutputStream</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> insertOutputStream(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Insert the OutputStream for into OdfPackage. An existing file will be |
| replaced.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - - relative documentURL where the DOM tree should be inserted |
| as XML file</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>outputstream for the data of the file to be stored in package</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when the DOM tree could not be inserted</dd></dl> |
| </li> |
| </ul> |
| <a name="insertOutputStream(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insertOutputStream</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> insertOutputStream(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Insert the OutputStream - to be filled after method - when stream is |
| closed into OdfPackage. An existing file will be replaced.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - - relative documentURL where the DOM tree should be inserted |
| as XML file</dd><dd><code>mediaType</code> - - media type of stream</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>outputstream for the data of the file to be stored in package</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when the DOM tree could not be inserted</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>public void remove(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Removes a single file from the package.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - of the file relative to the package root</dd></dl> |
| </li> |
| </ul> |
| <a name="getEntityResolver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityResolver</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</a> getEntityResolver()</pre> |
| <div class="block">Get EntityResolver to be used in XML Parsers which can resolve content |
| inside the OdfPackage</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a SAX EntityResolver</dd></dl> |
| </li> |
| </ul> |
| <a name="getURIResolver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURIResolver</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</a> getURIResolver()</pre> |
| <div class="block">Get URIResolver to be used in XSL Transformations which can resolve |
| content inside the OdfPackage</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a TraX Resolver</dd></dl> |
| </li> |
| </ul> |
| <a name="isExternalReference(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExternalReference</h4> |
| <pre>public static boolean isExternalReference(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> internalPath)</pre> |
| <div class="block">Checks if the given reference is a reference, which points outside the |
| ODF package</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>internalPath</code> - the file reference to be checked</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the reference is an package external reference</dd></dl> |
| </li> |
| </ul> |
| <a name="setErrorHandler(org.xml.sax.ErrorHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setErrorHandler</h4> |
| <pre>public void setErrorHandler(<a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> handler)</pre> |
| <div class="block">Allow an application to register an error event handler. |
| <p> |
| If the application does not register an error handler, all error events |
| reported by the ODFDOM (e.g. the SAX Parser) will be silently ignored; |
| however, normal processing may not continue. It is highly recommended |
| that all ODF applications implement an error handler to avoid unexpected |
| bugs. |
| </p> |
| <p> |
| Applications may register a new or different handler in the middle of a |
| parse, and the ODFDOM will begin using the new handler immediately. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - The error handler.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><code>getErrorHandler()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getErrorHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getErrorHandler</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</a> getErrorHandler()</pre> |
| <div class="block">Return the current error handler used for ODF validation.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The current error handler, or null if none has been registered |
| and validation is disabled.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#setErrorHandler(org.xml.sax.ErrorHandler)"><code>setErrorHandler(org.xml.sax.ErrorHandler)</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OdfPackage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/odftoolkit/odfdom/pkg/OdfNamespace.html" title="class in org.odftoolkit.odfdom.pkg"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/odfdom/pkg/OdfPackage.html" target="_top">Frames</a></li> |
| <li><a href="OdfPackage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
