|
||||||||||
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.AttrImpl
public class AttrImpl
Attribute represents an XML-style attribute of an Element. Typically, the allowable values are controlled by its declaration in the Document Type Definition (DTD) governing this kind of document.
If the attribute has not been explicitly assigned a value, but has been declared in the DTD, it will exist and have that default. Only if neither the document nor the DTD specifies a value will the Attribute really be considered absent and have no value; in that case, querying the attribute will return null.
Attributes may have multiple children that contain their data. (XML allows attributes to contain entity references, and tokenized attribute types such as NMTOKENS may have a child for each token.) For convenience, the Attribute object's getValue() method returns the string version of the attribute's value.
Attributes are not children of the Elements they belong to, in the usual sense, and have no valid Parent reference. However, the spec says they _do_ belong to a specific Element, and an INUSE exception is to be thrown if the user attempts to explicitly share them between elements.
Note that Elements do not permit attributes to appear to be shared (see the INUSE exception), so this object's mutability is officially not an issue.
Note: The ownerNode attribute is used to store the Element the Attr node is associated with. Attr nodes do not have parent nodes. Besides, the getOwnerElement() method can be used to get the element node this attribute is associated with.
AttrImpl does not support Namespaces. AttrNSImpl, which inherits from it, does.
AttrImpl used to inherit from ParentNode. It now directly inherits from NodeImpl and provide its own implementation of the ParentNode's behavior. The reason is that we now try and avoid to always create a Text node to hold the value of an attribute. The DOM spec requires it, so we still have to do it in case getFirstChild() is called for instance. The reason attribute values are stored as a list of nodes is so that they can carry more than a simple string. They can also contain EntityReference nodes. However, most of the times people only have a single string that they only set and get through Element.set/getAttribute or Attr.set/getValue. In this new version, the Attr node has a value pointer which can either be the String directly or a pointer to the first ChildNode. A flag tells which one it currently is. Note that while we try to stick with the direct String as much as possible once we've switched to a node there is no going back. This is because we have no way to know whether the application keeps referring to the node we once returned.
The gain in memory varies on the density of attributes in the document. But in the tests I've run I've seen up to 12% of memory gain. And the good thing is that it also leads to a slight gain in speed because we allocate fewer objects! I mean, that's until we have to actually create the node...
To avoid too much duplicated code, I got rid of ParentNode and renamed ChildAndParentNode, which I never really liked, to ParentNode for simplicity, this doesn't make much of a difference in memory usage because there are only very few objects that are only a Parent. This is only true now because AttrImpl now inherits directly from NodeImpl and has its own implementation of the ParentNode's node behavior. So there is still some duplicated code there.
This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.
WARNING: Some of the code here is partially duplicated in ParentNode, be careful to keep these two classes in sync!
AttrNSImpl
,
Serialized FormField Summary |
---|
Fields inherited from interface org.w3c.dom.TypeInfo |
---|
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION |
Method Summary | |
---|---|
Node |
cloneNode(boolean deep)
Returns a duplicate of a given node. |
NodeList |
getChildNodes()
Obtain a NodeList enumerating all children of this node. |
Element |
getElement()
Deprecated. Previous working draft of DOM Level 2. New method is getOwnerElement(). |
Node |
getFirstChild()
The first child of this Node, or null if none. |
Node |
getLastChild()
The last child of this Node, or null if none. |
int |
getLength()
NodeList method: Count the immediate children of this node |
java.lang.String |
getName()
In Attributes, NodeName is considered a synonym for the attribute's Name |
java.lang.String |
getNodeName()
Returns the attribute name |
short |
getNodeType()
A short integer indicating what type of node this is. |
java.lang.String |
getNodeValue()
In Attribute objects, NodeValue is considered a synonym for Value. |
Element |
getOwnerElement()
Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element. |
TypeInfo |
getSchemaTypeInfo()
Method getSchemaTypeInfo. |
boolean |
getSpecified()
The "specified" flag is true if and only if this attribute's value was explicitly specified in the original document. |
java.lang.String |
getTypeName()
The name of a type declared for the associated element or attribute, or null if unknown. |
java.lang.String |
getTypeNamespace()
The namespace of the type declared for the associated element or attribute or null if the element does not have
declaration or if no namespace information is available. |
java.lang.String |
getValue()
The "string value" of an Attribute is its text representation, which in turn is a concatenation of the string values of its children. |
boolean |
hasChildNodes()
Test whether this node has any children. |
Node |
insertBefore(Node newChild,
Node refChild)
Move one or more node(s) to our list of children. |
boolean |
isDerivedFrom(java.lang.String typeNamespaceArg,
java.lang.String typeNameArg,
int derivationMethod)
Introduced in DOM Level 3. |
boolean |
isEqualNode(Node arg)
DOM Level 3 WD- Experimental. |
boolean |
isId()
DOM Level 3: isId |
Node |
item(int index)
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds. |
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 markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text nodes, i.e., there are no adjacent Text
nodes. |
Node |
removeChild(Node oldChild)
Remove a child from this Node. |
Node |
replaceChild(Node newChild,
Node oldChild)
Make newChild occupy the location that oldChild used to have. |
void |
setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type. |
void |
setNodeValue(java.lang.String value)
Implicit in the rerouting of getNodeValue to getValue is the need to redefine setNodeValue, for symmetry's sake. |
void |
setReadOnly(boolean readOnly,
boolean deep)
Override default behavior so that if deep is true, children are also toggled. |
void |
setSpecified(boolean arg)
NON-DOM, for use by parser |
void |
setType(java.lang.Object type)
NON-DOM: used by the parser |
void |
setValue(java.lang.String newvalue)
The DOM doesn't clearly define what setValue(null) means. |
java.lang.String |
toString()
NON-DOM method for debugging convenience |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
---|
addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getTextContent, getUserData, getUserData, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setPrefix, setTextContent, setUserData, setUserData |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
---|
appendChild, compareDocumentPosition, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setPrefix, setTextContent, setUserData |
Method Detail |
---|
public void setIdAttribute(boolean id)
id
- public boolean isId()
isId
in interface Attr
public Node cloneNode(boolean deep)
NodeImpl
Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior.
cloneNode
in interface Node
cloneNode
in class NodeImpl
deep
- If true
, recursively clone the subtree under
the specified node; if false
, clone only the node
itself (and its attributes, if it is an Element
).
Example: Cloning a Text node will copy both the node and the text it
contains.
Example: Cloning something that has children -- Element or Attr, for
example -- will _not_ clone those children unless a "deep clone"
has been requested. A shallow clone of an Attr node will yield an
empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned
is read-only, to permit applications using only the DOM API to obtain
editable copies of locked portions of the tree.
public short getNodeType()
getNodeType
in interface Node
getNodeType
in class NodeImpl
public java.lang.String getNodeName()
getNodeName
in interface Node
getNodeName
in class NodeImpl
public void setNodeValue(java.lang.String value) throws DOMException
setNodeValue
in interface Node
setNodeValue
in class NodeImpl
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if
it is not defined to be null
.public java.lang.String getTypeName()
TypeInfo
null
if unknown.
getTypeName
in interface TypeInfo
TypeInfo.getTypeName()
public java.lang.String getTypeNamespace()
TypeInfo
null
if the element does not have
declaration or if no namespace information is available.
getTypeNamespace
in interface TypeInfo
TypeInfo.getTypeNamespace()
public TypeInfo getSchemaTypeInfo()
getSchemaTypeInfo
in interface Attr
public java.lang.String getNodeValue()
getNodeValue
in interface Node
getNodeValue
in class NodeImpl
getValue()
public java.lang.String getName()
getName
in interface Attr
public void setValue(java.lang.String newvalue)
setValue
in interface Attr
public java.lang.String getValue()
getValue
in interface Attr
public boolean getSpecified()
getSpecified
in interface Attr
public Element getElement()
getOwnerElement()
public Element getOwnerElement()
getOwnerElement
in interface Attr
public void normalize()
NodeImpl
Text
nodes in the full depth of the sub-tree
underneath this Node
, including attribute nodes, into a
"normal" form where only markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text
nodes, i.e., there are no adjacent 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.
Note that this implementation simply calls normalize() on this Node's children. It is up to implementors or Node to override normalize() to take action.
normalize
in interface Node
normalize
in class NodeImpl
public void setSpecified(boolean arg)
public void setType(java.lang.Object type)
type
- public java.lang.String toString()
toString
in class NodeImpl
public boolean hasChildNodes()
hasChildNodes
in interface Node
hasChildNodes
in class NodeImpl
true
if this node has any children,
false
otherwise.ParentNode
public NodeList getChildNodes()
NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.
In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.
getChildNodes
in interface Node
getChildNodes
in class NodeImpl
public Node getFirstChild()
getFirstChild
in interface Node
getFirstChild
in class NodeImpl
ParentNode
public Node getLastChild()
getLastChild
in interface Node
getLastChild
in class NodeImpl
ParentNode
public Node insertBefore(Node newChild, Node refChild) throws DOMException
insertBefore
in interface Node
insertBefore
in class NodeImpl
newChild
- The Node to be moved to our subtree. As a
convenience feature, inserting a DocumentNode will instead insert
all its children.refChild
- Current child which newChild should be placed
immediately before. If refChild is null, the insertion occurs
after all existing Nodes, like appendChild().
DOMException(HIERARCHY_REQUEST_ERR)
- if newChild is of a
type that shouldn't be a child of this node, or if newChild is an
ancestor of this node.
DOMException(WRONG_DOCUMENT_ERR)
- if newChild has a
different owner document than we do.
DOMException(NOT_FOUND_ERR)
- if refChild is not a child of
this node.
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.
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 or this node
itself, or if this node is of type Document
and the
DOM application attempts to insert a second
DocumentType
or Element
node.
newChild
was created
from a different document than the one that created this node.
refChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the insertion of a DocumentType
or
Element
node.ParentNode
public Node removeChild(Node oldChild) throws DOMException
removeChild
in interface Node
removeChild
in class NodeImpl
oldChild
- The node being removed.
DOMException(NOT_FOUND_ERR)
- if oldChild is not a child of
this node.
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the removal of the DocumentType
child or the
Element
child.ParentNode
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
replaceChild
in interface Node
replaceChild
in class NodeImpl
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.
DOMException(HIERARCHY_REQUEST_ERR)
- if newChild is of a
type that shouldn't be a child of this node, or if newChild is
one of our ancestors.
DOMException(WRONG_DOCUMENT_ERR)
- if newChild has a
different owner document than we do.
DOMException(NOT_FOUND_ERR)
- if oldChild is not a child of
this node.
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.
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 or this node
itself, or if this node is of type Document
and the
result of the replacement operation would add a second
DocumentType
or Element
on the
Document
node.
newChild
was created
from a different document than the one that created this node.
oldChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the replacement of the DocumentType
child or
Element
child.ParentNode
public int getLength()
getLength
in interface NodeList
getLength
in class NodeImpl
ParentNode
public Node item(int index)
item
in interface NodeList
item
in class NodeImpl
index
- int
ParentNode
public boolean isEqualNode(Node arg)
isEqualNode
in interface Node
isEqualNode
in class NodeImpl
arg
- The node to compare equality with.
true
otherwise false
.public boolean isDerivedFrom(java.lang.String typeNamespaceArg, java.lang.String typeNameArg, int derivationMethod)
Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
isDerivedFrom
in interface TypeInfo
typeNamespaceArg
- The namspace of the ancestor type declarationtypeNameArg
- The name of the ancestor type declarationderivationMethod
- The derivation method
public void setReadOnly(boolean readOnly, boolean deep)
setReadOnly
in class NodeImpl
readOnly
- True or false as desired.deep
- If true, children are also toggled. Note that this will
not change the state of an EntityReference or its children,
which are always read-only.
Note: this will not change the state of an EntityReference or its
children, which are always read-only.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |