Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> xmlbeans >> impl >> [ store overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.xmlbeans.impl.store.DomImpl JAVADOC | Sourc code of org.apache.xmlbeans.impl.store.DomImpl SOURCE | Download org.apache.xmlbeans.impl.store.DomImpl DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.xmlbeans.impl.store
Class DomImpl.SaajTextNode  view DomImpl.SaajTextNode download DomImpl.SaajTextNode.java

java.lang.Object
  extended byorg.apache.xmlbeans.impl.store.DomImpl.CharNode
      extended byorg.apache.xmlbeans.impl.store.DomImpl.TextNode
          extended byorg.apache.xmlbeans.impl.store.DomImpl.SaajTextNode
All Implemented Interfaces:
org.w3c.dom.CharacterData, DomImpl.Dom, org.apache.xmlbeans.impl.soap.Node, org.w3c.dom.Node, org.w3c.dom.Text, org.apache.xmlbeans.impl.soap.Text
Enclosing class:
DomImpl
static class DomImpl.SaajTextNode
extends DomImpl.TextNode
implements org.apache.xmlbeans.impl.soap.Text

Field Summary
(package private)  int _cch
           
(package private)  DomImpl.CharNode _next
           
(package private)  int _off
           
(package private)  DomImpl.CharNode _prev
           
 
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
(package private) DomImpl.SaajTextNode(Locale l)
           
 
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.
 void appendData(java.lang.String arg)
          Append the string to the end of the character data of the node.
static DomImpl.CharNode appendNode(DomImpl.CharNode nodes, DomImpl.CharNode newNode)
           
static DomImpl.CharNode appendNodes(DomImpl.CharNode nodes, DomImpl.CharNode newNodes)
           
 org.w3c.dom.Node cloneNode(boolean deep)
          Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
 short compareDocumentPosition(org.w3c.dom.Node other)
          Compares the reference node, i.e.
static DomImpl.CharNode copyNodes(DomImpl.CharNode nodes, java.lang.Object newSrc)
           
 void deleteData(int offset, int count)
          Remove a range of 16-bit units from the node.
 void detachNode()
          Removes this Node object from the tree.
 void dump()
           
 void dump(java.io.PrintStream o)
           
 void dump(java.io.PrintStream o, java.lang.Object ref)
           
 org.w3c.dom.NamedNodeMap getAttributes()
          A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 java.lang.String getBaseURI()
          The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
 org.w3c.dom.NodeList getChildNodes()
          A NodeList that contains all children of this node.
 java.lang.String getData()
          The character data of the node that implements this interface.
 DomImpl.Dom getDom()
           
 java.lang.Object getFeature(java.lang.String feature, java.lang.String version)
          This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .
 org.w3c.dom.Node getFirstChild()
          The first child of this node.
 org.w3c.dom.Node getLastChild()
          The last child of this node.
 int getLength()
          The number of 16-bit units that are available through data and the substringData method below.
 java.lang.String getLocalName()
          Returns the local part of the qualified name of this node.
 java.lang.String getNamespaceURI()
          The namespace URI of this node, or null if it is unspecified (see ).
 org.w3c.dom.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.
 org.w3c.dom.Document getOwnerDocument()
          The Document object associated with this node.
 org.apache.xmlbeans.impl.soap.SOAPElement getParentElement()
          Returns the parent element of this Node object.
 org.w3c.dom.Node getParentNode()
          The parent of this node.
 java.lang.String getPrefix()
          The namespace prefix of this node, or null if it is unspecified.
 org.w3c.dom.Node getPreviousSibling()
          The node immediately preceding this node.
 javax.xml.namespace.QName getQName()
           
 java.lang.String getTextContent()
          This attribute returns the text content of this node and its descendants.
 java.lang.Object getUserData(java.lang.String key)
          Retrieves the object associated to a key on a this node.
 java.lang.String getValue()
          Returns the the value of the immediate child of this Node object if a child exists and its value is text.
 java.lang.String getWholeText()
          Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
 boolean hasAttributes()
          Returns whether this node (if it is an element) has any attributes.
 boolean hasChildNodes()
          Returns whether this node has any children.
 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.
 void insertData(int offset, java.lang.String arg)
          Insert a string at the specified 16-bit unit offset.
static DomImpl.CharNode insertNode(DomImpl.CharNode nodes, DomImpl.CharNode newNode, DomImpl.CharNode before)
           
 boolean isComment()
          Retrieves whether this Text object represents a comment.
 boolean isDefaultNamespace(java.lang.String namespaceURI)
          This method checks if the specified namespaceURI is the default namespace or not.
 boolean isElementContentWhitespace()
          Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
 boolean isEqualNode(org.w3c.dom.Node arg)
          Tests whether two nodes are equal.
static boolean isOnList(DomImpl.CharNode nodes, DomImpl.CharNode node)
           
 boolean isSameNode(org.w3c.dom.Node arg)
          Returns whether this node is the same node as the given one.
 boolean isSupported(java.lang.String feature, java.lang.String version)
          Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .
 Locale locale()
           
 java.lang.String lookupNamespaceURI(java.lang.String prefix)
          Look up the namespace URI associated to the given prefix, starting from this node.
 java.lang.String lookupPrefix(java.lang.String namespaceURI)
          Look up the prefix associated to the given namespace URI, starting from this node.
 java.lang.String name()
           
 boolean nodeCanHavePrefixUri()
           
 int nodeType()
           
 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 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.
 void recycleNode()
          Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.
static DomImpl.CharNode remove(DomImpl.CharNode nodes, DomImpl.CharNode node)
           
 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 replaceData(int offset, int count, java.lang.String arg)
          Replace the characters starting at the specified 16-bit unit offset with the specified string.
 org.w3c.dom.Text replaceWholeText(java.lang.String content)
          Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
 void setChars(java.lang.Object src, int off, int cch)
           
 void setData(java.lang.String data)
          The character data of the node that implements this interface.
 void setDom(DomImpl.Dom d)
           
 void setNodeValue(java.lang.String nodeValue)
          The value of this node, depending on its type; see the table above.
 void setParentElement(org.apache.xmlbeans.impl.soap.SOAPElement p)
          Sets the parent of this Node object to the given SOAPElement object.
 void setPrefix(java.lang.String prefix)
          The namespace prefix of this node, or null if it is unspecified.
 void setTextContent(java.lang.String textContent)
          This attribute returns the text content of this node and its descendants.
 java.lang.Object setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
          Associate an object to a key on this node.
 void setValue(java.lang.String value)
          If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node.
 org.w3c.dom.Text splitText(int offset)
          Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
 java.lang.String substringData(int offset, int count)
          Extracts a range of data from the node.
 Cur tempCur()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
 
Methods inherited from interface org.w3c.dom.Text
getWholeText, isElementContentWhitespace, replaceWholeText, splitText
 
Methods inherited from interface org.w3c.dom.CharacterData
appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData
 

Field Detail

_next

DomImpl.CharNode _next

_prev

DomImpl.CharNode _prev

_off

int _off

_cch

int _cch
Constructor Detail

DomImpl.SaajTextNode

DomImpl.SaajTextNode(Locale l)
Method Detail

isComment

public boolean isComment()
Description copied from interface: org.apache.xmlbeans.impl.soap.Text
Retrieves whether this Text object represents a comment.

Specified by:
isComment in interface org.apache.xmlbeans.impl.soap.Text

detachNode

public void detachNode()
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.

Specified by:
detachNode in interface org.apache.xmlbeans.impl.soap.Node

recycleNode

public void recycleNode()
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.

Calling the method recycleNode implies that the method detachNode has been called previously.

Specified by:
recycleNode in interface org.apache.xmlbeans.impl.soap.Node

getValue

public java.lang.String getValue()
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
Returns the the value of the immediate child of this Node object if a child exists and its value is text.

Specified by:
getValue in interface org.apache.xmlbeans.impl.soap.Node

setValue

public void setValue(java.lang.String value)
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.

Specified by:
setValue in interface org.apache.xmlbeans.impl.soap.Node

getParentElement

public org.apache.xmlbeans.impl.soap.SOAPElement getParentElement()
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
Returns the parent element of this Node object. This method can throw an UnsupportedOperationException if the tree is not kept in memory.

Specified by:
getParentElement in interface org.apache.xmlbeans.impl.soap.Node

setParentElement

public void setParentElement(org.apache.xmlbeans.impl.soap.SOAPElement p)
Description copied from interface: org.apache.xmlbeans.impl.soap.Node
Sets the parent of this Node object to the given SOAPElement object.

Specified by:
setParentElement in interface org.apache.xmlbeans.impl.soap.Node

nodeType

public int nodeType()
Specified by:
nodeType in interface DomImpl.Dom

name

public java.lang.String name()

splitText

public org.w3c.dom.Text splitText(int offset)
Description copied from interface: org.w3c.dom.Text
Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Specified by:
splitText in interface org.w3c.dom.Text

getWholeText

public java.lang.String getWholeText()
Description copied from interface: org.w3c.dom.Text
Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".

Specified by:
getWholeText in interface org.w3c.dom.Text

isElementContentWhitespace

public boolean isElementContentWhitespace()
Description copied from interface: org.w3c.dom.Text
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using Document.normalizeDocument().

Specified by:
isElementContentWhitespace in interface org.w3c.dom.Text

replaceWholeText

public org.w3c.dom.Text replaceWholeText(java.lang.String content)
Description copied from interface: org.w3c.dom.Text
Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.
This method returns the node which received the replacement text. The returned node is:
  • null, when the replacement text is the empty string;
  • the current node, except when the current node is read-only;
  • a new Text node of the same type ( Text or CDATASection) as the current node inserted at the location of the replacement.

For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.

Specified by:
replaceWholeText in interface org.w3c.dom.Text

getQName

public javax.xml.namespace.QName getQName()
Specified by:
getQName in interface DomImpl.Dom

locale

public Locale locale()
Specified by:
locale in interface DomImpl.Dom

setChars

public void setChars(java.lang.Object src,
                     int off,
                     int cch)

getDom

public DomImpl.Dom getDom()

setDom

public void setDom(DomImpl.Dom d)

tempCur

public Cur tempCur()
Specified by:
tempCur in interface DomImpl.Dom

isOnList

public static boolean isOnList(DomImpl.CharNode nodes,
                               DomImpl.CharNode node)

remove

public static DomImpl.CharNode remove(DomImpl.CharNode nodes,
                                      DomImpl.CharNode node)

insertNode

public static DomImpl.CharNode insertNode(DomImpl.CharNode nodes,
                                          DomImpl.CharNode newNode,
                                          DomImpl.CharNode before)

appendNode

public static DomImpl.CharNode appendNode(DomImpl.CharNode nodes,
                                          DomImpl.CharNode newNode)

appendNodes

public static DomImpl.CharNode appendNodes(DomImpl.CharNode nodes,
                                           DomImpl.CharNode newNodes)

copyNodes

public static DomImpl.CharNode copyNodes(DomImpl.CharNode nodes,
                                         java.lang.Object newSrc)

nodeCanHavePrefixUri

public boolean nodeCanHavePrefixUri()
Specified by:
nodeCanHavePrefixUri in interface DomImpl.Dom

dump

public void dump(java.io.PrintStream o,
                 java.lang.Object ref)
Specified by:
dump in interface DomImpl.Dom

dump

public void dump(java.io.PrintStream o)
Specified by:
dump in interface DomImpl.Dom

dump

public void dump()
Specified by:
dump in interface DomImpl.Dom

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
Description copied from interface: org.w3c.dom.Node
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 org.w3c.dom.Node

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)
Description copied from interface: org.w3c.dom.Node
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) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
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 children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. 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 org.w3c.dom.Node

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Description copied from interface: org.w3c.dom.Node
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Specified by:
getAttributes in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()
Description copied from interface: org.w3c.dom.Node
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 org.w3c.dom.Node

