org.apache.xalan.lib.sql

Class DTMDocument

Implemented Interfaces:
DTM
Known Direct Subclasses:
SQLDocument, SQLErrorDocument

public class DTMDocument
extends DTMDefaultBaseIterators

The SQL Document is the main controlling class the executesa SQL Query

Nested Class Summary

static interface
DTMDocument.CharacterNodeHandler

Nested classes/interfaces inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators

DTMDefaultBaseIterators.AncestorIterator, DTMDefaultBaseIterators.AttributeIterator, DTMDefaultBaseIterators.ChildrenIterator, DTMDefaultBaseIterators.DescendantIterator, DTMDefaultBaseIterators.FollowingIterator, DTMDefaultBaseIterators.FollowingSiblingIterator, DTMDefaultBaseIterators.InternalAxisIteratorBase, DTMDefaultBaseIterators.NamespaceAttributeIterator, DTMDefaultBaseIterators.NamespaceChildrenIterator, DTMDefaultBaseIterators.NamespaceIterator, DTMDefaultBaseIterators.NthDescendantIterator, DTMDefaultBaseIterators.ParentIterator, DTMDefaultBaseIterators.PrecedingIterator, DTMDefaultBaseIterators.PrecedingSiblingIterator, DTMDefaultBaseIterators.RootIterator, DTMDefaultBaseIterators.SingletonIterator, DTMDefaultBaseIterators.TypedAncestorIterator, DTMDefaultBaseIterators.TypedAttributeIterator, DTMDefaultBaseIterators.TypedChildrenIterator, DTMDefaultBaseIterators.TypedDescendantIterator, DTMDefaultBaseIterators.TypedFollowingIterator, DTMDefaultBaseIterators.TypedFollowingSiblingIterator, DTMDefaultBaseIterators.TypedNamespaceIterator, DTMDefaultBaseIterators.TypedPrecedingIterator, DTMDefaultBaseIterators.TypedPrecedingSiblingIterator, DTMDefaultBaseIterators.TypedRootIterator, DTMDefaultBaseIterators.TypedSingletonIterator

Field Summary

Fields inherited from class org.apache.xml.dtm.ref.DTMDefaultBase

DEFAULT_BLOCKSIZE, DEFAULT_NUMBLOCKS, DEFAULT_NUMBLOCKS_SMALL, ROOTNODE, m_mgr

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

Constructor Summary

DTMDocument(DTMManager mgr, int ident)

Method Summary

void
appendChild(int parm1, boolean parm2, boolean parm3)
void
appendTextChild(String parm1)
void
dispatchCharactersEvents(int nodeHandle, ContentHandler ch, boolean normalize)
void
dispatchToEvents(int parm1, ContentHandler parm2)
void
dumpDTM()
int
getAttributeNode(int parm1, String parm2, String parm3)
DTMAxisIterator
getAxisIterator(int parm1)
DTMAxisTraverser
getAxisTraverser(int parm1)
ContentHandler
getContentHandler()
DTDHandler
getDTDHandler()
DeclHandler
getDeclHandler()
int
getDocument()
boolean
getDocumentAllDeclarationsProcessed()
String
getDocumentBaseURI()
String
getDocumentEncoding(int parm1)
String
getDocumentStandalone(int parm1)
String
getDocumentSystemIdentifier(int parm1)
String
getDocumentTypeDeclarationPublicIdentifier()
String
getDocumentTypeDeclarationSystemIdentifier()
String
getDocumentVersion(int parm1)
int
getElementById(String parm1)
EntityResolver
getEntityResolver()
ErrorHandler
getErrorHandler()
int
getExpandedTypeID(String parm1, String parm2, int parm3)
int
getExpandedTypeID(int parm1)
int
getFirstAttribute(int parm1)
int
getFirstChild(int parm1)
int
getFirstNamespaceNode(int parm1, boolean parm2)
int
getLastChild(int parm1)
short
getLevel(int parm1)
LexicalHandler
getLexicalHandler()
String
getLocalName(int parm1)
String
getLocalNameFromExpandedNameID(int parm1)
String
getNamespaceFromExpandedNameID(int parm1)
int
getNamespaceType(int parm1)
String
getNamespaceURI(int parm1)
int
getNextAttribute(int parm1)
int
getNextNamespaceNode(int parm1, int parm2, boolean parm3)
int
getNextSibling(int parm1)
Node
getNode(int parm1)
String
getNodeName(int parm1)
String
getNodeNameX(int parm1)
short
getNodeType(int parm1)
String
getNodeValue(int parm1)
int
getOwnerDocument(int parm1)
int
getParent(int parm1)
String
getPrefix(int parm1)
int
getPreviousSibling(int parm1)
SourceLocator
getSourceLocatorFor(int node)
No source information is available for DOM2DTM, so return null here.
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 parm1, int parm2, int[] parm3)
int
getStringValueChunkCount(int parm1)
DTMAxisIterator
getTypedAxisIterator(int parm1, int parm2)
String
getUnparsedEntityURI(String parm1)
boolean
hasChildNodes(int parm1)
boolean
isAttributeSpecified(int parm1)
boolean
isCharacterElementContentWhitespace(int parm1)
boolean
isDocumentAllDeclarationsProcessed(int parm1)
boolean
isNodeAfter(int parm1, int parm2)
boolean
isSupported(String parm1, String parm2)
boolean
needsTwoThreads()
void
setDocumentBaseURI(String parm1)
void
setFeature(String parm1, boolean parm2)
void
setProperty(String property, Object value)
For the moment all the run time properties are ignored by this class.
boolean
supportsPreStripping()
Event overriding for Debug

Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators

getAxisIterator, getTypedAxisIterator

Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseTraversers

getAxisTraverser

Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBase

appendChild, appendTextChild, dispatchCharactersEvents, dispatchToEvents, documentRegistration, documentRelease, dumpDTM, dumpNode, getAttributeNode, getDTMIDs, getDocument, getDocumentAllDeclarationsProcessed, getDocumentBaseURI, getDocumentEncoding, getDocumentRoot, getDocumentStandalone, getDocumentSystemIdentifier, getDocumentTypeDeclarationPublicIdentifier, getDocumentTypeDeclarationSystemIdentifier, getDocumentVersion, getElementById, getExpandedTypeID, getExpandedTypeID, getFirstAttribute, getFirstChild, getFirstNamespaceNode, getLastChild, getLevel, getLocalName, getLocalNameFromExpandedNameID, getManager, getNamespaceFromExpandedNameID, getNamespaceType, getNamespaceURI, getNextAttribute, getNextNamespaceNode, getNextSibling, getNode, getNodeHandle, getNodeIdent, getNodeName, getNodeNameX, getNodeType, getNodeValue, getOwnerDocument, getParent, getPrefix, getPreviousSibling, getStringValue, getStringValueChunk, getStringValueChunkCount, getTypedFirstChild, getTypedNextSibling, getUnparsedEntityURI, hasChildNodes, isAttributeSpecified, isCharacterElementContentWhitespace, isDocumentAllDeclarationsProcessed, isNodeAfter, isSupported, makeNodeHandle, makeNodeIdentity, migrateTo, setDocumentBaseURI, setFeature, supportsPreStripping

Constructor Details

DTMDocument

public DTMDocument(DTMManager mgr,
                   int ident)
Parameters:
mgr -
ident -

Method Details

appendChild

public void appendChild(int parm1,
                        boolean parm2,
                        boolean parm3)
Specified by:
appendChild in interface DTM
Overrides:
appendChild in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -
parm3 -

appendTextChild

public void appendTextChild(String parm1)
Specified by:
appendTextChild in interface DTM
Overrides:
appendTextChild in interface DTMDefaultBase
Parameters:
parm1 -

dispatchCharactersEvents

public void dispatchCharactersEvents(int nodeHandle,
                                     ContentHandler ch,
                                     boolean normalize)
            throws org.xml.sax.SAXException
Parameters:
nodeHandle -
ch -
normalize -

dispatchToEvents

public void dispatchToEvents(int parm1,
                             ContentHandler parm2)
            throws org.xml.sax.SAXException
Parameters:
parm1 -
parm2 -

dumpDTM

public void dumpDTM()

getAttributeNode

