org.basex.api.dom
Class BXNode

java.lang.Object
  extended by org.basex.api.dom.BXNode
All Implemented Interfaces:
org.w3c.dom.Node
Direct Known Subclasses:
BXAttr, BXComm, BXDoc, BXDocFrag, BXElem, BXPI, BXText

public abstract class BXNode
extends java.lang.Object
implements org.w3c.dom.Node

DOM - Node implementation.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary
protected  ANode node
          Node reference.
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
protected BXNode(ANode n)
          Constructor.
 
Method Summary
 BXNode appendChild(org.w3c.dom.Node newChild)
           
 BXNode cloneNode(boolean deep)
           
 short compareDocumentPosition(org.w3c.dom.Node other)
           
protected static ANodeList finish(AxisIter ai)
          Returns a node cache with the specified nodes.
static BXNode get(ANode node)
          Creates a new DOM node instance for the input node.
 BXNNode getAttributes()
           
 java.lang.String getBaseURI()
           
 org.basex.api.dom.BXNList getChildNodes()
           
protected  org.basex.api.dom.BXNList getElements(java.lang.String tag)
          Returns all nodes with the given tag name.
 java.lang.Object getFeature(java.lang.String feature, java.lang.String version)
           
 BXNode getFirstChild()
           
 BXNode getLastChild()
           
 java.lang.String getLocalName()
           
 java.lang.String getNamespaceURI()
           
 BXNode getNextSibling()
           
 ANode getNode()
          Returns the internal node representation.
 java.lang.String getNodeName()
           
 short getNodeType()
           
 java.lang.String getNodeValue()
           
 BXDoc getOwnerDocument()
           
 BXNode getParentNode()
           
 java.lang.String getPrefix()
           
 BXNode getPreviousSibling()
           
 java.lang.String getTextContent()
           
 java.lang.Object getUserData(java.lang.String key)
           
 boolean hasAttributes()
           
 boolean hasChildNodes()
           
 BXNode insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
           
 boolean isDefaultNamespace(java.lang.String namespaceURI)
           
 boolean isEqualNode(org.w3c.dom.Node cmp)
           
 boolean isSameNode(org.w3c.dom.Node other)
           
 boolean isSupported(java.lang.String feature, java.lang.String version)
           
protected  int kind()
          Returns a numeric value for the node kind.
 java.lang.String lookupNamespaceURI(java.lang.String prefix)
           
 java.lang.String lookupPrefix(java.lang.String namespaceURI)
           
 void normalize()
           
protected static org.w3c.dom.DOMException readOnly()
          Throws a DOM modification exception.
 BXNode removeChild(org.w3c.dom.Node oldChild)
           
 BXNode replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
           
 void setNodeValue(java.lang.String nodeValue)
           
 void setPrefix(java.lang.String prefix)
           
 void setTextContent(java.lang.String textContent)
           
 java.lang.Object setUserData(java.lang.String key, java.lang.Object dat, org.w3c.dom.UserDataHandler handler)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

node

protected final ANode node
Node reference.

Constructor Detail

BXNode

protected BXNode(ANode n)
Constructor.

Parameters:
n - node reference
Method Detail

get

public static final BXNode get(ANode node)
Creates a new DOM node instance for the input node. Returns a null reference if the input is also null.

Parameters:
node - input node
Returns:
DOM node

getNodeName

public java.lang.String getNodeName()
Specified by:
getNodeName in interface org.w3c.dom.Node

getNodeType

public final short getNodeType()
Specified by:
getNodeType in interface org.w3c.dom.Node

kind

protected int kind()
Returns a numeric value for the node kind.

Returns:
node kind

getNodeValue

public java.lang.String getNodeValue()
Specified by:
getNodeValue in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()
Specified by:
getLocalName in interface org.w3c.dom.Node

cloneNode

public final BXNode cloneNode(boolean deep)
Specified by:
cloneNode in interface org.w3c.dom.Node

compareDocumentPosition

public final short compareDocumentPosition(org.w3c.dom.Node other)
Specified by:
compareDocumentPosition in interface org.w3c.dom.Node

getAttributes

public BXNNode getAttributes()
Specified by:
getAttributes in interface org.w3c.dom.Node

getBaseURI

public final java.lang.String getBaseURI()
Specified by:
getBaseURI in interface org.w3c.dom.Node

getChildNodes

public org.basex.api.dom.BXNList getChildNodes()
Specified by:
getChildNodes in interface org.w3c.dom.Node

getFirstChild

