org.openxml.dom

Class EntityImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.EntityImpl

All Implemented Interfaces:

Cloneable, Entity, Node

public class EntityImpl
extends NodeImpl
implements Entity

Implements an entity.

Notes:

1. Node type is Node.ENTITY_NODE
2. Node supports childern
3. Node does not have a value
4. Node only accessible from DocumentType

Author:

Assaf Arkin

See Also:

Entity, NodeImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_notation The notation of this entity, if specified.
protected String	_publicID The public identifier of this entity, if specified.
protected String	_systemID The system identifier of this entity, if specified.
static short	STATE_DECLARED Entity has been declared but not parsed.
static short	STATE_NOT_FOUND Entity not found.
static short	STATE_PARSED Entity has been parsed.
static short	STATE_PARSING Entity is being parsed.

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
EntityImpl(String name, String internalValue) Constructs an internal general entity.
EntityImpl(String name, String systemID, String publicID) Constructs an external general entity.
EntityImpl(String name, String systemID, String publicID, String notation) Constructs an unparsed general entity.

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)
boolean	equals(Object other) Returns true if this node and other are identical by content but not context.
String	getBaseURI()
String	getEncoding() DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.
Object	getFeature(String feature, String version)
String	getInputEncoding()
String	getInternal()
short	getNodeType() Abstract method must be implemented by each node class.
String	getNotationName()
String	getPublicId()
short	getState() Returns the parsing state of this entity.
String	getSystemId()
String	getTextContent()
Object	getUserData(String key)
String	getVersion() DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.
String	getXmlEncoding()
String	getXmlVersion()
boolean	hasAttributes()
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isInternal() Returns true if entity is an internal general entity.
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
boolean	isUnparsed() Returns true if entity is an unparsed general entity.
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	setEncoding(String value) DOM Level 3 WD - experimental encoding - An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.
void	setNodeValue(String value) Changes the value of the node.
void	setState(short newState) Changes the parsing state of this entity.
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
void	setVersion(String value) DOM Level 3 WD - experimental version - An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.
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, 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, setPrefix

Field Detail

_notation

protected String _notation

The notation of this entity, if specified.

_systemID

protected String _systemID

The system identifier of this entity, if specified.

_publicID

protected String _publicID

The public identifier of this entity, if specified.

STATE_DECLARED

public static final short STATE_DECLARED

Entity has been declared but not parsed. This is the initial state for an entity after it has been declared in the DTD but before it is used in the document contents.

See Also:

Constant Field Values

STATE_PARSING

public static final short STATE_PARSING

Entity is being parsed. This state designates that the entity is being parsed right now. State is used to identify circular references.

See Also:

Constant Field Values

STATE_PARSED

public static final short STATE_PARSED

Entity has been parsed. This state indicates that entity has been parsed and it's parsed contents is contained in its child nodes.

See Also:

Constant Field Values

STATE_NOT_FOUND

public static final short STATE_NOT_FOUND

Entity not found. The entity could not be parsed before.

See Also:

Constant Field Values

Constructor Detail

EntityImpl

public EntityImpl(String name,
                  String systemID,
                  String publicID,
                  String notation)

Constructs an unparsed general entity. Entity system identifier and notation name must be provided, public identifier is optional.

Parameters:

name - The entity name

systemID - The system identifier

publicID - The public identifier, if specified

notation - The notation, if specified

EntityImpl

public EntityImpl(String name,
                  String systemID,
                  String publicID)

Constructs an external general entity. Entity system identifier must be provided, public identifier is optional.

Parameters:

name - The entity name

systemID - The system identifier

publicID - The public identifier, if specified

EntityImpl

public EntityImpl(String name,
                  String internalValue)

Constructs an internal general entity. Entity value must be provided.

Parameters:

name - The entity name

internalValue - The unparsed entity value

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()

setNodeValue

public final void setNodeValue(String value)

Description copied from class: NodeImpl

Changes the value of the node. Not all node types support the notion of a value. If the value is not supported by a particular node type, it will throw an exception when calling this method. The following table specifies which node types support values:

 Element                Not supported
 Attr                   Supported
 Text                   Supported
 CDATASection           Supported
 EntityReference        Not supported
 Entity                 Not supported
 ProcessingInstruction  Supported
 Comment                Supported
 Document               Not supported
 DocumentType           Not supported
 DocumentFragment       Not supported
 Notation               Not supported
 

For most node types, if the value is set to null, NodeImpl.getNodeValue() will return an empty string instead.

Specified by:

setNodeValue in interface Node

Overrides:

setNodeValue in class NodeImpl

Parameters:

value - New value of node

getPublicId

public String getPublicId()

Specified by:

getPublicId in interface Entity

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface Entity

getNotationName

public String getNotationName()

Specified by:

getNotationName in interface Entity

getInternal

public final String getInternal()

getEncoding

public String getEncoding()

DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.

getVersion

public String getVersion()

DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.

setVersion

public void setVersion(String value)

DOM Level 3 WD - experimental version - An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. This is null otherwise

setEncoding

public void setEncoding(String value)

DOM Level 3 WD - experimental encoding - An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This is null otherwise

isUnparsed

public boolean isUnparsed()

Returns true if entity is an unparsed general entity. An unparsed entity is one for which a notation has been specified.

Returns:

True if unparsed general entity

isInternal

public boolean isInternal()

Returns true if entity is an internal general entity. An internal entity is one for which a value has been defined. An external entity is one for which an external entity has been assigned through either system or public identifiers.

If true is returned, then getInternal() will return a string (might be empty).

Returns:

True if internal general entity

getState

public short getState()

Returns the parsing state of this entity.

Returns:

State of entity

setState

public void setState(short newState)

Changes the parsing state of this entity. Note that only some changes are allowed: from declared to parsing, parsed or not found; from parsing to parsed or not found; from not found to declared.

Parameters:

newState - New state of entity

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 final Object clone()

Overrides:

clone in class Object

cloneNode

public final 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

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Entity

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Entity

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Entity

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