public int getAttributeNode(int parm1,
                            String parm2,
                            String parm3)
Specified by:
getAttributeNode in interface DTM
Overrides:
getAttributeNode in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -
parm3 -

getAxisIterator

public DTMAxisIterator getAxisIterator(int parm1)
Specified by:
getAxisIterator in interface DTM
Overrides:
getAxisIterator in interface DTMDefaultBaseIterators
Parameters:
parm1 -

getAxisTraverser

public DTMAxisTraverser getAxisTraverser(int parm1)
Specified by:
getAxisTraverser in interface DTM
Overrides:
getAxisTraverser in interface DTMDefaultBaseTraversers
Parameters:
parm1 -

getContentHandler

public ContentHandler getContentHandler()
Specified by:
getContentHandler in interface DTM

getDTDHandler

public DTDHandler getDTDHandler()
Specified by:
getDTDHandler in interface DTM

getDeclHandler

public DeclHandler getDeclHandler()
Specified by:
getDeclHandler in interface DTM

getDocument

public int getDocument()
Specified by:
getDocument in interface DTM
Overrides:
getDocument in interface DTMDefaultBase

getDocumentAllDeclarationsProcessed

public boolean getDocumentAllDeclarationsProcessed()
Specified by:
getDocumentAllDeclarationsProcessed in interface DTM
Overrides:
getDocumentAllDeclarationsProcessed in interface DTMDefaultBase

getDocumentBaseURI

public String getDocumentBaseURI()
Specified by:
getDocumentBaseURI in interface DTM
Overrides:
getDocumentBaseURI in interface DTMDefaultBase

getDocumentEncoding

public String getDocumentEncoding(int parm1)
Specified by:
getDocumentEncoding in interface DTM
Overrides:
getDocumentEncoding in interface DTMDefaultBase
Parameters:
parm1 -

getDocumentStandalone

public String getDocumentStandalone(int parm1)
Specified by:
getDocumentStandalone in interface DTM
Overrides:
getDocumentStandalone in interface DTMDefaultBase
Parameters:
parm1 -

getDocumentSystemIdentifier

public String getDocumentSystemIdentifier(int parm1)
Specified by:
getDocumentSystemIdentifier in interface DTM
Overrides:
getDocumentSystemIdentifier in interface DTMDefaultBase
Parameters:
parm1 -

getDocumentTypeDeclarationPublicIdentifier

public String getDocumentTypeDeclarationPublicIdentifier()
Specified by:
getDocumentTypeDeclarationPublicIdentifier in interface DTM
Overrides:
getDocumentTypeDeclarationPublicIdentifier in interface DTMDefaultBase

getDocumentTypeDeclarationSystemIdentifier

public String getDocumentTypeDeclarationSystemIdentifier()
Specified by:
getDocumentTypeDeclarationSystemIdentifier in interface DTM
Overrides:
getDocumentTypeDeclarationSystemIdentifier in interface DTMDefaultBase

getDocumentVersion

public String getDocumentVersion(int parm1)
Specified by:
getDocumentVersion in interface DTM
Overrides:
getDocumentVersion in interface DTMDefaultBase
Parameters:
parm1 -

getElementById

public int getElementById(String parm1)
Specified by:
getElementById in interface DTM
Overrides:
getElementById in interface DTMDefaultBase
Parameters:
parm1 -

getEntityResolver

public EntityResolver getEntityResolver()
Specified by:
getEntityResolver in interface DTM

getErrorHandler

public ErrorHandler getErrorHandler()
Specified by:
getErrorHandler in interface DTM

getExpandedTypeID

public int getExpandedTypeID(String parm1,
                             String parm2,
                             int parm3)
Specified by:
getExpandedTypeID in interface DTM
Overrides:
getExpandedTypeID in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -
parm3 -

getExpandedTypeID

public int getExpandedTypeID(int parm1)
Specified by:
getExpandedTypeID in interface DTM
Overrides:
getExpandedTypeID in interface DTMDefaultBase
Parameters:
parm1 -

getFirstAttribute

public int getFirstAttribute(int parm1)
Specified by:
getFirstAttribute in interface DTM
Overrides:
getFirstAttribute in interface DTMDefaultBase
Parameters:
parm1 -

getFirstChild

public int getFirstChild(int parm1)
Specified by:
getFirstChild in interface DTM
Overrides:
getFirstChild in interface DTMDefaultBase
Parameters:
parm1 -

getFirstNamespaceNode

public int getFirstNamespaceNode(int parm1,
                                 boolean parm2)
Specified by:
getFirstNamespaceNode in interface DTM
Overrides:
getFirstNamespaceNode in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -

getLastChild

public int getLastChild(int parm1)
Specified by:
getLastChild in interface DTM
Overrides:
getLastChild in interface DTMDefaultBase
Parameters:
parm1 -

getLevel

public short getLevel(int parm1)
Specified by:
getLevel in interface DTM
Overrides:
getLevel in interface DTMDefaultBase
Parameters:
parm1 -

getLexicalHandler

public LexicalHandler getLexicalHandler()
Specified by:
getLexicalHandler in interface DTM

getLocalName

public String getLocalName(int parm1)
Specified by:
getLocalName in interface DTM
Overrides:
getLocalName in interface DTMDefaultBase
Parameters:
parm1 -

getLocalNameFromExpandedNameID

public String getLocalNameFromExpandedNameID(int parm1)
Specified by:
getLocalNameFromExpandedNameID in interface DTM
Overrides:
getLocalNameFromExpandedNameID in interface DTMDefaultBase
Parameters:
parm1 -

getNamespaceFromExpandedNameID

public String getNamespaceFromExpandedNameID(int parm1)
Specified by:
getNamespaceFromExpandedNameID in interface DTM
Overrides:
getNamespaceFromExpandedNameID in interface DTMDefaultBase
Parameters:
parm1 -

getNamespaceType

public int getNamespaceType(int parm1)
Overrides:
getNamespaceType in interface DTMDefaultBase
Parameters:
parm1 -

getNamespaceURI

public String getNamespaceURI(int parm1)
Specified by:
getNamespaceURI in interface DTM
Overrides:
getNamespaceURI in interface DTMDefaultBase
Parameters:
parm1 -

getNextAttribute

public int getNextAttribute(int parm1)
Specified by:
getNextAttribute in interface DTM
Overrides:
getNextAttribute in interface DTMDefaultBase
Parameters:
parm1 -

getNextNamespaceNode

public int getNextNamespaceNode(int parm1,
                                int parm2,
                                boolean parm3)
Specified by:
getNextNamespaceNode in interface DTM
Overrides:
getNextNamespaceNode in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -
parm3 -

getNextSibling

public int getNextSibling(int parm1)
Specified by:
getNextSibling in interface DTM
Overrides:
getNextSibling in interface DTMDefaultBase
Parameters:
parm1 -

getNode

public Node getNode(int parm1)
Specified by:
getNode in interface DTM
Overrides:
getNode in interface DTMDefaultBase
Parameters:
parm1 -

getNodeName

public String getNodeName(int parm1)
Specified by:
getNodeName in interface DTM
Overrides:
getNodeName in interface DTMDefaultBase
Parameters:
parm1 -

getNodeNameX

public String getNodeNameX(int parm1)
Specified by:
getNodeNameX in interface DTM
Overrides:
getNodeNameX in interface DTMDefaultBase
Parameters:
parm1 -

getNodeType

public short getNodeType(int parm1)
Specified by:
getNodeType in interface DTM
Overrides:
getNodeType in interface DTMDefaultBase
Parameters:
parm1 -

getNodeValue

public String getNodeValue(int parm1)
Specified by:
getNodeValue in interface DTM
Overrides:
getNodeValue in interface DTMDefaultBase
Parameters:
parm1 -

getOwnerDocument

public int getOwnerDocument(int parm1)
Specified by:
getOwnerDocument in interface DTM
Overrides:
getOwnerDocument in interface DTMDefaultBase
Parameters:
parm1 -

getParent

public int getParent(int parm1)
Specified by:
getParent in interface DTM
Overrides:
getParent in interface DTMDefaultBase
Parameters:
parm1 -

getPrefix

public String getPrefix(int parm1)
Specified by:
getPrefix in interface DTM
Overrides:
getPrefix in interface DTMDefaultBase
Parameters:
parm1 -