public BXNode getFirstChild()
Specified by:
getFirstChild in interface org.w3c.dom.Node

getLastChild

public final BXNode getLastChild()
Specified by:
getLastChild in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()
Specified by:
getNamespaceURI in interface org.w3c.dom.Node

getNextSibling

public BXNode getNextSibling()
Specified by:
getNextSibling in interface org.w3c.dom.Node

getPreviousSibling

public BXNode getPreviousSibling()
Specified by:
getPreviousSibling in interface org.w3c.dom.Node

getParentNode

public final BXNode getParentNode()
Specified by:
getParentNode in interface org.w3c.dom.Node

hasChildNodes

public final boolean hasChildNodes()
Specified by:
hasChildNodes in interface org.w3c.dom.Node

isSameNode

public final boolean isSameNode(org.w3c.dom.Node other)
Specified by:
isSameNode in interface org.w3c.dom.Node

getOwnerDocument

public BXDoc getOwnerDocument()
Specified by:
getOwnerDocument in interface org.w3c.dom.Node

hasAttributes

public final boolean hasAttributes()
Specified by:
hasAttributes in interface org.w3c.dom.Node

getFeature

public final java.lang.Object getFeature(java.lang.String feature,
                                         java.lang.String version)
Specified by:
getFeature in interface org.w3c.dom.Node

getPrefix

public final java.lang.String getPrefix()
Specified by:
getPrefix in interface org.w3c.dom.Node

getTextContent

public final java.lang.String getTextContent()
Specified by:
getTextContent in interface org.w3c.dom.Node

appendChild

public final BXNode appendChild(org.w3c.dom.Node newChild)
Specified by:
appendChild in interface org.w3c.dom.Node

getUserData

public final java.lang.Object getUserData(java.lang.String key)
Specified by:
getUserData in interface org.w3c.dom.Node

isSupported

public final boolean isSupported(java.lang.String feature,
                                 java.lang.String version)
Specified by:
isSupported in interface org.w3c.dom.Node

insertBefore

public final BXNode insertBefore(org.w3c.dom.Node newChild,
                                 org.w3c.dom.Node refChild)
Specified by:
insertBefore in interface org.w3c.dom.Node

isDefaultNamespace

public final boolean isDefaultNamespace(java.lang.String namespaceURI)
Specified by:
isDefaultNamespace in interface org.w3c.dom.Node

isEqualNode

public final boolean isEqualNode(org.w3c.dom.Node cmp)
Specified by:
isEqualNode in interface org.w3c.dom.Node

lookupNamespaceURI

public final java.lang.String lookupNamespaceURI(java.lang.String prefix)
Specified by:
lookupNamespaceURI in interface org.w3c.dom.Node

lookupPrefix

public final java.lang.String lookupPrefix(java.lang.String namespaceURI)
Specified by:
lookupPrefix in interface org.w3c.dom.Node

normalize

public final void normalize()
Specified by:
normalize in interface org.w3c.dom.Node

removeChild

public final BXNode removeChild(org.w3c.dom.Node oldChild)
Specified by:
removeChild in interface org.w3c.dom.Node

replaceChild

public final BXNode replaceChild(org.w3c.dom.Node newChild,
                                 org.w3c.dom.Node oldChild)
Specified by:
replaceChild in interface org.w3c.dom.Node

setNodeValue

public final void setNodeValue(java.lang.String nodeValue)
Specified by:
setNodeValue in interface org.w3c.dom.Node

setPrefix

public final void setPrefix(java.lang.String prefix)
Specified by:
setPrefix in interface org.w3c.dom.Node

setTextContent

public final void setTextContent(java.lang.String textContent)
Specified by:
setTextContent in interface org.w3c.dom.Node

setUserData

public final java.lang.Object setUserData(java.lang.String key,
                                          java.lang.Object dat,
                                          org.w3c.dom.UserDataHandler handler)
Specified by:
setUserData in interface org.w3c.dom.Node

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object

getElements

protected final org.basex.api.dom.BXNList getElements(java.lang.String tag)
Returns all nodes with the given tag name.

Parameters:
tag - tag name
Returns:
nodes

finish

protected static ANodeList finish(AxisIter ai)
Returns a node cache with the specified nodes.

Parameters:
ai - axis iterator
Returns:
node cache

getNode

public final ANode getNode()
Returns the internal node representation.

Returns:
xquery node

readOnly

protected static final org.w3c.dom.DOMException readOnly()
Throws a DOM modification exception.

Returns:
DOM exception