org.enhydra.xml
Class AttrImpl

java.lang.Object
  extended byorg.enhydra.xml.NodeImpl
      extended byorg.enhydra.xml.AttrImpl
All Implemented Interfaces:
org.w3c.dom.Attr, org.w3c.dom.Node, org.w3c.dom.NodeList

public class AttrImpl
extends NodeImpl
implements org.w3c.dom.Attr

Version:
1.0
Author:
Tweety A class representing a node in a meta-data tree, which implements the

Namespaces are ignored in this implementation. The terms "tag name" and "node name" are always considered to be synonymous.


Field Summary
 
Fields inherited from class org.enhydra.xml.NodeImpl
firstChild, lastChild, nextSibling, nodeName, nodeValue, numChildren, ownerDocument, parent, previousSibling, type
 
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
 
Constructor Summary
AttrImpl(org.w3c.dom.Attr attr)
          Constructs a AttrImpl from the given node.
AttrImpl(org.w3c.dom.Element owner, java.lang.String name, java.lang.String value)
          Constructs an empty AttrImpl.
 
Method Summary
 org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
          Adds the node newChild to the end of the list of children of this node.
protected  void beginToString(java.lang.StringBuffer sb, Indent indent)
          Method beginToString should be redefined in extended classes.
protected  void checkNode(org.w3c.dom.Node node)
          Check that the node is either null or an NodeImpl.
 org.w3c.dom.Node cloneNode(boolean deep)
          Returns a duplicate of this node.
 short compareDocumentPosition(org.w3c.dom.Node other)
           
protected  void endToString(java.lang.StringBuffer sb, Indent indent)
          Method endToString should be redefined in extended classes.
 org.w3c.dom.NamedNodeMap getAttributes()
          Returns all attribute nodes of this node.
 java.lang.String getBaseURI()
           
 org.w3c.dom.NodeList getChildNodes()
          Returns all child nodes of this node, or null if the node has no children.
 java.lang.Object getFeature(java.lang.String feature, java.lang.String version)
           
 org.w3c.dom.Node getFirstChild()
          Returns the first child of this node, or null if the node has no children.
 org.w3c.dom.Node getLastChild()
          Returns the last child of this node, or null if the node has no children.
 int getLength()
          Returns number of child nodes.
 java.lang.String getLocalName()
          Equivalent to getNodeName.
 java.lang.String getName()
          Returns the attribute name associated with this node.
 java.lang.String getNamespaceURI()
           
 org.w3c.dom.Node getNextSibling()
          Returns the next sibling of this node, or null if the node has no next sibling.
 java.lang.String getNodeName()
          Returns the name associated with this node.
 short getNodeType()
          Returns the node type.
 java.lang.String getNodeValue()
          Returns the value associated with this node.
 org.w3c.dom.Document getOwnerDocument()
          Returns null, since NodeImpls do not belong to any Document.
 org.w3c.dom.Element getOwnerElement()
          Returns the owner of this attribute.
 org.w3c.dom.Node getParentNode()
          Returns the parent of this node.
 java.lang.String getPrefix()
          Returns null, since namespaces are not supported.
 org.w3c.dom.Node getPreviousSibling()
          Returns the previous sibling of this node, or null if this node has no previous sibling.
 TypeInfo getSchemaTypeInfo()
           
 boolean getSpecified()
          If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.
 java.lang.String getTextContent()
           
 java.lang.Object getUserData(java.lang.String key)
           
 java.lang.String getValue()
          Returns the value associated with this attributes.
 boolean hasAttributes()
          Returns true, if this node has attributes, otherwise false.
 boolean hasChildNodes()
          Returns true if this node has child nodes.
protected  void initNodeImplChildren(org.w3c.dom.Node node)
          Creates the children subtree and adds to this node.
 org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
          Inserts the node newChild before the existing child node refChild.
 boolean isDefaultNamespace(java.lang.String namespaceURI)
           
 boolean isEqualNode(org.w3c.dom.Node arg)
           
 boolean isId()
           
 boolean isSameNode(org.w3c.dom.Node other)
           
 boolean isSupported(java.lang.String feature, java.lang.String version)
          Returns false since DOM features are not supported.
 org.w3c.dom.Node item(int index)
          Returns child node with the given index.
 java.lang.String lookupNamespaceURI(java.lang.String prefix)
           
 java.lang.String lookupPrefix(java.lang.String namespaceURI)
           
protected  org.w3c.dom.Node newCommentInstance(org.w3c.dom.Node node)
          Creates new instance of the CommentImpl class.
protected  org.w3c.dom.Node newDefaultInstance(org.w3c.dom.Node node)
          Creates new instance of the NodeImpl class.
protected  org.w3c.dom.Node newElementInstance(org.w3c.dom.Node node)
          Creates new instance of the ElementImpl class.
protected  org.w3c.dom.Node newTextInstance(org.w3c.dom.Node node)
          Creates new instance of the TextImpl class.
 void normalize()
          Does nothing, since NodeImpls do not contain Text children.
 org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
          Removes the child node indicated by oldChild from the list of children, and returns it.
 org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
          Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
 void setNodeValue(java.lang.String value)
          Sets the value of this node to the given one.
 void setPrefix(java.lang.String prefix)
          Does nothing, since namespaces are not supported.
 void setTextContent(java.lang.String textContent)
           
 java.lang.Object setUserData(java.lang.String key, java.lang.Object data, UserDataHandler handler)
           
 void setValue(java.lang.String value)
          Sets the value of this attribute to the given one.
 java.lang.String toString()
          Returns String representation of this node.
 java.lang.String toString(java.lang.String tab)
          Returns String representation of this node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AttrImpl

public AttrImpl(org.w3c.dom.Element owner,
                java.lang.String name,
                java.lang.String value)
Constructs an empty AttrImpl.

Parameters:
owner - document owner.
name - node name.
value - node value.

AttrImpl

public AttrImpl(org.w3c.dom.Attr attr)
Constructs a AttrImpl from the given node.

Parameters:
attr - , as a AttrImpl.
Method Detail

getName

public java.lang.String getName()
Returns the attribute name associated with this node.

Specified by:
getName in interface org.w3c.dom.Attr
Returns:
the attribute name, as a String.

getNodeName

public java.lang.String getNodeName()
Returns the name associated with this node.

Specified by:
getNodeName in interface org.w3c.dom.Node
Overrides:
getNodeName in class NodeImpl
Returns:
the name, as a String.

getNodeType

public short getNodeType()
Returns the node type.

Specified by:
getNodeType in interface org.w3c.dom.Node
Overrides:
getNodeType in class NodeImpl
Returns:
the ATTRIBUTE_NODE node type.

getSpecified

public boolean getSpecified()
If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false. Note that the implementation is in charge of this attribute, not the user. If the user changes the value of the attribute (even if it ends up having the same value as the default value) then the specified flag is automatically flipped to true. To re-specify the attribute as the default value from the DTD, the user must delete the attribute. The implementation will then make a new attribute available with specified set to false and the default value (if one exists).
In summary: If the attribute has an assigned value in the document then specified is true, and the value is the assigned value.If the attribute has no assigned value in the document and has a default value in the DTD, then specified is false, and the value is the default value in the DTD.If the attribute has no assigned value in the document and has a value of #IMPLIED in the DTD, then the attribute does not appear in the structure model of the document.If the ownerElement attribute is null (i.e. because it was just created or was set to null by the various removal and cloning operations) specified is true.

Specified by:
getSpecified in interface org.w3c.dom.Attr
Returns:
always true.

getValue

public java.lang.String getValue()
Returns the value associated with this attributes.

Specified by:
getValue in interface org.w3c.dom.Attr
Returns:
the node attributes, as a String.

getNodeValue

public java.lang.String getNodeValue()
Returns the value associated with this node.

Specified by:
getNodeValue in interface org.w3c.dom.Node
Overrides:
getNodeValue in class NodeImpl
Returns:
the node value, as a String.

setValue

public void setValue(java.lang.String value)
Sets the value of this attribute to the given one.