getParentNode

public org.w3c.dom.Node getParentNode()
Description copied from interface: org.w3c.dom.Node
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 org.w3c.dom.Node

removeChild

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

Specified by:
removeChild in interface org.w3c.dom.Node

getFirstChild

public org.w3c.dom.Node getFirstChild()
Description copied from interface: org.w3c.dom.Node
The first child of this node. If there is no such node, this returns null.

Specified by:
getFirstChild in interface org.w3c.dom.Node

getLastChild

public org.w3c.dom.Node getLastChild()
Description copied from interface: org.w3c.dom.Node
The last child of this node. If there is no such node, this returns null.

Specified by:
getLastChild in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()
Description copied from interface: org.w3c.dom.Node
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 Document.createElement(), this is always null.

Specified by:
getLocalName in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from interface: org.w3c.dom.Node
The namespace URI of this node, or null if it is unspecified (see ).
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 Document.createElement(), this is always null.

Note: Per the Namespaces in XML Specification [XML Namespaces] 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 org.w3c.dom.Node

getNextSibling

public org.w3c.dom.Node getNextSibling()
Description copied from interface: org.w3c.dom.Node
The node immediately following this node. If there is no such node, this returns null.

Specified by:
getNextSibling in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()
Description copied from interface: org.w3c.dom.Node
The name of this node, depending on its type; see the table above.

