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 >> xalan >> xsltc >> [ dom overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.xalan.xsltc.dom.SimpleResultTreeImpl JAVADOC | Sourc code of org.apache.xalan.xsltc.dom.SimpleResultTreeImpl SOURCE | Download org.apache.xalan.xsltc.dom.SimpleResultTreeImpl DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.xalan.xsltc.dom
Class SimpleResultTreeImpl  view SimpleResultTreeImpl download SimpleResultTreeImpl.java

java.lang.Object
  extended byorg.apache.xml.serializer.EmptySerializer
      extended byorg.apache.xalan.xsltc.dom.SimpleResultTreeImpl
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.ext.DeclHandler, org.apache.xalan.xsltc.DOM, org.apache.xml.serializer.DOMSerializer, org.apache.xml.dtm.DTM, org.xml.sax.ErrorHandler, org.apache.xml.serializer.ExtendedContentHandler, org.apache.xml.serializer.ExtendedLexicalHandler, org.xml.sax.ext.LexicalHandler, org.apache.xml.serializer.SerializationHandler, org.apache.xml.serializer.Serializer, org.apache.xml.serializer.XSLOutputAttributes
Direct Known Subclasses:
AdaptiveResultTreeImpl
public class SimpleResultTreeImpl
extends org.apache.xml.serializer.EmptySerializer
implements org.apache.xalan.xsltc.DOM, org.apache.xml.dtm.DTM

This class represents a light-weight DOM model for simple result tree fragment(RTF). A simple RTF is an RTF that has only one Text node. The Text node can be produced by a combination of Text, xsl:value-of and xsl:number instructions. It can also be produced by a control structure (xsl:if or xsl:choose) whose body is pure Text.

A SimpleResultTreeImpl has only two nodes, i.e. the ROOT node and its Text child. All DOM interfaces are overridden with this in mind. For example, the getStringValue() interface returns the value of the Text node. This class receives the character data from the characters() interface.

This class implements DOM and SerializationHandler. It also implements the DTM interface for support in MultiDOM. The nested iterators (SimpleIterator and SingletonIterator) are used to support the nodeset() extension function.

Nested Class Summary
 class SimpleResultTreeImpl.SimpleIterator
          The SimpleIterator is designed to support the nodeset() extension function.
 class SimpleResultTreeImpl.SingletonIterator
          The SingletonIterator is used for the self axis.
 
Field Summary
private  int _documentID
           
private static int _documentURIIndex
           
private  BitArray _dontEscape
           
protected  XSLTCDTMManager _dtmManager
           
private  boolean _escaping
           
protected  int _size
           
private  java.lang.String _text
           
protected  java.lang.String[] _textArray
           
private static org.apache.xml.dtm.DTMAxisIterator EMPTY_ITERATOR
           
private static java.lang.String EMPTY_STR
           
static int NUMBER_OF_NODES
           
static int RTF_ROOT
           
static int RTF_TEXT
           
 
Fields inherited from class org.apache.xml.serializer.EmptySerializer
ERR
 
Fields inherited from interface org.apache.xalan.xsltc.DOM
ADAPTIVE_RTF, FIRST_TYPE, NO_TYPE, NULL, RETURN_CURRENT, RETURN_PARENT, SIMPLE_RTF, TREE_RTF
 
Fields inherited from interface org.apache.xml.dtm.DTM
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NAMESPACE_NODE, NOTATION_NODE, NTYPES, NULL, PROCESSING_INSTRUCTION_NODE, ROOT_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS
 
Constructor Summary
SimpleResultTreeImpl(XSLTCDTMManager dtmManager, int documentID)
           
 
Method Summary
 void appendChild(int newChild, boolean clone, boolean cloneDepth)
          Append a child to "the end of the document".
 void appendTextChild(java.lang.String str)
          Append a text node child that will be constructed from a string, to the end of the document.
 void characters(char[] ch, int offset, int length)
          Receive notification of character data.
 void characters(int node, org.apache.xml.serializer.SerializationHandler handler)
          Dispatch the character content of a node to an output handler.
 void characters(java.lang.String str)
          This method is used to notify of a character event, but passing the data as a character String rather than the standard character array.
 void copy(org.apache.xml.dtm.DTMAxisIterator nodes, org.apache.xml.serializer.SerializationHandler handler)
           
 void copy(int node, org.apache.xml.serializer.SerializationHandler handler)
           
 void dispatchCharactersEvents(int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize)
          Directly call the characters method on the passed ContentHandler for the string-value of the given node (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
 void dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch)
          Directly create SAX parser events representing the XML content of a DTM subtree.
 void documentRegistration()
          As the DTM is registered with the DTMManager, this method will be called.
 void documentRelease()
          As documents are released from the DTMManager, the DTM implementation will be notified of the event.
 void endDocument()
          Receive notification of the end of a document.
 int getAttributeNode(int gType, int element)
           
 int getAttributeNode(int elementHandle, java.lang.String namespaceURI, java.lang.String name)
          Retrieves an attribute node by local name and namespace URI %TBD% Note that we currently have no way to support the DOM's old getAttribute() call, which accesses only the qname.
 org.apache.xml.dtm.DTMAxisIterator getAxisIterator(int axis)
          This is a shortcut to the iterators that implement XPath axes.
 org.apache.xml.dtm.DTMAxisTraverser getAxisTraverser(int axis)
          This returns a stateless "traverser", that can navigate over an XPath axis, though not in document order.
 org.apache.xml.dtm.DTMAxisIterator getChildren(int node)
           
 org.xml.sax.ContentHandler getContentHandler()
          Return this DTM's content handler, if it has one.
 org.xml.sax.ext.DeclHandler getDeclHandler()
          Return this DTM's DeclHandler, if it has one.
 int getDocument()
          Given a DTM which contains only a single document, find the Node Handle of the Document node.
 boolean getDocumentAllDeclarationsProcessed()
          Return an indication of whether the processor has read the complete DTD.
 java.lang.String getDocumentBaseURI()
          Return the base URI of the document entity.
 java.lang.String getDocumentEncoding(int nodeHandle)
          Return the name of the character encoding scheme in which the document entity is expressed.
 int getDocumentRoot(int nodeHandle)
          Given a node handle, find the owning document node.
 java.lang.String getDocumentStandalone(int nodeHandle)
          Return an indication of the standalone status of the document, either "yes" or "no".
 java.lang.String getDocumentSystemIdentifier(int nodeHandle)
          Return the system identifier of the document entity.
 java.lang.String getDocumentTypeDeclarationPublicIdentifier()
          Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML].
 java.lang.String getDocumentTypeDeclarationSystemIdentifier()
          A document type declaration information item has the following properties: 1.
 java.lang.String getDocumentURI(int node)
           
 java.lang.String getDocumentVersion(int documentHandle)
          Return a string representing the XML version of the document.
 org.xml.sax.DTDHandler getDTDHandler()
          Return this DTM's DTDHandler, if it has one.
 org.apache.xml.dtm.ref.DTMManagerDefault getDTMManager()
           
 int getElementById(java.lang.String elementId)
          Returns the Element whose ID is given by elementId.
 org.apache.xalan.xsltc.runtime.Hashtable getElementsWithIDs()
           
 org.xml.sax.EntityResolver getEntityResolver()
          Return this DTM's EntityResolver, if it has one.
 org.xml.sax.ErrorHandler getErrorHandler()
          Return this DTM's ErrorHandler, if it has one.
 int getExpandedTypeID(int nodeHandle)
          Given a node handle, return an ID that represents the node's expanded name.
 int getExpandedTypeID(java.lang.String namespace, java.lang.String localName, int type)
          Given an expanded name, return an ID.
 int getFirstAttribute(int nodeHandle)
          Given a node handle, get the index of the node's first attribute.
 int getFirstChild(int nodeHandle)
          Given a node handle, get the handle of the node's first child.
 int getFirstNamespaceNode(int nodeHandle, boolean inScope)
          Given a node handle, get the index of the node's first namespace node.
 org.apache.xml.dtm.DTMAxisIterator getIterator()
          returns singleton iterator containg the document root
 java.lang.String getLanguage(int node)
           
 int getLastChild(int nodeHandle)
          Given a node handle, get the handle of the node's last child.
 short getLevel(int nodeHandle)
          Get the depth level of this node in the tree (equals 1 for a parentless node).
 org.xml.sax.ext.LexicalHandler getLexicalHandler()
          Return this DTM's lexical handler, if it has one.
 java.lang.String getLocalName(int nodeHandle)
          Given a node handle, return its DOM-style localname.
 java.lang.String getLocalNameFromExpandedNameID(int ExpandedNameID)
          Given an expanded-name ID, return the local name part.
 org.apache.xml.dtm.DTMAxisIterator getNamespaceAxisIterator(int axis, int ns)
           
 java.lang.String getNamespaceFromExpandedNameID(int ExpandedNameID)
          Given an expanded-name ID, return the namespace URI part.
 java.lang.String getNamespaceName(int node)
           
 int getNamespaceType(int node)
           
 java.lang.String getNamespaceURI(int nodeHandle)
          Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.)
 int getNextAttribute(int nodeHandle)
          Given a node handle, advance to the next attribute.
 int getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)
          Given a namespace handle, advance to the next namespace in the same scope (local or local-plus-inherited, as selected by getFirstNamespaceNode)
 int getNextSibling(int nodeHandle)
          Given a node handle, advance to its next sibling.
 org.w3c.dom.Node getNode(int nodeHandle)
          Return an DOM node for the given node.
 int getNodeHandle(int nodeId)
          Return the node handle from a node identity.
 int getNodeIdent(int nodehandle)
          Return the node identity from a node handle.
 java.lang.String getNodeName(int node)
          Given a node handle, return its DOM-style node name.
 java.lang.String getNodeNameX(int node)
          Given a node handle, return the XPath node name.
 short getNodeType(int nodeHandle)
          Given a node handle, return its DOM-style node type.
 java.lang.String getNodeValue(int nodeHandle)
          Given a node handle, return its node value.
 org.apache.xml.dtm.DTMAxisIterator getNodeValueIterator(org.apache.xml.dtm.DTMAxisIterator iter, int returnType, java.lang.String value, boolean op)
           
 int getNSType(int node)
           
 org.apache.xml.dtm.DTMAxisIterator getNthDescendant(int node, int n, boolean includeself)
           
 org.apache.xml.serializer.SerializationHandler getOutputDomBuilder()
           
 int getOwnerDocument(int nodeHandle)
          Given a node handle, find the owning document node.
 int getParent(int nodeHandle)
          Given a node handle, find its parent node.
 java.lang.String getPrefix(int nodeHandle)
          Given a namespace handle, return the prefix that the namespace decl is mapping.
 int getPreviousSibling(int nodeHandle)
          Given a node handle, find its preceeding sibling.
 org.apache.xalan.xsltc.DOM getResultTreeFrag(int initialSize, int rtfType)
           
 org.apache.xalan.xsltc.DOM getResultTreeFrag(int initialSize, int rtfType, boolean addToManager)
           
 int getSize()
           
 javax.xml.transform.SourceLocator getSourceLocatorFor(int node)
          Get the location of a node in the source document.
 java.lang.String getStringValue()
           
 org.apache.xml.utils.XMLString getStringValue(int nodeHandle)
          Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
 char[] getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
          Get a character array chunk in the string-value of a node.
 int getStringValueChunkCount(int nodeHandle)
          Get number of character array chunks in the string-value of a node.
 java.lang.String getStringValueX(int nodeHandle)
           
 org.apache.xml.dtm.DTMAxisIterator getTypedAxisIterator(int axis, int type)
          Get an iterator that can navigate over an XPath Axis, predicated by the extended type ID.
 org.apache.xml.dtm.DTMAxisIterator getTypedChildren(int type)
           
 java.lang.String getUnparsedEntityURI(java.lang.String name)
          The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]).
 boolean hasChildNodes(int nodeHandle)
          Given a node handle, test if it has child nodes.
 boolean isAttribute(int node)
           
 boolean isAttributeSpecified(int attributeHandle)
          5.
 boolean isCharacterElementContentWhitespace(int nodeHandle)
          2.
 boolean isDocumentAllDeclarationsProcessed(int documentHandle)
          10.
 boolean isElement(int node)
           
 boolean isNodeAfter(int firstNodeHandle, int secondNodeHandle)
          Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model.
 boolean isSupported(java.lang.String feature, java.lang.String version)
          Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.
 boolean lessThan(int node1, int node2)
           
 java.lang.String lookupNamespace(int node, java.lang.String prefix)
           
 org.w3c.dom.Node makeNode(org.apache.xml.dtm.DTMAxisIterator iter)
           
 org.w3c.dom.Node makeNode(int index)
           
 org.w3c.dom.NodeList makeNodeList(org.apache.xml.dtm.DTMAxisIterator iter)
           
 org.w3c.dom.NodeList makeNodeList(int index)
           
 void migrateTo(org.apache.xml.dtm.DTMManager manager)
          Migrate a DTM built with an old DTMManager to a new DTMManager.
 boolean needsTwoThreads()
           
 org.apache.xml.dtm.DTMAxisIterator orderNodes(org.apache.xml.dtm.DTMAxisIterator source, int node)
           
 void setDocumentBaseURI(java.lang.String baseURI)
          Set the base URI of the document entity.
 boolean setEscaping(boolean escape)
          Turns special character escaping on/off.
 void setFeature(java.lang.String featureId, boolean state)
          The DTM interfaces are not used in this class.
 void setFilter(org.apache.xalan.xsltc.StripFilter filter)
           
 void setProperty(java.lang.String property, java.lang.Object value)
          Set a run time property for this DTM instance.
 void setupMapping(java.lang.String[] names, java.lang.String[] uris, int[] types, java.lang.String[] namespaces)
           
 java.lang.String shallowCopy(int node, org.apache.xml.serializer.SerializationHandler handler)
           
 void startDocument()
          We only need to override the endDocument, characters, and setEscaping interfaces.
 boolean supportsPreStripping()
          Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the document contained in this DTM.
 
