Class OdfChartDocument
- All Implemented Interfaces:
Closeable
,AutoCloseable
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
This enum contains all possible media types of OdfChartDocument 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.doc.OdfDocument
mHasCollaboration
Fields inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument
mContentDom, mJsonOperationQueue, mMetaDom, mSettingsDom, mStylesDom
Fields inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument
mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH
-
Constructor Summary
ModifierConstructorDescriptionprotected
OdfChartDocument
(OdfPackage pkg, String internalPath, OdfChartDocument.OdfMediaType odfMediaType) To avoid data duplication a new document is only created, if not already opened. -
Method Summary
Modifier and TypeMethodDescriptionvoid
changeMode
(OdfChartDocument.OdfMediaType mediaType) Changes the document to the given mediatype.Get the content root of a chart document.static OdfChartDocument
loadDocument
(File file) Creates an OdfChartDocument from the OpenDocument provided by a File.static OdfChartDocument
loadDocument
(InputStream inputStream) Creates an OdfChartDocument from the OpenDocument provided by a resource Stream.static OdfChartDocument
loadDocument
(String documentPath) Loads an OdfChartDocument from the provided path.static OdfChartDocument
Creates an empty charts document. *
Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.static OdfChartDocument
Creates an empty charts template. *
Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.Methods inherited from class org.odftoolkit.odfdom.doc.OdfDocument
addAnnotation, close, getAnnotation, getFontNames, getLocale, getOdfMediaType, getOfficeMetadata, getSelectionManager, getTableByName, getTableList, getTableList, getUnicodeGroup, getUniqueAnnotationName, hasCollaboration, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadSubDocument, loadSubDocuments, loadSubDocuments, loadTemplate, loadTemplate, newImage, removeAnnotation, removeCachedView, save, save, setLocale, setOdfMediaType, toString, updateMetaData
Methods inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument
getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getJsonOperationQueue, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOperations, getOrCreateDocumentStyles, getRDFMetadata, getRootComponent, getRootComponentElement, getSettingsDom, getSettingsStream, getStyleByDisplayName, getStyleByName, getStylesDom, getStylesStream, getTables, getTables, getXMLFilePath, setContentDom, setJsonOperationQueue, setMetaDom, setRootComponent, setSettingsDom, setStylesDom
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument
flushDoms, getAbsoluteFilePath, getCachedDom, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, insertDocument, isExternalReference, isRootDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString
-
Constructor Details
-
OdfChartDocument
protected OdfChartDocument(OdfPackage pkg, String internalPath, OdfChartDocument.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 Details
-
newChartDocument
Creates an empty charts document. *
Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.- Returns:
- ODF charts document based on a default template
- Throws:
Exception
- - if the document could not be created
-
newChartTemplateDocument
Creates an empty charts template. *
Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.- Returns:
- ODF charts template based on a default template
- Throws:
Exception
- - if the template could not be created
-
loadDocument
Creates an OdfChartDocument from the OpenDocument provided by a resource Stream.Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by OdfChartDocument, 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 chart document, ClassCastException might be thrown.
- Parameters:
inputStream
- - the InputStream of the ODF chart document.- Returns:
- the chart document created from the given InputStream
- Throws:
Exception
- - if the document could not be created.
-
loadDocument
Loads an OdfChartDocument from the provided path.OdfChartDocument relies on the file being available for read access over the whole lifecycle of OdfChartDocument.
If the resource stream is not a ODF chart document, ClassCastException might be thrown.
- Parameters:
documentPath
- - the path from where the document can be loaded- Returns:
- the chart 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
Creates an OdfChartDocument from the OpenDocument provided by a File.OdfChartDocument relies on the file being available for read access over the whole lifecycle of OdfChartDocument.
If the resource stream is not a ODF chart document, ClassCastException might be thrown.
- Parameters:
file
- - a file representing the ODF chart document.- Returns:
- the chart document created from the given File
- Throws:
Exception
- - if the document could not be created.
-
getContentRoot
Get the content root of a chart document.- Overrides:
getContentRoot
in classOdfDocument
- Returns:
- content root, representing the office:chart tag
- Throws:
Exception
- if the file DOM could not be created.
-
changeMode
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
-