Specified by:
setValue in interface org.w3c.dom.Attr
Parameters:
value - the new attribute value, as a String.

setNodeValue

public void setNodeValue(java.lang.String value)
Sets the value of this node to the given one.

Specified by:
setNodeValue in interface org.w3c.dom.Node
Overrides:
setNodeValue in class NodeImpl
Parameters:
value - is value of the node

getOwnerElement

public org.w3c.dom.Element getOwnerElement()
Returns the owner of this attribute.

Specified by:
getOwnerElement in interface org.w3c.dom.Attr
Returns:
the attribute owner node.

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

isId

public boolean isId()

initNodeImplChildren

protected void initNodeImplChildren(org.w3c.dom.Node node)
Description copied from class: NodeImpl
Creates the children subtree and adds to this node. (this part had to be splited from the constructor)

Overrides:
initNodeImplChildren in class NodeImpl
Parameters:
node - a Node.

newElementInstance

protected org.w3c.dom.Node newElementInstance(org.w3c.dom.Node node)
Description copied from class: NodeImpl
Creates new instance of the ElementImpl class.

Overrides:
newElementInstance in class NodeImpl
Parameters:
node - , as a Node.
Returns:
Node new instance of the ElementImpl class.

newTextInstance

protected org.w3c.dom.Node newTextInstance(org.w3c.dom.Node node)
Description copied from class: NodeImpl
Creates new instance of the TextImpl class.

Overrides:
newTextInstance in class NodeImpl
Parameters:
node - , as a Node.
Returns:
Node new instance of the TextImpl class.

newCommentInstance

protected org.w3c.dom.Node newCommentInstance(org.w3c.dom.Node node)
Description copied from class: NodeImpl
Creates new instance of the CommentImpl class.

Overrides:
newCommentInstance in class NodeImpl
Parameters:
node - , as a Node.
Returns:
Node new instance of the CommentImpl class.

newDefaultInstance

protected org.w3c.dom.Node newDefaultInstance(org.w3c.dom.Node node)
Description copied from class: NodeImpl
Creates new instance of the NodeImpl class.

Overrides:
newDefaultInstance in class NodeImpl
Parameters:
node - , as a Node.
Returns:
Node new instance of the NodeImpl class.

checkNode

protected void checkNode(org.w3c.dom.Node node)
                  throws org.w3c.dom.DOMException
Description copied from class: NodeImpl
Check that the node is either null or an NodeImpl.

Overrides:
checkNode in class NodeImpl
Parameters:
node - , as a Node.
Throws:
org.w3c.dom.DOMException - if node is not an instance of NodeImpl.

getParentNode

public org.w3c.dom.Node getParentNode()
Description copied from class: NodeImpl
Returns the parent of this node. A null value indicates that the node is the root of its own tree. To add a node to an existing tree, use one of the insertBefore, replaceChild, or appendChild methods.

Specified by:
getParentNode in interface org.w3c.dom.Node
Overrides:
getParentNode in class NodeImpl
Returns:
the parent, as a Node.
See Also:
NodeImpl.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), NodeImpl.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node), NodeImpl.appendChild(org.w3c.dom.Node)

getChildNodes

public org.w3c.dom.NodeList getChildNodes()
Description copied from class: NodeImpl
Returns all child nodes of this node, or null if the node has no children.

Specified by:
getChildNodes in interface org.w3c.dom.Node
Overrides:
getChildNodes in class NodeImpl
Returns:
all child nodes of this node, as a Node, or null.

getFirstChild

public org.w3c.dom.Node getFirstChild()
Description copied from class: NodeImpl
Returns the first child of this node, or null if the node has no children.

Specified by:
getFirstChild in interface org.w3c.dom.Node
Overrides:
getFirstChild in class NodeImpl
Returns:
the first child, as a Node, or null

getLastChild

public org.w3c.dom.Node getLastChild()
Description copied from class: NodeImpl
Returns the last child of this node, or null if the node has no children.

