org.openxml.dom

Class DocumentTypeImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.DocumentTypeImpl

All Implemented Interfaces:

Cloneable, DocumentType, Node

public class DocumentTypeImpl
extends NodeImpl
implements DocumentType

Each document Document.getDoctype() attribute whose value is either null or an object that represents the document type definition (DTD). HTML documents do not have a DTD. At the moment, this object provides the list of entities that are defined for the document and little else. Access is provided through NamedNodeMap collections.

Notes:

1. Node type is Node.DOCUMENT_TYPE_NODE
2. Does not support childern
3. Node does not have a value
4. Node does not have parents or siblings and is only accessible from Document

Author:

Assaf Arkin

See Also:

DocumentType, NodeImpl, NamedNodeMap

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_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 and Description
DocumentTypeImpl(String qualifiedName, String systemId, String publicId, String internalSubset)

Method Summary

Modifier and Type	Method and Description
Object	clone()
protected void	cloneInto(NodeImpl into, boolean deep) This clone method is called after a new node has been constructed to copy the contents of this node into the new one.
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
EntityImpl	createEntity(String name, String value) Creates a new internal entity declaration and returns it.
EntityImpl	createEntity(String name, String systemId, String publicId) Creates a new external general entity declaration and returns it.
EntityImpl	createEntity(String name, String systemId, String publicId, String notation) Creates a new unparsed general entity declaration and returns it.
Notation	createNotation(String name, String systemId, String publicId) Creates a new notation and returns it.
EntityImpl	declareEntity(EntityImpl general) Declares a new general entity declaration.
Notation	declareNotation(Notation notation) Declares a new notation.
boolean	equals(Object other) Returns true if this node and other are identical by content but not context.
EntityImpl	findEntity(String name) Returns the named general entity declaration if one has been declared.
Notation	findNotation(String name) Returns the named notation if one has been declared.
String	getBaseURI()
NamedNodeMap	getEntities()
Object	getFeature(String feature, String version)
String	getInternalSubset()
String	getName()
short	getNodeType() Abstract method must be implemented by each node class.
NamedNodeMap	getNotations()
String	getPublicId()
String	getSystemId()
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttributes()
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
String	toString()

Methods inherited from class org.openxml.dom.NodeImpl

appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, isReadOnly, makeReadOnly, normalize, removeChild, replaceChild, setNodeValue, setOwnerDocument, setPrefix, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Constructor Detail

DocumentTypeImpl

public DocumentTypeImpl(String qualifiedName,
                        String systemId,
                        String publicId,
                        String internalSubset)

Method Detail

getNodeType

public short getNodeType()

Description copied from class: NodeImpl

Abstract method must be implemented by each node class.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class NodeImpl

See Also:

Node.getNodeType()

getName

public String getName()

Specified by:

getName in interface DocumentType

getEntities

public NamedNodeMap getEntities()

Specified by:

getEntities in interface DocumentType

getNotations

public NamedNodeMap getNotations()

Specified by:

getNotations in interface DocumentType

getPublicId

public String getPublicId()

Specified by:

getPublicId in interface DocumentType

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface DocumentType

getInternalSubset

public String getInternalSubset()

Specified by:

getInternalSubset in interface DocumentType

createEntity

public EntityImpl createEntity(String name,
                               String systemId,
                               String publicId)

Creates a new external general entity declaration and returns it.

Parameters:

name - The notation name

systemId - The system identifier

publicId - The public identifier

Returns:

Returns a new entity node

createEntity

public EntityImpl createEntity(String name,
                               String systemId,
                               String publicId,
                               String notation)

Creates a new unparsed general entity declaration and returns it.

Parameters:

name - The notation name

systemId - The system identifier

publicId - The public identifier

notation - The notation

Returns:

Returns a new entity node

createEntity

public EntityImpl createEntity(String name,
                               String value)

Creates a new internal entity declaration and returns it. The entity value is given after parameter entity and character reference substitution.

Parameters:

name - The notation name

value - The entity value

Returns:

Returns a new entity node

declareEntity

public EntityImpl declareEntity(EntityImpl general)

Declares a new general entity declaration. If a general entity with the same name is already declared, it remains intact and the existing entity is returned. If no such entity exists, the entity is declared and returned.

Parameters:

general - The general entity to declare

Returns:

The declared entity

findEntity

public EntityImpl findEntity(String name)

Returns the named general entity declaration if one has been declared.

Parameters:

name - The entity name

Returns:

The named general entity

createNotation

public Notation createNotation(String name,
                               String systemId,
                               String publicId)

Creates a new notation and returns it. Notation must have either or both system and public identifiers.

Parameters:

name - The notation name

systemId - The system identifier

publicId - The public identifier

Returns:

Returns a new notation node

declareNotation

public Notation declareNotation(Notation notation)

Declares a new notation. If a notation with the same name is already declared, it remains intact and the existing notation is returned. If no such notation exists, the notation is declared and returned.

Parameters:

notation - The notation to declare

Returns:

The declared notation

findNotation

public Notation findNotation(String name)

Returns the named notation if one has been declared.

Parameters:

name - The notation name

Returns:

The named notation

equals

public boolean equals(Object other)

Description copied from class: NodeImpl

Returns true if this node and other are identical by content but not context. Test by content but not context adheres to the following:

• Both nodes must be of the same type, must have the same name and value (case sensitive) and for elements, the same tag name
• For elements, both must have identical attribute list, although attributes may be specified/unspecified and in different orders
• Both nodes must have no children, or must have the exact same sequence of children; children are tested for equality by calling NodeImpl.equals(java.lang.Object) on each pair
• However, both nodes may reside in different documents, belong to different parents, have different siblings, different read-only flags, etc.

It is guaranteed that the act of cloning a node will return a second node that will pass the test of equality.

Note that for large document roots, the equality operation can be very expensive.

Overrides:

equals in class NodeImpl

Parameters:

other - The other node to test for equality

Returns:

True if both nodes are equal based on their content but not their context

clone

public Object clone()

Overrides:

clone in class Object

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

toString

public String toString()

Overrides:

toString in class Object

cloneInto

protected void cloneInto(NodeImpl into,
                         boolean deep)

Description copied from class: NodeImpl

This clone method is called after a new node has been constructed to copy the contents of this node into the new one. It clones in contents but not in context, and guarantees that the cloned node will pass the equality test (see NodeImpl.equals(java.lang.Object)).

into must be a valid node of the exact same class as this one. deep is true if deep cloning (includes all children nodes) is to be performed. If deep is false, the clone might not pass the equality test.

Derived classes override and call this method to add per-class variable copying. This method is called by Node.cloneNode(boolean) and the default Object.clone() method.

Contents cloning duplicates the node's name and value, and its children. It does not duplicate it's context, that is, the node's parent or sibling. Initially a clone node has no parents or siblings. However, the node does belong to the same document, since all nodes must belong to some document. The cloned node is never read-only.

Overrides:

cloneInto in class NodeImpl

Parameters:

into - A node into which to duplicate this one

deep - True if deep cloning is required

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node