org.apache.xerces.dom

Class AttrImpl

public class AttrImpl extends NodeImpl implements Attr, TypeInfo

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!

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.

Since: PR-DOM-Level-1-19980818.

Version: $Id: AttrImpl.java,v 1.64 2005/05/02 22:02:22 mrglavas Exp $

Author: Arnaud Le Hors, IBM Joe Kesselman, IBM Andy Clark, IBM

See Also:

Field Summary
protected Stringname
Attribute name.
protected static TextImpltextNode
protected Objectvalue
This can either be a String or the first child node.
Constructor Summary
protected AttrImpl(CoreDocumentImpl ownerDocument, String name)
Attribute has no public constructor.
protected AttrImpl()
False for default attributes.
Method Summary
NodecloneNode(boolean deep)
NodeListgetChildNodes()
Obtain a NodeList enumerating all children of this node.
ElementgetElement()
Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.
NodegetFirstChild()
The first child of this Node, or null if none.
NodegetLastChild()
The last child of this Node, or null if none.
intgetLength()
NodeList method: Count the immediate children of this node
StringgetName()
In Attributes, NodeName is considered a synonym for the attribute's Name
StringgetNodeName()
Returns the attribute name
shortgetNodeType()
A short integer indicating what type of node this is.
StringgetNodeValue()
In Attribute objects, NodeValue is considered a synonym for Value.
ElementgetOwnerElement()
Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.
TypeInfogetSchemaTypeInfo()
Method getSchemaTypeInfo.
booleangetSpecified()
The "specified" flag is true if and only if this attribute's value was explicitly specified in the original document.
StringgetTypeName()
StringgetTypeNamespace()
StringgetValue()
The "string value" of an Attribute is its text representation, which in turn is a concatenation of the string values of its children.
booleanhasChildNodes()
Test whether this node has any children.
NodeinsertBefore(Node newChild, Node refChild)
Move one or more node(s) to our list of children.
booleanisDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod)
Introduced in DOM Level 3.
booleanisEqualNode(Node arg)
DOM Level 3 WD- Experimental.
booleanisId()
DOM Level 3: isId
Nodeitem(int index)
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
protected voidmakeChildNode()
voidnormalize()
NoderemoveChild(Node oldChild)
Remove a child from this Node.
NodereplaceChild(Node newChild, Node oldChild)
Make newChild occupy the location that oldChild used to have.
voidsetIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.
voidsetNodeValue(String value)
Implicit in the rerouting of getNodeValue to getValue is the need to redefine setNodeValue, for symmetry's sake.
voidsetReadOnly(boolean readOnly, boolean deep)
Override default behavior so that if deep is true, children are also toggled.
voidsetSpecified(boolean arg)
NON-DOM, for use by parser
voidsetType(Object type)
NON-DOM: used by the parser
voidsetValue(String newvalue)
The DOM doesn't clearly define what setValue(null) means.
protected voidsynchronizeChildren()
Override this method in subclass to hook in efficient internal data structure.
StringtoString()
NON-DOM method for debugging convenience

Field Detail

name

protected String name
Attribute name.

textNode

protected static TextImpl textNode

value

protected Object value
This can either be a String or the first child node.

Constructor Detail

AttrImpl

protected AttrImpl(CoreDocumentImpl ownerDocument, String name)
Attribute has no public constructor. Please use the factory method in the Document class.

AttrImpl

protected AttrImpl()
False for default attributes.

Method Detail

cloneNode

public Node cloneNode(boolean deep)

getChildNodes

public NodeList getChildNodes()
Obtain a NodeList enumerating all children of this node. If there are none, an (initially) empty NodeList is returned.

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.

getElement

public Element getElement()

Deprecated: Previous working draft of DOM Level 2. New method is getOwnerElement().

Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.

See Also: AttrImpl

getFirstChild

public Node getFirstChild()
The first child of this Node, or null if none.

getLastChild

public Node getLastChild()
The last child of this Node, or null if none.

getLength