getPreviousSibling

public int getPreviousSibling(int parm1)
Specified by:
getPreviousSibling in interface DTM
Overrides:
getPreviousSibling in interface DTMDefaultBase
Parameters:
parm1 -

getSourceLocatorFor

public SourceLocator getSourceLocatorFor(int node)
No source information is available for DOM2DTM, so return null here.
Specified by:
getSourceLocatorFor in interface DTM
Parameters:
node - an int value
Returns:
null

getStringValue

public 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).
Specified by:
getStringValue in interface DTM
Overrides:
getStringValue in interface DTMDefaultBase
Parameters:
nodeHandle - The node ID.
Returns:
A string object that represents the string-value of the given node.

getStringValueChunk

public char[] getStringValueChunk(int parm1,
                                  int parm2,
                                  int[] parm3)
Specified by:
getStringValueChunk in interface DTM
Overrides:
getStringValueChunk in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -
parm3 -

getStringValueChunkCount

public int getStringValueChunkCount(int parm1)
Specified by:
getStringValueChunkCount in interface DTM
Overrides:
getStringValueChunkCount in interface DTMDefaultBase
Parameters:
parm1 -

getTypedAxisIterator

public DTMAxisIterator getTypedAxisIterator(int parm1,
                                            int parm2)
Specified by:
getTypedAxisIterator in interface DTM
Overrides:
getTypedAxisIterator in interface DTMDefaultBaseIterators
Parameters:
parm1 -
parm2 -

getUnparsedEntityURI

public String getUnparsedEntityURI(String parm1)
Specified by:
getUnparsedEntityURI in interface DTM
Overrides:
getUnparsedEntityURI in interface DTMDefaultBase
Parameters:
parm1 -

hasChildNodes

public boolean hasChildNodes(int parm1)
Specified by:
hasChildNodes in interface DTM
Overrides:
hasChildNodes in interface DTMDefaultBase
Parameters:
parm1 -

isAttributeSpecified

public boolean isAttributeSpecified(int parm1)
Specified by:
isAttributeSpecified in interface DTM
Overrides:
isAttributeSpecified in interface DTMDefaultBase
Parameters:
parm1 -

isCharacterElementContentWhitespace

public boolean isCharacterElementContentWhitespace(int parm1)
Specified by:
isCharacterElementContentWhitespace in interface DTM
Overrides:
isCharacterElementContentWhitespace in interface DTMDefaultBase
Parameters:
parm1 -

isDocumentAllDeclarationsProcessed

public boolean isDocumentAllDeclarationsProcessed(int parm1)
Specified by:
isDocumentAllDeclarationsProcessed in interface DTM
Overrides:
isDocumentAllDeclarationsProcessed in interface DTMDefaultBase
Parameters:
parm1 -

isNodeAfter

public boolean isNodeAfter(int parm1,
                           int parm2)
Specified by:
isNodeAfter in interface DTM
Overrides:
isNodeAfter in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -

isSupported

public boolean isSupported(String parm1,
                           String parm2)
Specified by:
isSupported in interface DTM
Overrides:
isSupported in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -

needsTwoThreads

public boolean needsTwoThreads()
Specified by:
needsTwoThreads in interface DTM

setDocumentBaseURI

public void setDocumentBaseURI(String parm1)
Specified by:
setDocumentBaseURI in interface DTM
Overrides:
setDocumentBaseURI in interface DTMDefaultBase
Parameters:
parm1 -

setFeature

public void setFeature(String parm1,
                       boolean parm2)
Specified by:
setFeature in interface DTM
Overrides:
setFeature in interface DTMDefaultBase
Parameters:
parm1 -
parm2 -

setProperty

public void setProperty(String property,
                        Object value)
For the moment all the run time properties are ignored by this class.
Specified by:
setProperty in interface DTM
Parameters:
property - a String value
value - an Object value

supportsPreStripping

public boolean supportsPreStripping()
Event overriding for Debug
Specified by:
supportsPreStripping in interface DTM
Overrides:
supportsPreStripping in interface DTMDefaultBase

Copyright B) 2005 Apache XML Project. All Rights Reserved.