Methods inherited from class org.apache.xml.serializer.EmptySerializer
addAttribute, addAttribute, addAttributes, addUniqueAttribute, asContentHandler, asDOMSerializer, attributeDecl, close, comment, comment, elementDecl, endCDATA, endDTD, endElement, endElement, endEntity, endPrefixMapping, entityReference, error, externalEntityDecl, fatalError, flushPending, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputFormat, getOutputStream, getPrefix, getStandalone, getTransformer, getVersion, getWriter, ignorableWhitespace, internalEntityDecl, namespaceAfterStartElement, processingInstruction, reset, serialize, setCdataSectionElements, setCdataSectionElements, setContentHandler, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputFormat, setOutputStream, setSourceLocator, setStandalone, setTransformer, setVersion, setWriter, skippedEntity, startCDATA, startDTD, startElement, startElement, startElement, startEntity, startPrefixMapping, startPrefixMapping, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_ITERATOR

private static final org.apache.xml.dtm.DTMAxisIterator EMPTY_ITERATOR

RTF_ROOT

public static final int RTF_ROOT
See Also:
Constant Field Values

RTF_TEXT

public static final int RTF_TEXT
See Also:
Constant Field Values

NUMBER_OF_NODES

public static final int NUMBER_OF_NODES
See Also:
Constant Field Values

