Package org.odftoolkit.odfdom.dom

Class OdfSettingsDom

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.CoreDocumentImpl

org.apache.xerces.dom.DocumentImpl

org.odftoolkit.odfdom.pkg.OdfFileDom

org.odftoolkit.odfdom.dom.OdfSettingsDom

All Implemented Interfaces:

Serializable, Cloneable, NamespaceContext, Document, DocumentEvent, EventTarget, Node, NodeList, DocumentRange, DocumentTraversal

public class OdfSettingsDom
extends OdfFileDom

The DOM representation of the ODF Settings.xml file of an ODF document.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odftoolkit.odfdom.pkg.OdfFileDom

inCententMetadataCache, mDuplicatePrefixesByUri, mPackage, mPackageDocument, mPackagePath, mPrefixByUri, mUriByPrefix, mXPath, sink

Fields inherited from class org.apache.xerces.dom.DocumentImpl

eventListeners, iteratorReferenceQueue, iterators, mutationEvents, rangeReferenceQueue, ranges

Fields inherited from class org.apache.xerces.dom.CoreDocumentImpl

actualEncoding, allowGrammarAccess, changes, docElement, docType, encoding, errorChecking, fDocumentURI, identifiers, standalone, userData, version, xmlVersionChanged

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor	Description
OdfSettingsDom(OdfSchemaDocument odfDocument, String packagePath)	Creates the DOM representation of an XML file of an Odf document.

Method Summary

Modifier and Type	Method	Description
OdfSchemaDocument	getDocument()	Retrieves the Odf Document
OfficeDocumentSettingsElement	getRootElement()	Retrieves the ODF root element.
XPath	getXPath()	Creates an JDK XPath instance.
protected void	initialize()	Might be used to initialize specific XML Namespace prefixes/URIs for this XML file

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfFileDom

createAttribute, createAttributeNS, createAttributeNS, createElement, createElementNS, createElementNS, getBookmarkRDFMetadata, getInContentMetadataCache, getNamespaceURI, getNextMarkupId, getPackagePath, getPrefix, getPrefixes, getSink, initialize, newFileDom, newOdfElement, setNamespace, setNamespace, toString, updateInContentMetadataCache

Methods inherited from class org.apache.xerces.dom.DocumentImpl

addEventListener, cloneNode, copyEventListeners, createEvent, createNodeIterator, createNodeIterator, createRange, createTreeWalker, createTreeWalker, dispatchAggregateEvents, dispatchAggregateEvents, dispatchEvent, dispatchEventToSubtree, dispatchingEventToSubtree, getEventListeners, getImplementation, removeEventListener, saveEnclosingAttr, setEventListeners

Methods inherited from class org.apache.xerces.dom.CoreDocumentImpl

abort, adoptNode, callUserDataHandlers, canRenameElements, changed, changes, checkDOMNSErr, checkNamespaceWF, checkQName, clearIdentifiers, clone, cloneNode, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createDocumentType, createElementDefinition, createElementNS, createEntity, createEntityReference, createNotation, createProcessingInstruction, createTextNode, getAsync, getBaseURI, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getEncoding, getErrorChecking, getFeature, getIdentifier, getIdentifiers, getInputEncoding, getNodeName, getNodeNumber, getNodeNumber, getNodeType, getOwnerDocument, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getUserData, getUserDataRecord, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, insertBefore, isKidOK, isValidQName, isXMLName, load, loadXML, normalizeDocument, putIdentifier, removeChild, removeIdentifier, renameNode, replaceChild, saveXML, setAsync, setDocumentURI, setEncoding, setErrorChecking, setInputEncoding, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setUserData, setVersion, setXmlEncoding, setXmlStandalone, setXmlVersion, undeferChildren

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setOwnerDocument, setReadOnly, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getContainer, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, setPrefix, setUserData

Constructor Detail

OdfSettingsDom

public OdfSettingsDom(OdfSchemaDocument odfDocument,
                      String packagePath)

Creates the DOM representation of an XML file of an Odf document.

Parameters:

odfDocument - the document the XML files belongs to

packagePath - the internal package path to the XML file

Method Detail

initialize

protected void initialize()

Might be used to initialize specific XML Namespace prefixes/URIs for this XML file

Overrides:

initialize in class OdfFileDom

getDocument

public OdfSchemaDocument getDocument()

Retrieves the Odf Document

Overrides:

getDocument in class OdfFileDom

Returns:

The OdfDocument

getRootElement

public OfficeDocumentSettingsElement getRootElement()

Description copied from class: OdfFileDom

Retrieves the ODF root element.

Overrides:

getRootElement in class OdfFileDom

Returns:

The root element of the settings.xml file as OfficeDocumentSettingsElement.

getXPath

public XPath getXPath()

Creates an JDK XPath instance. Initialized with ODF namespaces from OdfDocumentNamespace. Updated with all namespace of the XML file.

Overrides:

getXPath in class OdfFileDom

Returns:

an XPath instance with namespace context set to include the standard ODFDOM prefixes.