Specified by:
getLastChild in interface org.w3c.dom.Node
Overrides:
getLastChild in class NodeImpl
Returns:
the last child, as a Node, or null.

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()
Description copied from class: NodeImpl
Returns the previous sibling of this node, or null if this node has no previous sibling.

Specified by:
getPreviousSibling in interface org.w3c.dom.Node
Overrides:
getPreviousSibling in class NodeImpl
Returns:
the previous sibling, as a Node, or null.

getNextSibling

public org.w3c.dom.Node getNextSibling()
Description copied from class: NodeImpl
Returns the next sibling of this node, or null if the node has no next sibling.

Specified by:
getNextSibling in interface org.w3c.dom.Node
Overrides:
getNextSibling in class NodeImpl
Returns:
the next sibling, as a Node, or null.

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()
Description copied from class: NodeImpl
Returns null, since NodeImpls do not belong to any Document.

Specified by:
getOwnerDocument in interface org.w3c.dom.Node
Overrides:
getOwnerDocument in class NodeImpl
Returns:
document owner as Document.

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
Description copied from class: NodeImpl
Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.

Specified by:
insertBefore in interface org.w3c.dom.Node
Overrides:
insertBefore in class NodeImpl
Parameters:
newChild - the Node to insert.
refChild - the reference Node.
Returns:
the node being inserted.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
Description copied from class: NodeImpl
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

Specified by:
replaceChild in interface org.w3c.dom.Node
Overrides:
replaceChild in class NodeImpl
Parameters:
newChild - the Node to insert.
oldChild - the Node to be replaced.
Returns:
the node replaced.

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
Description copied from class: NodeImpl
Removes the child node indicated by oldChild from the list of children, and returns it.

Specified by:
removeChild in interface org.w3c.dom.Node
Overrides:
removeChild in class NodeImpl
Parameters:
oldChild - the Node to be removed.
Returns:
the node removed.

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
Description copied from class: NodeImpl
Adds the node newChild to the end of the list of children of this node.

Specified by:
appendChild in interface org.w3c.dom.Node
Overrides:
appendChild in class NodeImpl
Parameters:
newChild - the Node to insert.
Returns:
the node added.

hasChildNodes

public boolean hasChildNodes()
Description copied from class: NodeImpl
Returns true if this node has child nodes.

Specified by:
hasChildNodes in interface org.w3c.dom.Node
Overrides:
hasChildNodes in class NodeImpl
Returns:
true if this node has children.

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)
Description copied from class: NodeImpl
Returns a duplicate of this node. The duplicate node has no parent (getParentNode returns null). If a shallow clone is being performed (deep is false), the new node will not have any children or siblings. If a deep clone is being performed, the new node will form the root of a complete cloned subtree.

Specified by:
cloneNode in interface org.w3c.dom.Node
Overrides:
cloneNode in class NodeImpl
Parameters:
deep - if true, recursively clone the subtree under the specified node; if false, clone only the node itself.
Returns:
the duplicate node.

normalize

public void normalize()
Description copied from class: NodeImpl
Does nothing, since NodeImpls do not contain Text children.

Specified by:
normalize in interface org.w3c.dom.Node
Overrides:
normalize in class NodeImpl

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
Description copied from class: NodeImpl
Returns false since DOM features are not supported.

Specified by:
isSupported in interface org.w3c.dom.Node
Overrides:
isSupported in class NodeImpl
Parameters:
feature - a String, which is ignored.
version - a String, which is ignored.
Returns:
false.

getNamespaceURI

public java.lang.String getNamespaceURI()
                                 throws org.w3c.dom.DOMException
Specified by:
getNamespaceURI in interface org.w3c.dom.Node
Overrides:
getNamespaceURI in class NodeImpl
Returns:
null, since namespaces are not supported.
Throws:
org.w3c.dom.DOMException

getPrefix

public java.lang.String getPrefix()
Description copied from class: NodeImpl
Returns null, since namespaces are not supported.

Specified by:
getPrefix in interface org.w3c.dom.Node
Overrides:
getPrefix in class NodeImpl
Returns:
null.
See Also:
NodeImpl.setPrefix(java.lang.String)

setPrefix