_documentURIIndex

private static int _documentURIIndex

EMPTY_STR

private static final java.lang.String EMPTY_STR
See Also:
Constant Field Values

_text

private java.lang.String _text

_textArray

protected java.lang.String[] _textArray

_dtmManager

protected XSLTCDTMManager _dtmManager

_size

protected int _size

_documentID

private int _documentID

_dontEscape

private BitArray _dontEscape

_escaping

private boolean _escaping
Constructor Detail

SimpleResultTreeImpl

public SimpleResultTreeImpl(XSLTCDTMManager dtmManager,
                            int documentID)
Method Detail

getDTMManager

public org.apache.xml.dtm.ref.DTMManagerDefault getDTMManager()

getDocument

public int getDocument()
Description copied from interface: org.apache.xml.dtm.DTM
Given a DTM which contains only a single document, find the Node Handle of the Document node. Note that if the DTM is configured so it can contain multiple documents, this call will return the Document currently under construction -- but may return null if it's between documents. Generally, you should use getOwnerDocument(nodeHandle) or getDocumentRoot(nodeHandle) instead.

Specified by:
getDocument in interface org.apache.xalan.xsltc.DOM

getStringValue

public java.lang.String getStringValue()
Specified by:
getStringValue in interface org.apache.xalan.xsltc.DOM

