|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.dom.NodeImpl | +--org.apache.xerces.dom.ChildNode | +--org.apache.xerces.dom.ParentNode | +--org.apache.xerces.dom.ElementImpl | +--org.apache.xerces.dom.ElementNSImpl | +--org.enhydra.xml.lazydom.LazyElementNS
Implementation of the DOM Element with namespaces that supports lazy instantiation of a template DOM.
Field Summary |
Fields inherited from class org.apache.xerces.dom.ElementNSImpl |
localName, namespaceURI |
Fields inherited from class org.apache.xerces.dom.ElementImpl |
attributes, name |
Fields inherited from class org.apache.xerces.dom.ParentNode |
fCachedChild, fCachedChildIndex, fCachedLength, firstChild, ownerDocument |
Fields inherited from class org.apache.xerces.dom.ChildNode |
nextSibling, previousSibling |
Fields inherited from class org.apache.xerces.dom.NodeImpl |
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Fields inherited from interface org.enhydra.xml.lazydom.LazyNode |
DOCUMENT_NODE_ID, NULL_NODE_ID |
Constructor Summary | |
protected |
LazyElementNS(LazyDocument ownerDoc,
LazyElement template,
java.lang.String namespaceURI,
java.lang.String qualifiedName)
Constructor. |
Method Summary | |
Node |
appendChild(Node newChild)
Adds the node newChild to the end of the list of children
of this node. |
void |
appendChildWhileExpanding(Node child)
Append a child during node expansion. |
boolean |
areAttributesExpanded()
Are the attributes of this node expanded? |
boolean |
areChildrenExpanded()
Are the children of this node expanded? |
Node |
cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. |
java.lang.String |
getAttribute(java.lang.String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(java.lang.String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves an Attr node by local name and namespace URI. |
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves an attribute value by local name and namespace URI. |
NamedNodeMap |
getAttributes()
A NamedNodeMap containing the attributes of this node (if
it is an Element ) or null otherwise. |
NodeList |
getChildNodes()
A NodeList that contains all children of this node. |
Node |
getFirstChild()
The first child of this node. |
Node |
getLastChild()
The last child of this node. |
Node |
getNextSibling()
The node immediately following this node. |
int |
getNodeId()
Get the node numeric id number. |
Node |
getParentNode()
The parent of this node. |
java.lang.String |
getPreFormattedText()
Get the pre-formatted text for a node. |
Node |
getPreviousSibling()
The node immediately preceding this node. |
LazyElement |
getTemplateElement()
Get the template for this node. |
LazyNode |
getTemplateNode()
Get the template node as a LazyNode. |
boolean |
hasChildNodes()
Returns whether this node has any children. |
Node |
insertBefore(Node newChild,
Node refChild)
Inserts the node newChild before the existing child node
refChild . |
boolean |
isParentExpanded()
Is the parent of this node expanded? |
boolean |
isTemplateNode()
Check if this node is a template node. |
void |
makeTemplateNode(int nodeId)
|
void |
makeTemplateNode(int nodeId,
java.lang.String text)
Mark the node as a template node and associated preformatted text. |
void |
normalize()
Puts all Text nodes in the full depth of the sub-tree
underneath this Node , including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text nodes, i.e., there are neither adjacent
Text nodes nor empty Text nodes. |
void |
removeAttribute(java.lang.String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Removes an attribute by local name and namespace URI. |
Node |
removeChild(Node oldChild)
Removes the child node indicated by oldChild from the list
of children, and returns it. |
Node |
replaceChild(Node newChild,
Node oldChild)
Replaces the child node oldChild with newChild
in the list of children, and returns the oldChild node. |
void |
setAttribute(java.lang.String name,
java.lang.String value)
Adds a new attribute. |
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute node. |
Attr |
setAttributeNodeNS(Attr newAttr)
Adds a new attribute. |
void |
setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
Adds a new attribute. |
void |
setChildrenExpanded()
Flag the children as being expanded. |
void |
setNodeValue(java.lang.String value)
Set the node value, invalidating the id. |
void |
setParentExpanded()
Flag the parent as being expanded. |
void |
setParentWhileExpanding(Node parent)
Set the parent of this node during expansion. |
void |
setPreFormattedText(java.lang.String text)
Set the pre-formatted text for a node. |
LazyNode |
templateClone(Document ownerDocument)
Create a new node, using this node as the template. |
Methods inherited from class org.apache.xerces.dom.ElementNSImpl |
getLocalName, getNamespaceURI, getPrefix, setPrefix |
Methods inherited from class org.apache.xerces.dom.ElementImpl |
getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getTagName, hasAttribute, hasAttributeNS, hasAttributes, reconcileDefaultAttributes, setReadOnly, setupDefaultAttributes, synchronizeData |
Methods inherited from class org.apache.xerces.dom.ParentNode |
getChildNodesUnoptimized, getLength, getOwnerDocument, item, synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
addEventListener, changed, changes, dispatchEvent, getNodeValue, getReadOnly, getUserData, isSupported, removeEventListener, setUserData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Element |
getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS |
Methods inherited from interface org.w3c.dom.Node |
getLocalName, getNamespaceURI, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, hasAttributes, isSupported, setPrefix |
Constructor Detail |
protected LazyElementNS(LazyDocument ownerDoc, LazyElement template, java.lang.String namespaceURI, java.lang.String qualifiedName)
ownerDoc
- The document that owns this node.template
- If not-null, get the parameters from this template.namespaceURI
- The namespace for the node.
Will be ignored if template is not-null.qualifiedName
- The tag name for the node.
Will be ignored if template is not-null.Method Detail |
public void makeTemplateNode(int nodeId, java.lang.String text)
makeTemplateNode
in interface LazyElement
LazyNode.makeTemplateNode(int)
,
PreFormatted#setPreFormattedText
public LazyElement getTemplateElement()
getTemplateElement
in interface LazyElement
LazyNode.getTemplateNode()
public Node cloneNode(boolean deep)
Node
parentNode
is null
.).
Element
copies 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
child Text
node. Cloning an Attribute
directly, as opposed to be cloned as part of an Element
cloning operation, returns a specified attribute (
specified
is true
). Cloning any other type
of node simply returns a copy of this node.
EntityReference
clone are readonly
. In addition, clones of unspecified Attr
nodes are
specified. And, cloning Document
,
DocumentType
, Entity
, and
Notation
nodes is implementation dependent.
cloneNode
in interface Node
cloneNode
in class ElementImpl
Node.cloneNode(boolean)
public void makeTemplateNode(int nodeId)
makeTemplateNode
in interface LazyNode
public int getNodeId()
LazyNode
getNodeId
in interface LazyNode
LazyNode.getNodeId()
public boolean isTemplateNode()
LazyNode
isTemplateNode
in interface LazyNode
LazyNode.isTemplateNode()
public LazyNode getTemplateNode()
LazyNode
getTemplateNode
in interface LazyNode
LazyNode.getTemplateNode()
public LazyNode templateClone(Document ownerDocument)
LazyNode
templateClone
in interface LazyNode
LazyNode.templateClone(org.w3c.dom.Document)
public void setNodeValue(java.lang.String value)
setNodeValue
in interface Node
setNodeValue
in class NodeImpl
org.w3c.dom.Node.setNodeValue
public boolean isParentExpanded()
LazyParent
isParentExpanded
in interface LazyParent
LazyParent.isParentExpanded()
public void setParentExpanded()
LazyParent
setParentExpanded
in interface LazyParent
LazyParent.setParentExpanded()
public void setParentWhileExpanding(Node parent)
LazyParent
setParentWhileExpanding
in interface LazyParent
LazyParent.setParentWhileExpanding(org.w3c.dom.Node)
public boolean areChildrenExpanded()
LazyParent
areChildrenExpanded
in interface LazyParent
LazyParent.areChildrenExpanded()
public void setChildrenExpanded()
LazyParent
setChildrenExpanded
in interface LazyParent
LazyParent.setChildrenExpanded()
public void appendChildWhileExpanding(Node child)
LazyParent
appendChildWhileExpanding
in interface LazyParent
LazyParent.appendChildWhileExpanding(org.w3c.dom.Node)
public Node getParentNode()
Node
Attr
,
Document
, DocumentFragment
,
Entity
, and Notation
may 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 is
null
.
getParentNode
in interface Node
getParentNode
in class ChildNode
Node.getParentNode()
public NodeList getChildNodes()
Node
NodeList
that contains all children of this node. If
there are no children, this is a NodeList
containing no
nodes.
getChildNodes
in interface Node
getChildNodes
in class ParentNode
Node.getChildNodes()
public Node getFirstChild()
Node
null
.
getFirstChild
in interface Node
getFirstChild
in class ParentNode
Node.getFirstChild()
public Node getLastChild()
Node
null
.
getLastChild
in interface Node
getLastChild
in class ParentNode
Node.getLastChild()
public Node getPreviousSibling()
Node
null
.
getPreviousSibling
in interface Node
getPreviousSibling
in class ChildNode
Node.getPreviousSibling()
public Node getNextSibling()
Node
null
.
getNextSibling
in interface Node
getNextSibling
in class ChildNode
Node.getNextSibling()
public Node insertBefore(Node newChild, Node refChild) throws DOMException
Node
newChild
before the existing child node
refChild
. If refChild
is null
,
insert newChild
at the end of the list of children.
newChild
is a DocumentFragment
object,
all of its children are inserted, in the same order, before
refChild
. If the newChild
is already in the
tree, it is first removed.
insertBefore
in interface Node
insertBefore
in class ParentNode
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild
node, or if
the node to insert is one of this node's ancestors.
newChild
was created
from a different document than the one that created this node.
refChild
is not a child of
this node.Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node)
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
Node
oldChild
with newChild
in the list of children, and returns the oldChild
node.
newChild
is a DocumentFragment
object,
oldChild
is replaced by all of the
DocumentFragment
children, which are inserted in the
same order. If the newChild
is already in the tree, it
is first removed.
replaceChild
in interface Node
replaceChild
in class ParentNode
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild
node, or if
the node to put in is one of this node's ancestors.
newChild
was created
from a different document than the one that created this node.
oldChild
is not a child of
this node.Node.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node)
public Node removeChild(Node oldChild) throws DOMException
Node
oldChild
from the list
of children, and returns it.
removeChild
in interface Node
removeChild
in class ParentNode
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild
is not a child of
this node.Node.removeChild(org.w3c.dom.Node)
public Node appendChild(Node newChild) throws DOMException
Node
newChild
to the end of the list of children
of this node. If the newChild
is already in the tree, it
is first removed.
appendChild
in interface Node
appendChild
in class NodeImpl
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild
node, or if
the node to append is one of this node's ancestors.
newChild
was created
from a different document than the one that created this node.
Node.appendChild(org.w3c.dom.Node)
public boolean hasChildNodes()
Node
hasChildNodes
in interface Node
hasChildNodes
in class ParentNode
true
if this node has any children,
false
otherwise.Node.hasChildNodes()
public void normalize()
Node
Text
nodes in the full depth of the sub-tree
underneath this Node
, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text
nodes, i.e., there are neither adjacent
Text
nodes nor empty Text
nodes. This can
be used to ensure that the DOM view of a document is the same as if
it were saved and re-loaded, and is useful when operations (such as
XPointer lookups) that depend on a particular document tree
structure are to be used.In cases where the document contains
CDATASections
, the normalize operation alone may not be
sufficient, since XPointers do not differentiate between
Text
nodes and CDATASection
nodes.
normalize
in interface Node
normalize
in class ElementImpl
Node.normalize()
public boolean areAttributesExpanded()
areAttributesExpanded
in interface LazyElement
public NamedNodeMap getAttributes()
Node
NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise.
getAttributes
in interface Node
getAttributes
in class ElementImpl
Node.getAttributes()
public java.lang.String getAttribute(java.lang.String name)
Element
getAttribute
in interface Element
getAttribute
in class ElementImpl
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.Element.getAttribute(java.lang.String)
public void setAttribute(java.lang.String name, java.lang.String value) throws DOMException
Element
Attr
node plus any
Text
and EntityReference
nodes, build the
appropriate subtree, and use setAttributeNode
to assign
it as the value of an attribute.
setAttributeNS
method.
setAttribute
in interface Element
setAttribute
in class ElementImpl
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
Element.setAttribute(java.lang.String, java.lang.String)
public void removeAttribute(java.lang.String name) throws DOMException
Element
removeAttributeNS
method.
removeAttribute
in interface Element
removeAttribute
in class ElementImpl
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.Element.removeAttribute(java.lang.String)
public Attr getAttributeNode(java.lang.String name)
Element
getAttributeNodeNS
method.
getAttributeNode
in interface Element
getAttributeNode
in class ElementImpl
Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.Element.getAttributeNode(java.lang.String)
public Attr setAttributeNode(Attr newAttr) throws DOMException
Element
nodeName
) is already present in the element, it is
replaced by the new one.
setAttributeNodeNS
method.
setAttributeNode
in interface Element
setAttributeNode
in class ElementImpl
newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned,
otherwise null
is returned.
DOMException
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.Element.setAttributeNode(org.w3c.dom.Attr)
public Attr removeAttributeNode(Attr oldAttr) throws DOMException
Element
Attr
has a default value it is immediately replaced. The replacing
attribute has the same namespace URI and local name, as well as the
original prefix, when applicable.
removeAttributeNode
in interface Element
removeAttributeNode
in class ElementImpl
Attr
node that was removed.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldAttr
is not an attribute
of the element.Element.removeAttributeNode(org.w3c.dom.Attr)
public java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Element
getAttributeNS
in interface Element
getAttributeNS
in class ElementImpl
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.Element.getAttributeNS(java.lang.String, java.lang.String)
public void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) throws DOMException
Element
qualifiedName
, and
its value is changed to be the value
parameter. This
value is a simple string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an entity reference) is
treated as literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an
attribute value that contains entity references, the user must create
an Attr
node plus any Text
and
EntityReference
nodes, build the appropriate subtree,
and use setAttributeNodeNS
or
setAttributeNode
to assign it as the value of an
attribute.
setAttributeNS
in interface Element
setAttributeNS
in class ElementImpl
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character.
qualifiedName
is
malformed, if the qualifiedName
has a prefix and the
namespaceURI
is null
, if the
qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace", or if the
qualifiedName
is "xmlns" and the
namespaceURI
is different from "
http://www.w3.org/2000/xmlns/".Element.setAttributeNS(java.lang.String, java.lang.String, java.lang.String)
public void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) throws DOMException
Element
removeAttributeNS
in interface Element
removeAttributeNS
in class ElementImpl
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.Element.removeAttributeNS(java.lang.String, java.lang.String)
public Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Element
Attr
node by local name and namespace URI.
HTML-only DOM implementations do not need to implement this method.
getAttributeNodeNS
in interface Element
getAttributeNodeNS
in class ElementImpl
Attr
node with the specified attribute local
name and namespace URI or null
if there is no such
attribute.Element.getAttributeNodeNS(java.lang.String, java.lang.String)
public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
Element
setAttributeNodeNS
in interface Element
setAttributeNodeNS
in class ElementImpl
newAttr
attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr
node is returned, otherwise null
is
returned.
DOMException
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.Element.setAttributeNodeNS(org.w3c.dom.Attr)
public java.lang.String getPreFormattedText()
PreFormattedText
getPreFormattedText
in interface PreFormattedText
PreFormattedText.getPreFormattedText()
public void setPreFormattedText(java.lang.String text)
PreFormattedText
setPreFormattedText
in interface PreFormattedText
PreFormatted#setPreFormattedText
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |