Xalan: Class ResultTreeFrag

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.xalan.xslt
Class ResultTreeFrag

java.lang.Object
  |
  +--org.apache.xalan.xslt.ResultTreeFrag

public class ResultTreeFrag
extends java.lang.Object
implements org.w3c.dom.DocumentFragment

**For internal use only** Container of a result tree fragment.

Constructor Summary
`ResultTreeFrag(org.w3c.dom.Document docFactory, MutableNodeList children, XPathSupport support)` For internal use only
`ResultTreeFrag(org.w3c.dom.Document docFactory, XPathSupport support)` For internal use only

Method Summary
`org.w3c.dom.Node`	`appendChild(org.w3c.dom.Node newChild)` For internal use only Adds the node `newChild` to the end of the list of children of this node.
`org.w3c.dom.Node`	`cloneNode(boolean deep)` For internal use only Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
`org.w3c.dom.NamedNodeMap`	`getAttributes()` For internal use only A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise.
`org.w3c.dom.NodeList`	`getChildNodes()` For internal use only A `NodeList` that contains all children of this node.
`org.w3c.dom.Node`	`getFirstChild()` For internal use only The first child of this node.
`org.w3c.dom.Node`	`getLastChild()` For internal use only The last child of this node.
`java.lang.String`	`getLocalName()` For internal use only Unimplemented.
`java.lang.String`	`getNamespaceURI()` For internal use only Unimplemented.
`org.w3c.dom.Node`	`getNextSibling()` For internal use only The node immediately following this node.
`java.lang.String`	`getNodeName()` For internal use only The name of this node, depending on its type; see the table above.
`short`	`getNodeType()` For internal use only A code representing the type of the underlying object, as defined above.
`java.lang.String`	`getNodeValue()` For internal use only The value of this node, depending on its type; see the table above.
`org.w3c.dom.Document`	`getOwnerDocument()` For internal use only The `Document` object associated with this node.
`org.w3c.dom.Node`	`getParentNode()` For internal use only The parent of this node.
`java.lang.String`	`getPrefix()` For internal use only Unimplemented.
`org.w3c.dom.Node`	`getPreviousSibling()` For internal use only The node immediately preceding this node.
`boolean`	`hasChildNodes()` For internal use only This is a convenience method to allow easy determination of whether a node has any children.
`org.w3c.dom.Node`	`insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)` For internal use only Inserts the node `newChild` before the existing child node `refChild`.
`void`	`normalize()` For internal use only Unimplemented.
`org.w3c.dom.Node`	`removeChild(org.w3c.dom.Node oldChild)` For internal use only 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)` For internal use only Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.
`void`	`setNodeValue(java.lang.String x)` For internal use only DocumentFragments never have a nodeValue.
`void`	`setPrefix(java.lang.String prefix)` For internal use only Unimplemented.
`boolean`	`supports(java.lang.String feature, java.lang.String version)` For internal use only Unimplemented.

Methods inherited from class java.lang.Object

equals, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Constructor Detail

ResultTreeFrag

public ResultTreeFrag(org.w3c.dom.Document docFactory,
                      XPathSupport support)

ResultTreeFrag

public ResultTreeFrag(org.w3c.dom.Document docFactory,
                      MutableNodeList children,
                      XPathSupport support)

Method Detail

getNodeName

public final java.lang.String getNodeName()

**For internal use only** The name of this node, depending on its type; see the table above.

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

**For internal use only** The value of this node, depending on its type; see the table above.

Throws:: org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.; org.w3c.dom.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 x)
                  throws org.w3c.dom.DOMException

**For internal use only** DocumentFragments never have a nodeValue.

Throws:: DOMException(NO_MODIFICATION_ALLOWED_ERR) -

getNodeType

public final short getNodeType()

**For internal use only** A code representing the type of the underlying object, as defined above.

getParentNode

public org.w3c.dom.Node getParentNode()

**For internal use only** The parent of this node. All nodes, except Document, DocumentFragment, and Attr 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.

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

**For internal use only** A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

getFirstChild

public org.w3c.dom.Node getFirstChild()

**For internal use only** The first child of this node. If there is no such node, this returns null.

getLastChild

public org.w3c.dom.Node getLastChild()

**For internal use only** The last child of this node. If there is no such node, this returns null.

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

**For internal use only** The node immediately preceding this node. If there is no such node, this returns null.

getNextSibling

public org.w3c.dom.Node getNextSibling()

**For internal use only** The node immediately following this node. If there is no such node, this returns null.

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

**For internal use only** A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

**For internal use only** The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document this is null.

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException

**For internal use only** 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.

Parameters:: newChild - The node to insert.; refChild - The reference node, i.e., the node before which the new node must be inserted.
Returns:: The node being inserted.
Throws:: org.w3c.dom.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.
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.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
                              throws org.w3c.dom.DOMException

**For internal use only** Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If the newChild is already in the tree, it is first removed.

Parameters:: newChild - The new node to put in the child list.; oldChild - The node being replaced in the list.
Returns:: The node replaced.
Throws:: org.w3c.dom.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 it the node to put in is one of this node's ancestors.
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.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException

**For internal use only** Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters:: oldChild - The node being removed.
Returns:: The node removed.
Throws:: org.w3c.dom.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 org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException

**For internal use only** 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.

Parameters:: newChild - The 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:: org.w3c.dom.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.
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.

hasChildNodes

public boolean hasChildNodes()

**For internal use only** This is a convenience method to allow easy determination of whether a node has any children.

Returns:: true if the node has any children, false if the node has no children.

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

**For internal use only** Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode returns 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 any other type of node simply returns a copy of this node.

Parameters:: deep - If 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.