public int getLength()
NodeList method: Count the immediate children of this node

Returns: int

getName

public String getName()
In Attributes, NodeName is considered a synonym for the attribute's Name

getNodeName

public String getNodeName()
Returns the attribute name

getNodeType

public short getNodeType()
A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.

getNodeValue

public String getNodeValue()
In Attribute objects, NodeValue is considered a synonym for Value.

See Also: getValue

getOwnerElement

public Element getOwnerElement()
Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.

Since: WD-DOM-Level-2-19990719

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()
Method getSchemaTypeInfo.

Returns: TypeInfo

getSpecified

public boolean getSpecified()
The "specified" flag is true if and only if this attribute's value was explicitly specified in the original document. Note that the implementation, not the user, is in charge of this property. If the user asserts an Attribute value (even if it ends up having the same value as the default), it is considered a specified attribute. If you really want to revert to the default, delete the attribute from the Element, and the Implementation will re-assert the default (if any) in its place, with the appropriate specified=false setting.

getTypeName

public String getTypeName()

See Also: org.w3c.dom.TypeInfo#getTypeName()

getTypeNamespace

public String getTypeNamespace()

See Also: org.w3c.dom.TypeInfo#getTypeNamespace()

getValue

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

hasChildNodes

public boolean hasChildNodes()
Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)

insertBefore

public Node insertBefore(Node newChild, Node refChild)
Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.

Parameters: 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().

Returns: newChild, in its new state (relocated, or emptied in the case of DocumentNode.)

Throws: 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.

isDerivedFrom

public boolean isDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod)
Introduced in DOM Level 3.

Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom

Parameters: ancestorNS The namspace of the ancestor type declaration ancestorName The name of the ancestor type declaration type The reference type definition

Returns: boolean True if the type is derived by restriciton for the reference type

isEqualNode

public boolean isEqualNode(Node arg)
DOM Level 3 WD- Experimental. Override inherited behavior from ParentNode to support deep equal. isEqualNode is always deep on Attr nodes.

isId

public boolean isId()
DOM Level 3: isId

item

public Node item(int index)
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.

Parameters: Index int

Returns: org.w3c.dom.Node

makeChildNode

protected void makeChildNode()

normalize

public void normalize()

removeChild

public Node removeChild(Node oldChild)
Remove a child from this Node. The removed child's subtree remains intact so it may be re-inserted elsewhere.

Returns: oldChild, in its new state (removed).

Throws: DOMException(NOT_FOUND_ERR) if oldChild is not a child of this node. DOMException(NO_MODIFICATION_ALLOWED_ERR) if this node is read-only.

replaceChild

public Node replaceChild(Node newChild, Node oldChild)
Make newChild occupy the location that oldChild used to have. Note that newChild will first be removed from its previous parent, if any. Equivalent to inserting newChild before oldChild, then removing oldChild.

Returns: oldChild, in its new state (removed).

Throws: 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.

setIdAttribute

public void setIdAttribute(boolean id)
NON-DOM: set the type of this attribute to be ID type.

Parameters: id

setNodeValue

public void setNodeValue(String value)
Implicit in the rerouting of getNodeValue to getValue is the need to redefine setNodeValue, for symmetry's sake. Note that since we're explicitly providing a value, Specified should be set true.... even if that value equals the default.

setReadOnly

public void setReadOnly(boolean readOnly, boolean deep)
Override default behavior so that if deep is true, children are also toggled.

See Also: Node

Note: this will not change the state of an EntityReference or its children, which are always read-only.

setSpecified

public void setSpecified(boolean arg)
NON-DOM, for use by parser

setType

public void setType(Object type)
NON-DOM: used by the parser

Parameters: type

setValue

public void setValue(String newvalue)
The DOM doesn't clearly define what setValue(null) means. I've taken it as "remove all children", which from outside should appear similar to setting it to the empty string.

synchronizeChildren

protected void synchronizeChildren()
Override this method in subclass to hook in efficient internal data structure.

toString

public String toString()
NON-DOM method for debugging convenience
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.