org.apache.xalan.lib.sql

Class SQLDocument

java.lang.Object

org.apache.xml.dtm.ref.DTMDefaultBase

org.apache.xml.dtm.ref.DTMDefaultBaseTraversers

org.apache.xml.dtm.ref.DTMDefaultBaseIterators

org.apache.xalan.lib.sql.DTMDocument

org.apache.xalan.lib.sql.SQLDocument

All Implemented Interfaces:

DTM

public class SQLDocument
extends DTMDocument

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.xalan.lib.sql.DTMDocument

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.xalan.lib.sql.DTMDocument

m_attribute, m_Document_TypeID, m_DocumentIdx, m_ObjectArray, m_TextNode_TypeID, S_ATTRIB_NOT_SUPPORTED, S_DOCUMENT, S_ELEMENT_NODE, S_ISFALSE, S_ISTRUE, S_TEXT_NODE

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

DEFAULT_BLOCKSIZE, DEFAULT_NUMBLOCKS, DEFAULT_NUMBLOCKS_SMALL, m_documentBaseURI, m_dtmIdent, m_elemIndexes, m_expandedNameTable, m_exptype, m_firstch, m_indexing, m_mgr, m_mgrDefault, m_namespaceDeclSetElements, m_namespaceDeclSets, m_nextsib, m_parent, m_prevsib, m_shouldStripWhitespaceStack, m_shouldStripWS, m_size, m_traversers, m_wsfilter, m_xstrf, NOTPROCESSED, ROOTNODE

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

Constructors

Constructor and Description
SQLDocument(DTMManager mgr, int ident)

Method Summary

Modifier and Type	Method and Description
protected int	_nextsib(int identity) Get the next sibling for the given node identity.
SQLWarning	checkWarnings()
void	close(boolean flushConnPool) Close down any resources used by this document.
protected void	createExpandedNameTable() Populate the Expanded Name Table with the Node that we will use.
void	documentRegistration() A dummy routine to satisify the abstract interface.
void	documentRelease() A dummy routine to satisify the abstract interface.
void	execute(XConnection xconn, SQLQueryParser query)
ExpressionContext	getExpressionContext() Return the context used to build this document
static SQLDocument	getNewDocument(ExpressionContext exprContext) This static method simplifies the creation of an SQL Document and allows us to embedd the complexity of creating / handling the dtmIdent inside the document.
boolean	hasErrors() Used by the XConnection to determine if the Document should handle the document differently.
protected boolean	nextNode() This method should try and build one or more nodes in the table.
protected void	setExpressionContext(ExpressionContext expr) When building the SQL Document, we need to store the Expression Context that was used to create the document.
void	skip(int value) Push the record set forward value rows.

Methods inherited from class org.apache.xalan.lib.sql.DTMDocument

_exptype, _firstch, _level, _parent, _prevsib, _type, addAttributeToNode, addElement, addElementWithData, appendChild, appendTextChild, cloneAttributeFromNode, declareNamespaceInContext, dispatchCharactersEvents, dispatchNodeData, dispatchToEvents, dumpDTM, ensureSize, ensureSizeOfIndex, error, findGTE, findInSortedSuballocatedIntVector, findNamespaceContext, getAttributeNode, getAxisIterator, getAxisTraverser, getContentHandler, getDeclHandler, getDocument, getDocumentAllDeclarationsProcessed, getDocumentBaseURI, getDocumentEncoding, getDocumentStandalone, getDocumentSystemIdentifier, getDocumentTypeDeclarationPublicIdentifier, getDocumentTypeDeclarationSystemIdentifier, getDocumentVersion, getDTDHandler, getElementById, getEntityResolver, getErrorHandler, getExpandedTypeID, getExpandedTypeID, getFirstAttribute, getFirstChild, getFirstNamespaceNode, getLastChild, getLevel, getLexicalHandler, getLocalName, getLocalNameFromExpandedNameID, getNamespaceFromExpandedNameID, getNamespaceType, getNamespaceURI, getNextAttribute, getNextNamespaceNode, getNextNodeIdentity, getNextSibling, getNode, getNodeData, getNodeName, getNodeNameX, getNodeType, getNodeValue, getNumberOfNodes, getOwnerDocument, getParent, getPrefix, getPreviousSibling, getShouldStripWhitespace, getSourceLocatorFor, getStringValue, getStringValueChunk, getStringValueChunkCount, getTypedAxisIterator, getUnparsedEntityURI, hasChildNodes, indexNode, isAttributeSpecified, isCharacterElementContentWhitespace, isDocumentAllDeclarationsProcessed, isNodeAfter, isSupported, needsTwoThreads, popShouldStripWhitespace, pushShouldStripWhitespace, setDocumentBaseURI, setFeature, setProperty, setShouldStripWhitespace, supportsPreStripping

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

dumpDTM, dumpNode, getDocumentRoot, getDTMIDs, getFirstAttributeIdentity, getManager, getNextAttributeIdentity, getNodeHandle, getNodeIdent, getTypedAttribute, getTypedFirstChild, getTypedNextSibling, makeNodeHandle, makeNodeIdentity, migrateTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDocument

public SQLDocument(DTMManager mgr,
                   int ident)

Parameters:

mgr -

ident -

Throws:

SQLException

Method Detail

getNewDocument

public static SQLDocument getNewDocument(ExpressionContext exprContext)

This static method simplifies the creation of an SQL Document and allows us to embedd the complexity of creating / handling the dtmIdent inside the document. This type of method may better placed inside the DTMDocument code

setExpressionContext

protected void setExpressionContext(ExpressionContext expr)

When building the SQL Document, we need to store the Expression Context that was used to create the document. This will be se to reference items int he XSLT process such as any variables that were present.

getExpressionContext

public ExpressionContext getExpressionContext()

Return the context used to build this document

execute

public void execute(XConnection xconn,
                    SQLQueryParser query)
             throws SQLException

Throws:

SQLException

skip

public void skip(int value)

Push the record set forward value rows. Used to help in SQL pagination.

Parameters:

value -

createExpandedNameTable

protected void createExpandedNameTable()

Populate the Expanded Name Table with the Node that we will use. Keep a reference of each of the types for access speed.

Overrides:

createExpandedNameTable in class DTMDocument

hasErrors

public boolean hasErrors()

Used by the XConnection to determine if the Document should handle the document differently.

close

public void close(boolean flushConnPool)

Close down any resources used by this document. If an SQL Error occure while the document was being accessed, the SQL Connection used to create this document will be released to the Connection Pool on error. This allows the COnnection Pool to give special attention to any connection that may be in a errored state.

nextNode

protected boolean nextNode()

Description copied from class: DTMDefaultBase

This method should try and build one or more nodes in the table.

Overrides:

nextNode in class DTMDocument

Returns:

_nextsib

protected int _nextsib(int identity)

Description copied from class: DTMDefaultBase

Get the next sibling for the given node identity.

Overrides:

_nextsib in class DTMDocument

Parameters:

identity -

Returns:

documentRegistration

public void documentRegistration()

Description copied from class: DTMDefaultBase

A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification of registration, they can override this method.

Specified by:

documentRegistration in interface DTM

Overrides:

documentRegistration in class DTMDefaultBase

documentRelease

public void documentRelease()

Description copied from class: DTMDefaultBase

A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification when the document is being released, they can override this method

Specified by:

documentRelease in interface DTM

Overrides:

documentRelease in class DTMDefaultBase

checkWarnings

public SQLWarning checkWarnings()