il.co.iter.dbdom
Class DBNode

java.lang.Object
  |
  +--il.co.iter.dbdom.DBNode
All Implemented Interfaces:
Node
Direct Known Subclasses:
DBAttr, DBCharacterData, DBDocument, DBDocumentType, DBElement, DBProcessingInstruction

public class DBNode
extends java.lang.Object
implements Node

The Node interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment ), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.

See also the Document Object Model (DOM) Level 2 Core Specification.


Field Summary
protected  java.sql.Connection con
           
protected  DBDOMImplementation dbDomImplementation
           
protected  long id
           
 
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
protected DBNode(DBDOMImplementation dbDomImplementation, long id)
          Constructs a client representation of a DBDOM Node.
 
Method Summary
 Node appendChild(Node newChild)
          Adds the node newChild to the end of the list of children of this node.
 Node cloneNode(boolean deep)
          Not Implemented Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
 NamedNodeMap getAttributes()
          A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 NodeList getChildNodes()
          Not Tested Not Implemnted A NodeList that contains all children of this node.
protected  DBDOMImplementation getDbDomImplementation()
          Non-DOM Returns the DBDOMImplementation that is responsible for this Node.
 Node getFirstChild()
          The first child of this node.
protected  long getId()
          Non-DOMReturns the database ID of this Node.
 Node getLastChild()
          The last child of this node.
 java.lang.String getLocalName()
          Not Implemented Returns the local part of the qualified name of this node.
 java.lang.String getNamespaceURI()
          Not Implemented The namespace URI of this node, or null if it is unspecified.
 Node getNextSibling()
          The node immediately following this node.
 java.lang.String getNodeName()
          The name of this node, depending on its type; see the table above.
 short getNodeType()
          A code representing the type of the underlying object, as defined above.
 java.lang.String getNodeValue()
          The value of this node, depending on its type; see the table above.
 Document getOwnerDocument()
          Not Tested The Document object associated with this node.
 Node getParentNode()
          The parent of this node.
 java.lang.String getPrefix()
          Not Implemented The namespace prefix of this node, or null if it is unspecified.
 Node getPreviousSibling()
          The node immediately preceding this node.
 boolean hasAttributes()
          Not Implemented Returns whether this node (if it is an element) has any attributes.
 boolean hasChildNodes()
          Returns whether this node has any children.
 Node insertBefore(Node newChild, Node refChild)
          Not Tested Inserts the node newChild before the existing child node refChild.
 boolean isSupported(java.lang.String feature, java.lang.String version)
          Not Implemented Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
 void normalize()
          Not Implemented 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.
 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)
          Not Tested Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
 void setNodeValue(java.lang.String nodeValue)
           
 void setPrefix(java.lang.String prefix)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dbDomImplementation

protected DBDOMImplementation dbDomImplementation

con

protected java.sql.Connection con

id

protected long id
Constructor Detail

DBNode

protected DBNode(DBDOMImplementation dbDomImplementation,
                 long id)
Constructs a client representation of a DBDOM Node.

Consider checking wheter or not this Node exists in the database and throwing an exception if it doesn't.

Disregard. Node existance is checked by a factory method in DBDOMImplementation.

Method Detail

getNodeName

public java.lang.String getNodeName()
The name of this node, depending on its type; see the table above.
Specified by:
getNodeName in interface Node

getNodeValue

public java.lang.String getNodeValue()
                              throws DOMException
The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.
Specified by:
getNodeValue in interface Node
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 a DOMString variable on the implementation platform.

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws DOMException
Specified by:
setNodeValue in interface Node

getNodeType

public short getNodeType()
A code representing the type of the underlying object, as defined above.
Specified by:
getNodeType in interface Node

getParentNode

public Node getParentNode()
The parent of this node. All nodes, except 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.
Specified by:
getParentNode in interface Node

getChildNodes

public NodeList getChildNodes()
Not Tested Not Implemnted A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
Specified by:
getChildNodes in interface Node

getFirstChild