getIterator

public org.apache.xml.dtm.DTMAxisIterator getIterator()
Description copied from interface: org.apache.xalan.xsltc.DOM
returns singleton iterator containg the document root

Specified by:
getIterator in interface org.apache.xalan.xsltc.DOM

getChildren

public org.apache.xml.dtm.DTMAxisIterator getChildren(int node)
Specified by:
getChildren in interface org.apache.xalan.xsltc.DOM

getTypedChildren

public org.apache.xml.dtm.DTMAxisIterator getTypedChildren(int type)
Specified by:
getTypedChildren in interface org.apache.xalan.xsltc.DOM

getAxisIterator

public org.apache.xml.dtm.DTMAxisIterator getAxisIterator(int axis)
Description copied from interface: org.apache.xml.dtm.DTM
This is a shortcut to the iterators that implement XPath axes. Returns a bare-bones iterator that must be initialized with a start node (using iterator.setStartNode()).

Specified by:
getAxisIterator in interface org.apache.xalan.xsltc.DOM

getTypedAxisIterator

public org.apache.xml.dtm.DTMAxisIterator getTypedAxisIterator(int axis,
                                                               int type)
Description copied from interface: org.apache.xml.dtm.DTM
Get an iterator that can navigate over an XPath Axis, predicated by the extended type ID.

Specified by:
getTypedAxisIterator in interface org.apache.xalan.xsltc.DOM

getNthDescendant

public org.apache.xml.dtm.DTMAxisIterator getNthDescendant(int node,
                                                           int n,
                                                           boolean includeself)
Specified by:
getNthDescendant in interface org.apache.xalan.xsltc.DOM

getNamespaceAxisIterator

public org.apache.xml.dtm.DTMAxisIterator getNamespaceAxisIterator(int axis,
                                                                   int ns)
Specified by:
getNamespaceAxisIterator in interface org.apache.xalan.xsltc.DOM

getNodeValueIterator

public org.apache.xml.dtm.DTMAxisIterator getNodeValueIterator(org.apache.xml.dtm.DTMAxisIterator iter,
                                                               int returnType,
                                                               java.lang.String value,
                                                               boolean op)
Specified by:
getNodeValueIterator in interface org.apache.xalan.xsltc.DOM

orderNodes

public org.apache.xml.dtm.DTMAxisIterator orderNodes(org.apache.xml.dtm.DTMAxisIterator source,
                                                     int node)
Specified by:
orderNodes in interface org.apache.xalan.xsltc.DOM

getNodeName

public java.lang.String getNodeName(int node)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, return its DOM-style node name. This will include names such as #text or #document.

Specified by:
getNodeName in interface org.apache.xalan.xsltc.DOM

getNodeNameX

public java.lang.String getNodeNameX(int node)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, return the XPath node name. This should be the name as described by the XPath data model, NOT the DOM-style name.

Specified by:
getNodeNameX in interface org.apache.xalan.xsltc.DOM

getNamespaceName

public java.lang.String getNamespaceName(int node)
Specified by:
getNamespaceName in interface org.apache.xalan.xsltc.DOM

getExpandedTypeID

public int getExpandedTypeID(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, return an ID that represents the node's expanded name.

Specified by:
getExpandedTypeID in interface org.apache.xalan.xsltc.DOM

getNamespaceType

public int getNamespaceType(int node)
Specified by:
getNamespaceType in interface org.apache.xalan.xsltc.DOM

getParent

public int getParent(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, find its parent node.

Specified by:
getParent in interface org.apache.xalan.xsltc.DOM

getAttributeNode

public int getAttributeNode(int gType,
                            int element)
Specified by:
getAttributeNode in interface org.apache.xalan.xsltc.DOM

getStringValueX

public java.lang.String getStringValueX(int nodeHandle)
Specified by:
getStringValueX in interface org.apache.xalan.xsltc.DOM

copy

public void copy(int node,
                 org.apache.xml.serializer.SerializationHandler handler)
          throws org.apache.xalan.xsltc.TransletException
Specified by:
copy in interface org.apache.xalan.xsltc.DOM

copy

public void copy(org.apache.xml.dtm.DTMAxisIterator nodes,
                 org.apache.xml.serializer.SerializationHandler handler)
          throws org.apache.xalan.xsltc.TransletException
Specified by:
copy in interface org.apache.xalan.xsltc.DOM

shallowCopy

public java.lang.String shallowCopy(int node,
                                    org.apache.xml.serializer.SerializationHandler handler)
                             throws org.apache.xalan.xsltc.TransletException
Specified by:
shallowCopy in interface org.apache.xalan.xsltc.DOM

lessThan

public boolean lessThan(int node1,
                        int node2)
Specified by:
lessThan in interface org.apache.xalan.xsltc.DOM

characters

public void characters(int node,
                       org.apache.xml.serializer.SerializationHandler handler)
                throws org.apache.xalan.xsltc.TransletException
Dispatch the character content of a node to an output handler. The escape setting should be taken care of when outputting to a handler.

Specified by:
characters in interface org.apache.xalan.xsltc.DOM

makeNode

public org.w3c.dom.Node makeNode(int index)
Specified by:
makeNode in interface org.apache.xalan.xsltc.DOM

makeNode

public org.w3c.dom.Node makeNode(org.apache.xml.dtm.DTMAxisIterator iter)
Specified by:
makeNode in interface org.apache.xalan.xsltc.DOM

makeNodeList

public org.w3c.dom.NodeList makeNodeList(int index)
Specified by:
makeNodeList in interface org.apache.xalan.xsltc.DOM

makeNodeList

public org.w3c.dom.NodeList makeNodeList(org.apache.xml.dtm.DTMAxisIterator iter)
Specified by:
makeNodeList in interface org.apache.xalan.xsltc.DOM

getLanguage

public java.lang.String getLanguage(int node)
Specified by:
getLanguage in interface org.apache.xalan.xsltc.DOM

getSize

public int getSize()
Specified by:
getSize in interface org.apache.xalan.xsltc.DOM

getDocumentURI

public java.lang.String getDocumentURI(int node)
Specified by:
getDocumentURI in interface org.apache.xalan.xsltc.DOM

setFilter

public void setFilter(org.apache.xalan.xsltc.StripFilter filter)
Specified by:
setFilter in interface org.apache.xalan.xsltc.DOM

setupMapping

public void setupMapping(java.lang.String[] names,
                         java.lang.String[] uris,
                         int[] types,
                         java.lang.String[] namespaces)
Specified by:
setupMapping in interface org.apache.xalan.xsltc.DOM

isElement

public boolean isElement(int node)
Specified by:
isElement in interface org.apache.xalan.xsltc.DOM

isAttribute

public boolean isAttribute(int node)
Specified by:
isAttribute in interface org.apache.xalan.xsltc.DOM

lookupNamespace

public java.lang.String lookupNamespace(int node,
                                        java.lang.String prefix)
                                 throws org.apache.xalan.xsltc.TransletException
Specified by:
lookupNamespace in interface org.apache.xalan.xsltc.DOM

getNodeIdent

public int getNodeIdent(int nodehandle)
Return the node identity from a node handle.

Specified by:
getNodeIdent in interface org.apache.xalan.xsltc.DOM

getNodeHandle

public int getNodeHandle(int nodeId)
Return the node handle from a node identity.

Specified by:
getNodeHandle in interface org.apache.xalan.xsltc.DOM

getResultTreeFrag

public org.apache.xalan.xsltc.DOM getResultTreeFrag(int initialSize,
                                                    int rtfType)
Specified by:
getResultTreeFrag in interface org.apache.xalan.xsltc.DOM

getResultTreeFrag

public org.apache.xalan.xsltc.DOM getResultTreeFrag(int initialSize,
                                                    int rtfType,
                                                    boolean addToManager)
Specified by:
getResultTreeFrag in interface org.apache.xalan.xsltc.DOM

getOutputDomBuilder

public org.apache.xml.serializer.SerializationHandler getOutputDomBuilder()
Specified by:
getOutputDomBuilder in interface org.apache.xalan.xsltc.DOM

getNSType

public int getNSType(int node)
Specified by:
getNSType in interface org.apache.xalan.xsltc.DOM

getUnparsedEntityURI

public java.lang.String getUnparsedEntityURI(java.lang.String name)
Description copied from interface: org.apache.xml.dtm.DTM
The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]). It returns the empty string if there is no such entity.

XML processors may choose to use the System Identifier (if one is provided) to resolve the entity, rather than the URI in the Public Identifier. The details are dependent on the processor, and we would have to support some form of plug-in resolver to handle this properly. Currently, we simply return the System Identifier if present, and hope that it a usable URI or that our caller can map it to one. %REVIEW% Resolve Public Identifiers... or consider changing function name.

If we find a relative URI reference, XML expects it to be resolved in terms of the base URI of the document. The DOM doesn't do that for us, and it isn't entirely clear whether that should be done here; currently that's pushed up to a higher level of our application. (Note that DOM Level 1 didn't store the document's base URI.) %REVIEW% Consider resolving Relative URIs.

(The DOM's statement that "An XML processor may choose to completely expand entities before the structure model is passed to the DOM" refers only to parsed entities, not unparsed, and hence doesn't affect this function.)

Specified by:
getUnparsedEntityURI in interface org.apache.xalan.xsltc.DOM

getElementsWithIDs

public org.apache.xalan.xsltc.runtime.Hashtable getElementsWithIDs()
Specified by:
getElementsWithIDs in interface org.apache.xalan.xsltc.DOM

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
We only need to override the endDocument, characters, and setEscaping interfaces. A simple RTF does not have element nodes. We do not need to touch startElement and endElement.

Specified by:
startDocument in interface org.xml.sax.ContentHandler

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Description copied from interface: org.xml.sax.ContentHandler
Receive notification of the end of a document.

There is an apparent contradiction between the documentation for this method and the documentation for ErrorHandler.fatalError(org.xml.sax.SAXParseException)>ErrorHandler.fatalError(org.xml.sax.SAXParseException) 55 . Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether endDocument() will or will not be invoked when the parser has reported a fatalError() or thrown an exception.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Specified by:
endDocument in interface org.xml.sax.ContentHandler

characters

public void characters(java.lang.String str)
                throws org.xml.sax.SAXException
Description copied from interface: org.apache.xml.serializer.ExtendedContentHandler
This method is used to notify of a character event, but passing the data as a character String rather than the standard character array.