public void setPrefix(java.lang.String prefix)
Description copied from class: NodeImpl
Does nothing, since namespaces are not supported.

Specified by:
setPrefix in interface org.w3c.dom.Node
Overrides:
setPrefix in class NodeImpl
Parameters:
prefix - a String, which is ignored.
See Also:
NodeImpl.getPrefix()

getLocalName

public java.lang.String getLocalName()
Description copied from class: NodeImpl
Equivalent to getNodeName.

Specified by:
getLocalName in interface org.w3c.dom.Node
Overrides:
getLocalName in class NodeImpl
Returns:
the node name, as a String.

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Description copied from class: NodeImpl
Returns all attribute nodes of this node.

Specified by:
getAttributes in interface org.w3c.dom.Node
Overrides:
getAttributes in class NodeImpl
Returns:
all attribute nodes of this node.

hasAttributes

public boolean hasAttributes()
Description copied from class: NodeImpl
Returns true, if this node has attributes, otherwise false.

Specified by:
hasAttributes in interface org.w3c.dom.Node
Overrides:
hasAttributes in class NodeImpl
Returns:
true if node has attributes, otherwise false..

getLength

public int getLength()
Description copied from class: NodeImpl
Returns number of child nodes.

Specified by:
getLength in interface org.w3c.dom.NodeList
Overrides:
getLength in class NodeImpl
Returns:
all number of child nodes.

item

public org.w3c.dom.Node item(int index)
Description copied from class: NodeImpl
Returns child node with the given index.

Specified by:
item in interface org.w3c.dom.NodeList
Overrides:
item in class NodeImpl
Parameters:
index - represents index
Returns:
child node with the given index.

toString

public java.lang.String toString()
Description copied from class: NodeImpl
Returns String representation of this node.

Overrides:
toString in class NodeImpl
Returns:
String representation of this node.

toString

public java.lang.String toString(java.lang.String tab)
Description copied from class: NodeImpl
Returns String representation of this node.

Overrides:
toString in class NodeImpl
Parameters:
tab - tab for node indentation.
Returns:
String representation of this node.

beginToString

protected void beginToString(java.lang.StringBuffer sb,
                             Indent indent)
Description copied from class: NodeImpl
Method beginToString should be redefined in extended classes. Each type of node has its own beginToString and endToString. This was added to support writing of the xml file. The Element type of node: it writes the beginning tag, then calls the child's toString, and then writes the ending tag.

Overrides:
beginToString in class NodeImpl
Parameters:
sb - string buffer to add resulting string.
indent - used in formating the output.

endToString

protected void endToString(java.lang.StringBuffer sb,
                           Indent indent)
Description copied from class: NodeImpl
Method endToString should be redefined in extended classes. Each type of node has its own beginToString and endToString. This was added to support writing of the xml file. The Element type of node: it writes the beginning tag, then calls the child's toString, and then writes the ending tag.

Overrides:
endToString in class NodeImpl
Parameters:
sb - string buffer to add resulting string.
indent - used in formating the output.

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException
Overrides:
compareDocumentPosition in class NodeImpl
Throws:
org.w3c.dom.DOMException

getBaseURI

public java.lang.String getBaseURI()
Overrides:
getBaseURI in class NodeImpl

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)
Overrides:
getFeature in class NodeImpl

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException
Overrides:
getTextContent in class NodeImpl
Throws:
org.w3c.dom.DOMException

getUserData

public java.lang.Object getUserData(java.lang.String key)
Overrides:
getUserData in class NodeImpl

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)
Overrides:
isDefaultNamespace in class NodeImpl

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg)
Overrides:
isEqualNode in class NodeImpl

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)
Overrides:
isSameNode in class NodeImpl

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Overrides:
lookupNamespaceURI in class NodeImpl

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)
Overrides:
lookupPrefix in class NodeImpl

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException
Overrides:
setTextContent in class NodeImpl
Throws:
org.w3c.dom.DOMException

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    UserDataHandler handler)
Overrides:
setUserData in class NodeImpl


Copyright © 2002-2007 Together - the Workgroup. All Rights Reserved.