Class PMRNodeImpl
java.lang.Object
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRNodeImpl
- All Implemented Interfaces:
Node
- Direct Known Subclasses:
PMRCharacterDataImpl, PMRDocumentFragmentImpl, PMRDocumentImpl, PMRDocumentTypeImpl, PMRDOMImplementationImpl, PMRElementImpl, PMREntityReferenceImpl, PMRProcessingInstructionImpl
-
Field Summary
FieldsFields inherited from interface 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
ConstructorsModifierConstructorDescriptionprotectedcalled by PMRDocumentImpl; should not be used otherwisePMRNodeImpl(PMRNodeImpl node, PMRDocument pmrDocument) PMRNodeImpl(Node node, PMRDocument pmrDocument) -
Method Summary
Modifier and TypeMethodDescriptionappendChild(Node newChild) Adds the nodenewChildto the end of the list of children of this node.cloneNode(boolean deep) Returns a duplicate of this node, that is , serves as a generic copy constructor for nodes.shortcompareDocumentPosition(Node other) Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.ANamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.The absolute base URI of this node ornullif the implementation wasn't able to obtain an absolute URI.ANodeListthat contains all children of this node.getFeature(String feature, String version) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .The first child of this node.The last child of this node.The node immediately following this node.The name of this node, depending on its type; see the table above.shortA code representing the type of the underlying object, as defined above.The value of this node, depending on its type; see the table above.TheDocumentobject associated with this node.The parent of this node.The node immediately preceding this node.This attribute returns the text content of this node and its descendants.getUserData(String key) Retrieves the object associated to a key on a this node.booleanReturns whether this node (if it is an element) has any attributes.booleanThis is a convenience method to allow easy determination of whether a node has any children.insertBefore(Node newChild, Node refChild) Inserts the nodenewChildbefore the existing child noderefChild.booleanisDefaultNamespace(String namespaceURI) This method checks if the specifiednamespaceURIis the default namespace or not.booleanisEqualNode(Node arg) Tests whether two nodes are equal.booleanisSameNode(Node other) Returns whether this node is the same node as the given one.booleanisSupported(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.lookupNamespaceURI(String pre) Look up the namespace URI associated to the given prefix, starting from this node.lookupPrefix(String nsUri) Look up the prefix associated to the given namespace URI, starting from this node.voidremoveChild(Node oldChild) Removes the child node indicated byoldChildfrom the list of children, and returns it.replaceChild(Node newChild, Node oldChild) Replaces the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode.protected voidsetDelegateNode(Node delegateNode) for use by subclasses to remove delegateNode hierarchyvoidsetNodeValue(String nodeValue) protected voidfor use by subclasses to remove PMRDocument hierarchyprotected voidvoidvoidsetTextContent(String textContent) This attribute returns the text content of this node and its descendants.setUserData(String key, Object data, UserDataHandler handler) Associate an object to a key on this node.toString()//////////////////////////////////////////////////////////protected voidwrapRecursively(Node delegateNode)
-
Field Details
-
delegateNode
-
pmrDocument
-
parentNode
-
childNodes
-
siblingNodes
-
-
Constructor Details
-
PMRNodeImpl
protected PMRNodeImpl()called by PMRDocumentImpl; should not be used otherwise -
PMRNodeImpl
-
PMRNodeImpl
-
-
Method Details
-
getNodeName
The name of this node, depending on its type; see the table above.- Specified by:
getNodeNamein interfaceNode
-
getNodeValue
The value of this node, depending on its type; see the table above.- Specified by:
getNodeValuein interfaceNode- Throws:
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMStringvariable on the implementation platform.
-
setNodeValue
- Specified by:
setNodeValuein interfaceNode- Throws:
DOMException
-
getNodeType
public short getNodeType()A code representing the type of the underlying object, as defined above.- Specified by:
getNodeTypein interfaceNode
-
getParentNode
The parent of this node. All nodes, exceptDocument,DocumentFragment, andAttrmay have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this isnull.- Specified by:
getParentNodein interfaceNode
-
getChildNodes
ANodeListthat contains all children of this node. If there are no children, this is aNodeListcontaining no nodes. The content of the returnedNodeListis "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by theNodeListaccessors; it is not a static snapshot of the content of the node. This is true for everyNodeList, including the ones returned by thegetElementsByTagNamemethod.- Specified by:
getChildNodesin interfaceNode
-
getFirstChild
The first child of this node. If there is no such node, this returnsnull.- Specified by:
getFirstChildin interfaceNode
-
getLastChild
The last child of this node. If there is no such node, this returnsnull.- Specified by:
getLastChildin interfaceNode
-
getPreviousSibling
The node immediately preceding this node. If there is no such node, this returnsnull.- Specified by:
getPreviousSiblingin interfaceNode
-
getNextSibling
The node immediately following this node. If there is no such node, this returnsnull.- Specified by:
getNextSiblingin interfaceNode
-
getAttributes
ANamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.- Specified by:
getAttributesin interfaceNode
-
getOwnerDocument
TheDocumentobject associated with this node. This is also theDocumentobject used to create new nodes. When this node is aDocumentthis isnull.- Specified by:
getOwnerDocumentin interfaceNode
-
insertBefore
Inserts the nodenewChildbefore the existing child noderefChild. IfrefChildisnull, insertnewChildat the end of the list of children.
IfnewChildis aDocumentFragmentobject, all of its children are inserted, in the same order, beforerefChild. If thenewChildis already in the tree, it is first removed.- Specified by:
insertBeforein interfaceNode- Parameters:
newChild- The node to insert.refChild- The reference node, that is , the node before which the new node must be inserted.- Returns:
- The node being inserted.
- Throws:
DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChildnode, or if the node to insert is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChildwas created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifrefChildis not a child of this node.
-
replaceChild
Replaces the child nodeoldChildwithnewChildin the list of children, and returns theoldChildnode. If thenewChildis already in the tree, it is first removed.- Specified by:
replaceChildin interfaceNode- Parameters:
newChild- The new node to put in the child list.oldChild- The node being replaced in the list.- Returns:
- The node replaced.
- Throws:
DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChildnode, or it the node to put in is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChildwas created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChildis not a child of this node.
-
removeChild
Removes the child node indicated byoldChildfrom the list of children, and returns it.- Specified by:
removeChildin interfaceNode- Parameters:
oldChild- The node being removed.- Returns:
- The node removed.
- Throws:
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChildis not a child of this node.
-
appendChild
Adds the nodenewChildto the end of the list of children of this node. If thenewChildis already in the tree, it is first removed.- Specified by:
appendChildin interfaceNode- Parameters:
newChild- The node to add.If it is aDocumentFragmentobject, the entire contents of the document fragment are moved into the child list of this node- Returns:
- The node added.
- Throws:
DOMException- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChildnode, or if the node to append is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised ifnewChildwas created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
hasChildNodes
public boolean hasChildNodes()This is a convenience method to allow easy determination of whether a node has any children.- Specified by:
hasChildNodesin interfaceNode- Returns:
trueif the node has any children,falseif the node has no children.
-
cloneNode
Returns a duplicate of this node, that is , serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNodereturnsnull.).
Cloning anElementcopies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a childTextnode. Cloning any other type of node simply returns a copy of this node. -
isSupported
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.- Specified by:
isSupportedin interfaceNode
-
hasAttributes
public boolean hasAttributes()Returns whether this node (if it is an element) has any attributes.- Specified by:
hasAttributesin interfaceNode
-
normalize
-
setPrefix
-
getNamespaceURI
- Specified by:
getNamespaceURIin interfaceNode
-
getPrefix
-
getLocalName
- Specified by:
getLocalNamein interfaceNode
-
compareDocumentPosition
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.- Specified by:
compareDocumentPositionin interfaceNode- Parameters:
other- The node to compare against the reference node.- Returns:
- Returns how the node is positioned relatively to the reference node.
- Throws:
DOMException- NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.- Since:
- DOM Level 3
-
setUserData
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserDatawith the same key.- Specified by:
setUserDatain interfaceNode- Parameters:
key- The key to associate the object to.data- The object to associate to the given key, ornullto remove any existing association to that key.handler- The handler to associate to that key, ornull.- Returns:
- Returns the
DOMUserDatapreviously associated to the given key on this node, ornullif there was none. - Since:
- DOM Level 3
-
getUserData
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserDatawith the same key.- Specified by:
getUserDatain interfaceNode- Parameters:
key- The key the object is associated to.- Returns:
- Returns the
DOMUserDataassociated to the given key on this node, ornullif there was none. - Since:
- DOM Level 3
-
isEqualNode
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested withNode.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:- The two nodes are of the same type.
- The following string
attributes are equal:
nodeName,localName,namespaceURI,prefix,nodeValue. This is: they are bothnull, or they have the same length and are character for character identical. - The
attributesNamedNodeMapsare equal. This is: they are bothnull, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index. - The
childNodesNodeListsare equal. This is: they are bothnull, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For twoDocumentTypenodes to be equal, the following conditions must also be satisfied:- The following string attributes
are equal:
publicId,systemId,internalSubset. - The
entitiesNamedNodeMapsare equal. - The
notationsNamedNodeMapsare equal.
On the other hand, the following do not affect equality: theownerDocument,baseURI, andparentNodeattributes, thespecifiedattribute forAttrnodes, theschemaTypeInfoattribute forAttrandElementnodes, theText.isElementContentWhitespaceattribute forTextnodes, as well as any user data or event listeners registered on the nodes.Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
- Specified by:
isEqualNodein interfaceNode- Parameters:
arg- The node to compare equality with.- Returns:
- Returns
trueif the nodes are equal,falseotherwise. - Since:
- DOM Level 3
-
isSameNode
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNodereferences returned by the implementation reference the same object. When twoNodereferences are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.- Specified by:
isSameNodein interfaceNode- Parameters:
other- The node to test against.- Returns:
- Returns
trueif the nodes are the same,falseotherwise. - Since:
- DOM Level 3
-
setTextContent
This attribute returns the text content of this node and its descendants. When it is defined to benull, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull, replaced by a singleTextnode containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContentattribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValueDOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
setTextContentin interfaceNode- Throws:
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.- Since:
- DOM Level 3
-
getTextContent
This attribute returns the text content of this node and its descendants. When it is defined to benull, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull, replaced by a singleTextnode containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContentattribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValueDOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null - Specified by:
getTextContentin interfaceNode- Throws:
DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMStringvariable on the implementation platform.- Since:
- DOM Level 3
-
getBaseURI
The absolute base URI of this node ornullif the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when theDocumentsupports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of thedocumentURIattribute from theDocumentinterface otherwise.- Specified by:
getBaseURIin interfaceNode- Since:
- DOM Level 3
-
lookupPrefix
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.- Specified by:
lookupPrefixin interfaceNode- Parameters:
nsUri- The namespace URI to look for.- Returns:
- Returns an associated namespace prefix if found or
nullif none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent. - Since:
- DOM Level 3
-
lookupNamespaceURI
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.- Specified by:
lookupNamespaceURIin interfaceNode- Parameters:
pre- The prefix to look for. If this parameter isnull, the method will return the default namespace URI if any.- Returns:
- Returns the associated namespace URI or
nullif none is found. - Since:
- DOM Level 3
-
getFeature
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support theNodeinterface.- Specified by:
getFeaturein interfaceNode- Parameters:
feature- The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.version- This is the version number of the feature to test.- Returns:
- Returns an object which implements the specialized APIs of
the specified feature and version, if any, or
nullif there is no object which implements interfaces associated with that feature. If theDOMObjectreturned by this method implements theNodeinterface, it must delegate to the primary coreNodeand not return results inconsistent with the primary coreNodesuch as attributes, childNodes, etc. - Since:
- DOM Level 3
-
isDefaultNamespace
This method checks if the specifiednamespaceURIis the default namespace or not.- Specified by:
isDefaultNamespacein interfaceNode- Parameters:
namespaceURI- The namespace URI to look for.- Returns:
- Returns
trueif the specifiednamespaceURIis the default namespace,falseotherwise. - Since:
- DOM Level 3
-
toString
-
setOwnerDocument
for use by subclasses to remove PMRDocument hierarchy -
setOwnerDocumentRecursively
-
setDelegateNode
for use by subclasses to remove delegateNode hierarchy -
wrapRecursively
-
getDelegateParentNode
-
getDelegateNode
-