Specified by:
characters in interface org.apache.xml.serializer.ExtendedContentHandler

characters

public void characters(char[] ch,
                       int offset,
                       int length)
                throws org.xml.sax.SAXException
Description copied from interface: org.xml.sax.ContentHandler
Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Individual characters may consist of more than one Java char value. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters.

Your code should not assume that algorithms using char-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML.

Note that some parsers will report whitespace in element content using the ignorableWhitespace 55 method rather than this one (validating parsers must do so).

Specified by:
characters in interface org.xml.sax.ContentHandler

setEscaping

public boolean setEscaping(boolean escape)
                    throws org.xml.sax.SAXException
Description copied from interface: org.apache.xml.serializer.SerializationHandler
Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents.

Specified by:
setEscaping in interface org.apache.xml.serializer.SerializationHandler

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)
The DTM interfaces are not used in this class. Implementing the DTM interface is a requirement from MultiDOM. If we have a better way of handling multiple documents, we can get rid of the DTM dependency. The following interfaces are just placeholders. The implementation does not have an impact because they will not be used.

Specified by:
setFeature in interface org.apache.xml.dtm.DTM

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
Description copied from interface: org.apache.xml.dtm.DTM
Set a run time property for this DTM instance.

Specified by:
setProperty in interface org.apache.xml.dtm.DTM

getAxisTraverser

public org.apache.xml.dtm.DTMAxisTraverser getAxisTraverser(int axis)
Description copied from interface: org.apache.xml.dtm.DTM
This returns a stateless "traverser", that can navigate over an XPath axis, though not in document order.

Specified by:
getAxisTraverser in interface org.apache.xml.dtm.DTM

hasChildNodes

public boolean hasChildNodes(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, test if it has child nodes.

%REVIEW% This is obviously useful at the DOM layer, where it would permit testing this without having to create a proxy node. It's less useful in the DTM API, where (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and almost as self-evident. But it's a convenience, and eases porting of DOM code to DTM.

Specified by:
hasChildNodes in interface org.apache.xml.dtm.DTM

getFirstChild

public int getFirstChild(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, get the handle of the node's first child.

Specified by:
getFirstChild in interface org.apache.xml.dtm.DTM

getLastChild

public int getLastChild(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, get the handle of the node's last child.

Specified by:
getLastChild in interface org.apache.xml.dtm.DTM

getAttributeNode

public int getAttributeNode(int elementHandle,
                            java.lang.String namespaceURI,
                            java.lang.String name)
Description copied from interface: org.apache.xml.dtm.DTM
Retrieves an attribute node by local name and namespace URI %TBD% Note that we currently have no way to support the DOM's old getAttribute() call, which accesses only the qname.

Specified by:
getAttributeNode in interface org.apache.xml.dtm.DTM

getFirstAttribute

public int getFirstAttribute(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, get the index of the node's first attribute.

Specified by:
getFirstAttribute in interface org.apache.xml.dtm.DTM

getFirstNamespaceNode

public int getFirstNamespaceNode(int nodeHandle,
                                 boolean inScope)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, get the index of the node's first namespace node.

Specified by:
getFirstNamespaceNode in interface org.apache.xml.dtm.DTM

getNextSibling

public int getNextSibling(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, advance to its next sibling.

Specified by:
getNextSibling in interface org.apache.xml.dtm.DTM

getPreviousSibling

public int getPreviousSibling(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, find its preceeding sibling. WARNING: DTM implementations may be asymmetric; in some, this operation has been resolved by search, and is relatively expensive.

Specified by:
getPreviousSibling in interface org.apache.xml.dtm.DTM

getNextAttribute

public int getNextAttribute(int nodeHandle)
Description copied from interface: org.apache.xml.dtm.DTM
Given a node handle, advance to the next attribute. If an element, we advance to its first attribute; if an attr, we advance to the next attr of the same element.

Specified by:
getNextAttribute in interface org.apache.xml.dtm.DTM