Specified by:
getNodeName in interface org.w3c.dom.Node

getNodeType

public short getNodeType()
Description copied from interface: org.w3c.dom.Node
A code representing the type of the underlying object, as defined above.

Specified by:
getNodeType in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
Description copied from interface: org.w3c.dom.Node
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, including if the node is read-only.

Specified by:
getNodeValue in interface org.w3c.dom.Node

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()
Description copied from interface: org.w3c.dom.Node
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 org.w3c.dom.Node

getPrefix

public java.lang.String getPrefix()
Description copied from interface: org.w3c.dom.Node
The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
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.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
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 org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()
Description copied from interface: org.w3c.dom.Node
The node immediately preceding this node. If there is no such node, this returns null.

Specified by:
getPreviousSibling in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()
Description copied from interface: org.w3c.dom.Node
Returns whether this node (if it is an element) has any attributes.

Specified by:
hasAttributes in interface org.w3c.dom.Node

hasChildNodes

public boolean hasChildNodes()
Description copied from interface: org.w3c.dom.Node
Returns whether this node has any children.

Specified by:
hasChildNodes in interface org.w3c.dom.Node

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
Description copied from interface: org.w3c.dom.Node
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.

Note: Inserting a node before itself is implementation dependent.

Specified by:
insertBefore in interface org.w3c.dom.Node

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
Description copied from interface: org.w3c.dom.Node
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .

Specified by:
isSupported in interface org.w3c.dom.Node

normalize

public void normalize()
Description copied from interface: org.w3c.dom.Node
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 [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.

Note: 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 org.w3c.dom.Node

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
Description copied from interface: org.w3c.dom.Node
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.

Note: Replacing a node with itself is implementation dependent.

Specified by:
replaceChild in interface org.w3c.dom.Node

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
Description copied from interface: org.w3c.dom.Node
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, including if the node is read-only.

Specified by:
setNodeValue in interface org.w3c.dom.Node

setPrefix

public void setPrefix(java.lang.String prefix)
Description copied from interface: org.w3c.dom.Node
The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only.
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.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
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:
setPrefix in interface org.w3c.dom.Node

getUserData

public java.lang.Object getUserData(java.lang.String key)
Description copied from interface: org.w3c.dom.Node
Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.

Specified by:
getUserData in interface org.w3c.dom.Node

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)
Description copied from interface: org.w3c.dom.Node
Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.

Specified by:
setUserData in interface org.w3c.dom.Node

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)
Description copied from interface: org.w3c.dom.Node
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the Node interface.

Specified by:
getFeature in interface org.w3c.dom.Node

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node arg)
Description copied from interface: org.w3c.dom.Node
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:
  • The two nodes are of the same type.
  • The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
  • The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
  • The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:
  • The following string attributes are equal: publicId, systemId, internalSubset.
  • The entities NamedNodeMaps are equal.
  • The notations NamedNodeMaps are equal.

