org.odftoolkit.odfdom.doc
Class OdfImageDocument

java.lang.Object
  extended by org.odftoolkit.odfdom.pkg.OdfPackageDocument
      extended by org.odftoolkit.odfdom.dom.OdfSchemaDocument
          extended by org.odftoolkit.odfdom.doc.OdfDocument
              extended by org.odftoolkit.odfdom.doc.OdfImageDocument
All Implemented Interfaces:
Closeable

public class OdfImageDocument
extends OdfDocument

This class represents an ODF image document.


Nested Class Summary
static class OdfImageDocument.OdfMediaType
          This enum contains all possible media types of OdfImageDocument documents.
 
Nested classes/interfaces inherited from class org.odftoolkit.odfdom.doc.OdfDocument
OdfDocument.UnicodeGroup
 
Nested classes/interfaces inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument
OdfSchemaDocument.OdfXMLFile
 
Nested classes/interfaces inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument
OdfPackageDocument.Resource
 
Field Summary
 
Fields inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument
mContentDom, mDocumentStyles, mMetaDom, mSettingsDom, mStylesDom
 
Fields inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument
mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH
 
Constructor Summary
protected OdfImageDocument(OdfPackage pkg, String internalPath, OdfImageDocument.OdfMediaType odfMediaType)
          To avoid data duplication a new document is only created, if not already opened.
 
Method Summary
 void changeMode(OdfImageDocument.OdfMediaType mediaType)
          Changes the document to the given mediatype.
 OfficeImageElement getContentRoot()
          Get the content root of a image document.
static OdfImageDocument loadDocument(File file)
          Creates an OdfImageDocument from the OpenDocument provided by a File.
static OdfImageDocument loadDocument(InputStream inputStream)
          Creates an OdfImageDocument from the OpenDocument provided by a resource Stream.
static OdfImageDocument loadDocument(String documentPath)
          Loads an OdfImageDocument from the provided path.
static OdfImageDocument newImageDocument()
          Creates an empty image document.
static OdfImageDocument newImageTemplateDocument()
          Creates an empty image template.
 
Methods inherited from class org.odftoolkit.odfdom.doc.OdfDocument
close, getLocale, getOdfMediaType, getOfficeMetadata, getTableByName, getTableList, getUnicodeGroup, loadDocument, loadDocument, loadSubDocument, loadSubDocuments, loadSubDocuments, loadTemplate, newImage, save, save, setLocale, setOdfMediaType, toString
 
Methods inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument
getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOrCreateDocumentStyles, getRDFMetadata, getSettingsDom, getSettingsStream, getStylesDom, getStylesStream, getTables, getXMLFilePath
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument
flushDoms, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, insertDocument, isExternalReference, isRootDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OdfImageDocument

protected OdfImageDocument(OdfPackage pkg,
                           String internalPath,
                           OdfImageDocument.OdfMediaType odfMediaType)
                    throws SAXException
To avoid data duplication a new document is only created, if not already opened. A document is cached by this constructor using the internalpath as key.

Throws:
SAXException
Method Detail

newImageDocument

public static OdfImageDocument newImageDocument()
                                         throws Exception
Creates an empty image document.

Returns:
ODF image document based on a default template
Throws:
Exception - - if the document could not be created

newImageTemplateDocument

public static OdfImageDocument newImageTemplateDocument()
                                                 throws Exception
Creates an empty image template.

Returns:
ODF image template based on a default
Throws:
Exception - - if the template could not be created

loadDocument

public static OdfImageDocument loadDocument(InputStream inputStream)
                                     throws Exception
Creates an OdfImageDocument from the OpenDocument provided by a resource Stream.

Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by OdfImageDocument, the InputStream is cached. This usually takes more time compared to the other createInternalDocument methods. An advantage of caching is that there are no problems overwriting an input file.

If the resource stream is not a ODF image document, ClassCastException might be thrown.

Parameters:
inputStream - - the InputStream of the ODF image document.
Returns:
the image document created from the given InputStream
Throws:
Exception - - if the document could not be created.

loadDocument

public static OdfImageDocument loadDocument(String documentPath)
                                     throws Exception
Loads an OdfImageDocument from the provided path.

OdfImageDocument relies on the file being available for read access over the whole lifecycle of OdfImageDocument.

If the resource stream is not a ODF image document, ClassCastException might be thrown.

Parameters:
documentPath - - the path from where the document can be loaded
Returns:
the image document from the given path or NULL if the media type is not supported by ODFDOM.
Throws:
Exception - - if the document could not be created.

loadDocument

public static OdfImageDocument loadDocument(File file)
                                     throws Exception
Creates an OdfImageDocument from the OpenDocument provided by a File.

OdfImageDocument relies on the file being available for read access over the whole lifecycle of OdfImageDocument.

If the resource stream is not a ODF image document, ClassCastException might be thrown.

Parameters:
file - - a file representing the ODF image document.
Returns:
the image document created from the given File
Throws:
Exception - - if the document could not be created.

getContentRoot

public OfficeImageElement getContentRoot()
                                  throws Exception
Get the content root of a image document.

Overrides:
getContentRoot in class OdfDocument
Returns:
content root, representing the office:drawing tag
Throws:
Exception - if the file DOM could not be created.

changeMode

public void changeMode(OdfImageDocument.OdfMediaType mediaType)
Changes the document to the given mediatype. This method can only be used to convert a document to a related mediatype, e.g. template.

Parameters:
mediaType - the related ODF mimetype


Copyright © 2008-2017 The Apache Software Foundation. All Rights Reserved.