public Node getFirstChild()
The first child of this node. If there is no such node, this returns null.
Specified by:
getFirstChild in interface Node

getLastChild

public Node getLastChild()
The last child of this node. If there is no such node, this returns null.
Specified by:
getLastChild in interface Node

getPreviousSibling

public Node getPreviousSibling()
The node immediately preceding this node. If there is no such node, this returns null.
Specified by:
getPreviousSibling in interface Node

getNextSibling

public Node getNextSibling()
The node immediately following this node. If there is no such node, this returns null.
Specified by:
getNextSibling in interface Node

getAttributes

public NamedNodeMap getAttributes()
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

This methid's implementation is untipical of this package. Unlike most methods, getAttributes() is overriden in DBElement.getAttributes(). Since only Elements can have Attrs, and it is unlikely that other types of Nodes ever will, it seemed pointless to access the database to do type checking.

In DBNode, this method always returns null.

Specified by:
getAttributes in interface Node
See Also:
DBElement.getAttributes()

getOwnerDocument

public Document getOwnerDocument()
Not Tested The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
Specified by:
getOwnerDocument in interface Node

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException
Not Tested Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If 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.
Specified by:
insertBefore in interface Node
Parameters:
newChildThe - node to insert.
refChildThe - reference node, i.e., 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 the newChild node, or if the node to insert is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException
Not Tested Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If 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.
Specified by:
replaceChild in interface Node
Parameters:
newChildThe - new node to put in the child list.
oldChildThe - 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 the newChild node, or if the node to put in is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException
Removes the child node indicated by oldChild from the list of children, and returns it.
Specified by:
removeChild in interface Node
Parameters:
oldChildThe - node being removed.
Returns:
The node removed.
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

appendChild

public Node appendChild(Node newChild)
                 throws DOMException
Adds the 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.
Specified by:
appendChild in interface Node
Parameters:
newChildThe - node to add.If it is a DocumentFragment object, 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 the newChild node, or if the node to append is one of this node's ancestors or this node itself.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.

hasChildNodes

public boolean hasChildNodes()
Returns whether this node has any children.
Specified by:
hasChildNodes in interface Node
Returns:
true if this node has any children, false otherwise.

cloneNode

public Node cloneNode(boolean deep)
Not Implemented Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; ( parentNode is null.).
Cloning an 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.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.
Specified by:
cloneNode in interface Node
Parameters:
deepIf - true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

normalize

public void normalize()
Not Implemented 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. 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.
Specified by:
normalize in interface Node

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
Not Implemented Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
Specified by:
isSupported in interface Node
Parameters:
featureThe - name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.
versionThis - is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
Returns:
Returns true if the specified feature is supported on this node, false otherwise.
Since:
DOM Level 2

getNamespaceURI

public java.lang.String getNamespaceURI()
Not Implemented The namespace URI of this node, or null if it is unspecified.
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.
Specified by:
getNamespaceURI in interface Node
Since:
DOM Level 2

getPrefix

public java.lang.String getPrefix()
Not Implemented The namespace prefix of this node, or null if it is unspecified.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
Specified by:
getPrefix in interface Node
Throws:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .
Since:
DOM Level 2

setPrefix

public void setPrefix(java.lang.String prefix)
               throws DOMException
Specified by:
setPrefix in interface Node

getLocalName

public java.lang.String getLocalName()
Not Implemented Returns the local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
Specified by:
getLocalName in interface Node
Since:
DOM Level 2

hasAttributes

public boolean hasAttributes()
Not Implemented Returns whether this node (if it is an element) has any attributes.
Specified by:
hasAttributes in interface Node
Returns:
true if this node has any attributes, false otherwise.
Since:
DOM Level 2

getId

protected long getId()
Non-DOMReturns the database ID of this Node.

Should never be used outside of this class.


getDbDomImplementation

protected DBDOMImplementation getDbDomImplementation()
Non-DOM Returns the DBDOMImplementation that is responsible for this Node.