On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the Text.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.

Specified by:
isEqualNode in interface org.w3c.dom.Node

isSameNode

public boolean isSameNode(org.w3c.dom.Node arg)
Description copied from interface: org.w3c.dom.Node
Returns whether this node is the same node as the given one.
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

Specified by:
isSameNode in interface org.w3c.dom.Node

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)
Description copied from interface: org.w3c.dom.Node
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.

Specified by:
lookupNamespaceURI in interface org.w3c.dom.Node

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)
Description copied from interface: org.w3c.dom.Node
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.

Specified by:
lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)
Description copied from interface: org.w3c.dom.Node
This method checks if the specified namespaceURI is the default namespace or not.

Specified by:
isDefaultNamespace in interface org.w3c.dom.Node

setTextContent

public void setTextContent(java.lang.String textContent)
Description copied from interface: org.w3c.dom.Node
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

Specified by:
setTextContent in interface org.w3c.dom.Node

getTextContent

public java.lang.String getTextContent()
Description copied from interface: org.w3c.dom.Node
This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

Specified by:
getTextContent in interface org.w3c.dom.Node

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
Description copied from interface: org.w3c.dom.Node
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.

Specified by:
compareDocumentPosition in interface org.w3c.dom.Node

getBaseURI

public java.lang.String getBaseURI()
Description copied from interface: org.w3c.dom.Node
The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when the Document supports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.

Specified by:
getBaseURI in interface org.w3c.dom.Node

appendData

public void appendData(java.lang.String arg)
Description copied from interface: org.w3c.dom.CharacterData
Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Specified by:
appendData in interface org.w3c.dom.CharacterData

deleteData

public void deleteData(int offset,
                       int count)
Description copied from interface: org.w3c.dom.CharacterData
Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Specified by:
deleteData in interface org.w3c.dom.CharacterData

getData

public java.lang.String getData()
Description copied from interface: org.w3c.dom.CharacterData
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Specified by:
getData in interface org.w3c.dom.CharacterData

getLength

public int getLength()
Description copied from interface: org.w3c.dom.CharacterData
The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Specified by:
getLength in interface org.w3c.dom.CharacterData

insertData

public void insertData(int offset,
                       java.lang.String arg)
Description copied from interface: org.w3c.dom.CharacterData
Insert a string at the specified 16-bit unit offset.

Specified by:
insertData in interface org.w3c.dom.CharacterData

replaceData

public void replaceData(int offset,
                        int count,
                        java.lang.String arg)
Description copied from interface: org.w3c.dom.CharacterData
Replace the characters starting at the specified 16-bit unit offset with the specified string.

Specified by:
replaceData in interface org.w3c.dom.CharacterData

setData

public void setData(java.lang.String data)
Description copied from interface: org.w3c.dom.CharacterData
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Specified by:
setData in interface org.w3c.dom.CharacterData

substringData

public java.lang.String substringData(int offset,
                                      int count)
Description copied from interface: org.w3c.dom.CharacterData
Extracts a range of data from the node.

Specified by:
substringData in interface org.w3c.dom.CharacterData
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> xmlbeans >> impl >> [ store overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.xmlbeans.impl.store.DomImpl JAVADOC | Sourc code of org.apache.xmlbeans.impl.store.DomImpl SOURCE | Download org.apache.xmlbeans.impl.store.DomImpl DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD