org.apache.xml.dtm.ref.sax2dtm.SAX2DTM

All Implemented Interfaces:: DTM, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler

Direct Known Subclasses:: SAX2DTM2, SAX2RTFDTM

public class SAX2DTM
extends DTMDefaultBaseIterators
implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler, DeclHandler, LexicalHandler

This class implements a DTM that tends to be optimized more for speed than for compactness, that is constructed via SAX2 ContentHandler events.

Nested Class Summary

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
Modifier and Type	Field	Description
`protected FastStringBuffer`	`m_chars`	All the character content, including attribute values, are stored in this buffer.
`protected int`	`m_coalescedTextType`	Type of coalesced text block.
`protected IntStack`	`m_contextIndexes`	Namespace support, only relevent at construction time.
`protected SuballocatedIntVector`	`m_data`	This vector holds offset and length data.
`protected SuballocatedIntVector`	`m_dataOrQName`	Data or qualified name values, one array element for each node.
`protected boolean`	`m_endDocumentOccured`	End document has been reached.
`protected Hashtable`	`m_idAttributes`	This table holds the ID string to node associations, for XML IDs.
`protected boolean`	`m_insideDTD`	We are inside the DTD.
`protected Locator`	`m_locator`	The SAX Document locator
`protected IntStack`	`m_parents`	The parent stack, needed only for construction.
`protected Vector`	`m_prefixMappings`	Namespace support, only relevent at construction time.
`protected int`	`m_previous`	The current previous node, needed only for construction time.
`protected IntVector`	`m_sourceColumn`	Made protected for access by SAX2RTFDTM.
`protected IntVector`	`m_sourceLine`	Made protected for access by SAX2RTFDTM.
`protected StringVector`	`m_sourceSystemId`	Made protected for access by SAX2RTFDTM.
`protected int`	`m_textPendingStart`	The starting offset within m_chars for the text or CDATA_SECTION node currently being acumulated, or -1 if there is no text node in progress
`protected int`	`m_textType`	Type of next characters() event within text block in prgress.
`protected boolean`	`m_useSourceLocationProperty`	Describes whether information about document source location should be maintained or not.
`protected DTMStringPool`	`m_valuesOrPrefixes`	pool of string values that come as strings.
`protected DTMTreeWalker`	`m_walker`	Tree Walker for dispatchToEvents.

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	Description
`SAX2DTM(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)`	Construct a SAX2DTM object using the default block size.
`SAX2DTM(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing, int blocksize, boolean usePrevsib, boolean newNameTable)`	Construct a SAX2DTM object ready to be constructed from SAX2 ContentHandler events.

Method Summary

Modifier and Type	Method	Description
`protected int`	`_dataOrQName(int identity)`	Get the data or qualified name for the given node identity.
`protected void`	`addNewDTMID(int nodeIndex)`	Get a new DTM ID beginning at the specified node index.
`protected int`	`addNode(int type, int expandedTypeID, int parentIndex, int previousSibling, int dataOrPrefix, boolean canHaveFirstChild)`	Construct the node map from the node.
`void`	`attributeDecl(String eName, String aName, String type, String valueDefault, String value)`	Report an attribute type declaration.
`void`	`characters(char[] ch, int start, int length)`	Receive notification of character data inside an element.
`protected void`	`charactersFlush()`	Check whether accumulated text should be stripped; if not, append the appropriate flavor of text/cdata node.
`void`	`clearCoRoutine()`	Ask the CoRoutine parser to doTerminate and clear the reference.
`void`	`clearCoRoutine(boolean callDoTerminate)`	Ask the CoRoutine parser to doTerminate and clear the reference.
`void`	`comment(char[] ch, int start, int length)`	Report an XML comment anywhere in the document.
`protected boolean`	`declAlreadyDeclared(String prefix)`	Check if a declaration has already been made for a given prefix.
`void`	`dispatchCharactersEvents(int nodeHandle, 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, ContentHandler ch)`	Directly create SAX parser events from a subtree.
`void`	`elementDecl(String name, String model)`	Report an element type declaration.
`void`	`endCDATA()`	Report the end of a CDATA section.
`void`	`endDocument()`	Receive notification of the end of the document.
`void`	`endDTD()`	Report the end of DTD declarations.
`void`	`endElement(String uri, String localName, String qName)`	Receive notification of the end of an element.
`void`	`endEntity(String name)`	Report the end of an entity.
`void`	`endPrefixMapping(String prefix)`	Receive notification of the end of a Namespace mapping.
`void`	`error(SAXParseException e)`	Receive notification of a recoverable parser error.
`void`	`externalEntityDecl(String name, String publicId, String systemId)`	Report a parsed external entity declaration.
`void`	`fatalError(SAXParseException e)`	Report a fatal XML parsing error.
`int`	`getAttributeNode(int nodeHandle, String namespaceURI, String name)`	Retrieves an attribute node by by qualified name and namespace URI.
`ContentHandler`	`getContentHandler()`	getContentHandler returns "our SAX builder" -- the thing that someone else should send SAX events to in order to extend this DTM model.
`DeclHandler`	`getDeclHandler()`	Return this DTM's DeclHandler.
`String`	`getDocumentTypeDeclarationPublicIdentifier()`	Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML].
`String`	`getDocumentTypeDeclarationSystemIdentifier()`	A document type declaration information item has the following properties: 1.
`DTDHandler`	`getDTDHandler()`	Return this DTM's DTDHandler.
`int`	`getElementById(String elementId)`	Returns the `Element` whose `ID` is given by `elementId`.
`EntityResolver`	`getEntityResolver()`	Return this DTM's EntityResolver.
`ErrorHandler`	`getErrorHandler()`	Return this DTM's ErrorHandler.
`String`	`getFixedNames(int type)`
`int`	`getIdForNamespace(String uri)`	Get a prefix either from the uri mapping, or just make one up!
`LexicalHandler`	`getLexicalHandler()`	Return this DTM's lexical handler.
`String`	`getLocalName(int nodeHandle)`	Given a node handle, return its XPath-style localname.
`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.)
`String`	`getNamespaceURI(String prefix)`	Get a prefix either from the qname or from the uri mapping, or just make one up!
`protected int`	`getNextNodeIdentity(int identity)`	Get the next node identity value in the list, and call the iterator if it hasn't been added yet.
`String`	`getNodeName(int nodeHandle)`	Given a node handle, return its DOM-style node name.
`String`	`getNodeNameX(int nodeHandle)`	Given a node handle, return the XPath node name.
`String`	`getNodeValue(int nodeHandle)`	Given a node handle, return its node value.
`int`	`getNumberOfNodes()`	Get the number of nodes that have been added.
`String`	`getPrefix(int nodeHandle)`	Given a namespace handle, return the prefix that the namespace decl is mapping.
`String`	`getPrefix(String qname, String uri)`	Get a prefix either from the qname or from the uri mapping, or just make one up!
`SourceLocator`	`getSourceLocatorFor(int node)`	Retrieve the SourceLocator associated with a specific node.
`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).
`String`	`getUnparsedEntityURI(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]).
`void`	`ignorableWhitespace(char[] ch, int start, int length)`	Receive notification of ignorable whitespace in element content.
`void`	`internalEntityDecl(String name, String value)`	Report an internal entity declaration.
`boolean`	`isAttributeSpecified(int attributeHandle)`	5.
`boolean`	`isWhitespace(int nodeHandle)`	Determine if the string-value of a node is whitespace
`void`	`migrateTo(DTMManager manager)`	Migrate a DTM built with an old DTMManager to a new DTMManager.
`boolean`	`needsTwoThreads()`
`protected boolean`	`nextNode()`	This method should try and build one or more nodes in the table.
`void`	`notationDecl(String name, String publicId, String systemId)`	Receive notification of a notation declaration.
`void`	`processingInstruction(String target, String data)`	Receive notification of a processing instruction.
`InputSource`	`resolveEntity(String publicId, String systemId)`	Resolve an external entity.
`void`	`setDocumentLocator(Locator locator)`	Receive a Locator object for document events.
`void`	`setIDAttribute(String id, int elem)`	Set an ID string to node association in the ID table.
`void`	`setIncrementalSAXSource(IncrementalSAXSource incrementalSAXSource)`	Bind a IncrementalSAXSource to this DTM.
`void`	`setProperty(String property, Object value)`	Set a run time property for this DTM instance.
`protected void`	`setSourceLocation()`	Store the source location of the current node.
`void`	`setUseSourceLocation(boolean useSourceLocation)`	Set whether information about document source location should be maintained or not.
`void`	`skippedEntity(String name)`	Receive notification of a skipped entity.
`void`	`startCDATA()`	Report the start of a CDATA section.
`void`	`startDocument()`	Receive notification of the beginning of the document.
`void`	`startDTD(String name, String publicId, String systemId)`	Report the start of DTD declarations, if any.
`void`	`startElement(String uri, String localName, String qName, Attributes attributes)`	Receive notification of the start of an element.
`void`	`startEntity(String name)`	Report the beginning of an entity in content.
`void`	`startPrefixMapping(String prefix, String uri)`	Receive notification of the start of a Namespace mapping.
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notationName)`	Receive notification of an unparsed entity declaration.
`void`	`warning(SAXParseException e)`	Receive notification of a parser warning.

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

_exptype, _firstch, _level, _nextsib, _parent, _prevsib, _type, appendChild, appendTextChild, declareNamespaceInContext, documentRegistration, documentRelease, dumpDTM, dumpNode, ensureSizeOfIndex, error, findGTE, findInSortedSuballocatedIntVector, findNamespaceContext, getDocument, getDocumentAllDeclarationsProcessed, getDocumentBaseURI, getDocumentEncoding, getDocumentRoot, getDocumentStandalone, getDocumentSystemIdentifier, getDocumentVersion, getDTMIDs, getExpandedTypeID, getExpandedTypeID, getFirstAttribute, getFirstAttributeIdentity, getFirstChild, getFirstNamespaceNode, getLastChild, getLevel, getLocalNameFromExpandedNameID, getManager, getNamespaceFromExpandedNameID, getNamespaceType, getNextAttribute, getNextAttributeIdentity, getNextNamespaceNode, getNextSibling, getNode, getNodeHandle, getNodeIdent, getNodeType, getOwnerDocument, getParent, getPreviousSibling, getShouldStripWhitespace, getStringValueChunk, getStringValueChunkCount, getTypedAttribute, getTypedFirstChild, getTypedNextSibling, hasChildNodes, indexNode, isCharacterElementContentWhitespace, isDocumentAllDeclarationsProcessed, isNodeAfter, isSupported, makeNodeHandle, makeNodeIdentity, popShouldStripWhitespace, pushShouldStripWhitespace, setDocumentBaseURI, setFeature, setShouldStripWhitespace, supportsPreStripping

Methods inherited from class java.lang.Object

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

Field Details
- m_chars
  
  protected FastStringBuffer m_chars
  
  All the character content, including attribute values, are stored in this buffer. %REVIEW% Should this have an option of being shared across DTMs? Sequentially only; not threadsafe... Currently, I think not. %REVIEW% Initial size was pushed way down to reduce weight of RTFs. pending reduction in number of RTF DTMs. Now that we're sharing a DTM between RTFs, and tail-pruning... consider going back to the larger/faster. Made protected rather than private so SAX2RTFDTM can access it.
- m_data
  
  protected SuballocatedIntVector m_data
  
  This vector holds offset and length data.
- m_parents
  
  protected transient IntStack m_parents
  
  The parent stack, needed only for construction. Made protected rather than private so SAX2RTFDTM can access it.
- m_previous
  
  protected transient int m_previous
  
  The current previous node, needed only for construction time. Made protected rather than private so SAX2RTFDTM can access it.
- m_prefixMappings
  
  protected transient Vector m_prefixMappings
  
  Namespace support, only relevent at construction time. Made protected rather than private so SAX2RTFDTM can access it.
- m_contextIndexes
  
  protected transient IntStack m_contextIndexes
  
  Namespace support, only relevent at construction time. Made protected rather than private so SAX2RTFDTM can access it.
- m_textType
  
  protected transient int m_textType
  
  Type of next characters() event within text block in prgress.
- m_coalescedTextType
  
  protected transient int m_coalescedTextType
  
  Type of coalesced text block. See logic in the characters() method.
- m_locator
  
  protected transient Locator m_locator
  
  The SAX Document locator
- m_insideDTD
  
  protected transient boolean m_insideDTD
  
  We are inside the DTD. This is used for ignoring comments.
- m_walker
  
  protected DTMTreeWalker m_walker
  
  Tree Walker for dispatchToEvents.
- m_valuesOrPrefixes
  
  protected DTMStringPool m_valuesOrPrefixes
  
  pool of string values that come as strings.
- m_endDocumentOccured
  
  protected boolean m_endDocumentOccured
  
  End document has been reached. Made protected rather than private so SAX2RTFDTM can access it.
- m_dataOrQName
  
  protected SuballocatedIntVector m_dataOrQName
  
  Data or qualified name values, one array element for each node.
- m_idAttributes
  
  protected Hashtable m_idAttributes
  
  This table holds the ID string to node associations, for XML IDs.
- m_textPendingStart
  
  protected int m_textPendingStart
  
  The starting offset within m_chars for the text or CDATA_SECTION node currently being acumulated, or -1 if there is no text node in progress
- m_useSourceLocationProperty
  
  protected boolean m_useSourceLocationProperty
  
  Describes whether information about document source location should be maintained or not. Made protected for access by SAX2RTFDTM.
- m_sourceSystemId
  
  protected StringVector m_sourceSystemId
  
  Made protected for access by SAX2RTFDTM.
- m_sourceLine
  
  protected IntVector m_sourceLine
  
  Made protected for access by SAX2RTFDTM.
- m_sourceColumn
  
  protected IntVector m_sourceColumn
  
  Made protected for access by SAX2RTFDTM.
Constructor Details
- SAX2DTM
  
  public SAX2DTM(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)
  
  Construct a SAX2DTM object using the default block size.
  
  Parameters:
  
  mgr - The DTMManager who owns this DTM.
  
  source - the JAXP 1.1 Source object for this DTM.
  
  dtmIdentity - The DTM identity ID for this DTM.
  
  whiteSpaceFilter - The white space filter for this DTM, which may be null.
  
  xstringfactory - XMLString factory for creating character content.
  
  doIndexing - true if the caller considers it worth it to use indexing schemes.
- SAX2DTM
  
  public SAX2DTM(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing, int blocksize, boolean usePrevsib, boolean newNameTable)
  
  Construct a SAX2DTM object ready to be constructed from SAX2 ContentHandler events.
  
  Parameters:
  
  mgr - The DTMManager who owns this DTM.
  
  source - the JAXP 1.1 Source object for this DTM.
  
  dtmIdentity - The DTM identity ID for this DTM.
  
  whiteSpaceFilter - The white space filter for this DTM, which may be null.
  
  xstringfactory - XMLString factory for creating character content.
  
  doIndexing - true if the caller considers it worth it to use indexing schemes.
  
  blocksize - The block size of the DTM.
  
  usePrevsib - true if we want to build the previous sibling node array.
  
  newNameTable - true if we want to use a new ExpandedNameTable for this DTM.
Method Details
- setUseSourceLocation
  
  public void setUseSourceLocation(boolean useSourceLocation)
  
  Set whether information about document source location should be maintained or not.
- _dataOrQName
  
  protected int _dataOrQName(int identity)
  
  Get the data or qualified name for the given node identity.
  
  Parameters:
  
  identity - The node identity.
  
  Returns:
  
  The data or qualified name, or DTM.NULL.
- clearCoRoutine
  
  public void clearCoRoutine()
  
  Ask the CoRoutine parser to doTerminate and clear the reference.
- clearCoRoutine
  
  public void clearCoRoutine(boolean callDoTerminate)
  
  Ask the CoRoutine parser to doTerminate and clear the reference. If the CoRoutine parser has already been cleared, this will have no effect.
  
  Parameters:
  
  callDoTerminate - true of doTerminate should be called on the coRoutine parser.
- setIncrementalSAXSource
  
  public void setIncrementalSAXSource(IncrementalSAXSource incrementalSAXSource)
  
  Bind a IncrementalSAXSource to this DTM. If we discover we need nodes that have not yet been built, we will ask this object to send us more events, and it will manage interactions with its data sources. Note that we do not actually build the IncrementalSAXSource, since we don't know what source it's reading from, what thread that source will run in, or when it will run.
  
  Parameters:
  
  incrementalSAXSource - The parser that we want to recieve events from on demand.
- getContentHandler
  
  public ContentHandler getContentHandler()
  
  getContentHandler returns "our SAX builder" -- the thing that someone else should send SAX events to in order to extend this DTM model. %REVIEW% Should this return null if constrution already done/begun?
  
  Specified by:
  
  getContentHandler in interface DTM
  
  Returns:
  
  null if this model doesn't respond to SAX events, "this" if the DTM object has a built-in SAX ContentHandler, the IncrementalSAXSource if we're bound to one and should receive the SAX stream via it for incremental build purposes...
- getLexicalHandler
  
  public LexicalHandler getLexicalHandler()
  
  Return this DTM's lexical handler. %REVIEW% Should this return null if constrution already done/begun?
  
  Specified by:
  
  getLexicalHandler in interface DTM
  
  Returns:
  
  null if this model doesn't respond to lexical SAX events, "this" if the DTM object has a built-in SAX ContentHandler, the IncrementalSAXSource if we're bound to one and should receive the SAX stream via it for incremental build purposes...
- getEntityResolver
  
  public EntityResolver getEntityResolver()
  
  Return this DTM's EntityResolver.
  
  Specified by:
  
  getEntityResolver in interface DTM
  
  Returns:
  
  null if this model doesn't respond to SAX entity ref events.
- getDTDHandler
  
  public DTDHandler getDTDHandler()
  
  Return this DTM's DTDHandler.
  
  Specified by:
  
  getDTDHandler in interface DTM
  
  Returns:
  
  null if this model doesn't respond to SAX dtd events.
- getErrorHandler
  
  public ErrorHandler getErrorHandler()
  
  Return this DTM's ErrorHandler.
  
  Specified by:
  
  getErrorHandler in interface DTM
  
  Returns:
  
  null if this model doesn't respond to SAX error events.
- getDeclHandler
  
  public DeclHandler getDeclHandler()
  
  Return this DTM's DeclHandler.
  
  Specified by:
  
  getDeclHandler in interface DTM
  
  Returns:
  
  null if this model doesn't respond to SAX Decl events.
- needsTwoThreads
  
  public boolean needsTwoThreads()
  
  Specified by:
  
  needsTwoThreads in interface DTM
  
  Returns:
  
  true iff we're building this model incrementally (eg we're partnered with a IncrementalSAXSource) and thus require that the transformation and the parse run simultaneously. Guidance to the DTMManager.
- dispatchCharactersEvents
  
  public void dispatchCharactersEvents(int nodeHandle, ContentHandler ch, boolean normalize) throws SAXException
  
  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). Multiple calls to the ContentHandler's characters methods may well occur for a single call to this method.
  
  Specified by:
  
  dispatchCharactersEvents in interface DTM
  
  Specified by:
  
  dispatchCharactersEvents in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - The node ID.
  
  ch - A non-null reference to a ContentHandler.
  
  normalize - true if the content should be normalized according to the rules for the XPath normalize-space function.
  
  Throws:
  
  SAXException
- getNodeName
  
  public String getNodeName(int nodeHandle)
  
  Given a node handle, return its DOM-style node name. This will include names such as #text or #document.
  
  Specified by:
  
  getNodeName in interface DTM
  
  Specified by:
  
  getNodeName in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - the id of the node.
  
  Returns:
  
  String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible... %REVIEW-COMMENT% It should never be empty, should it?
- getNodeNameX
  
  public String getNodeNameX(int nodeHandle)
  
  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 DTM
  
  Overrides:
  
  getNodeNameX in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - the id of the node.
  
  Returns:
  
  String Name of this node, which may be an empty string.
- isAttributeSpecified
  
  public boolean isAttributeSpecified(int attributeHandle)
  
  5. [specified] A flag indicating whether this attribute was actually specified in the start-tag of its element, or was defaulted from the DTD.
  
  Specified by:
  
  isAttributeSpecified in interface DTM
  
  Specified by:
  
  isAttributeSpecified in class DTMDefaultBase
  
  Parameters:
  
  attributeHandle - Must be a valid handle to an attribute node.
  
  Returns:
  
  true if the attribute was specified; false if it was defaulted.
- getDocumentTypeDeclarationSystemIdentifier
  
  public String getDocumentTypeDeclarationSystemIdentifier()
  
  A document type declaration information item has the following properties: 1. [system identifier] The system identifier of the external subset, if it exists. Otherwise this property has no value.
  
  Specified by:
  
  getDocumentTypeDeclarationSystemIdentifier in interface DTM
  
  Specified by:
  
  getDocumentTypeDeclarationSystemIdentifier in class DTMDefaultBase
  
  Returns:
  
  the system identifier String object, or null if there is none.
- getNextNodeIdentity
  
  protected int getNextNodeIdentity(int identity)
  
  Get the next node identity value in the list, and call the iterator if it hasn't been added yet.
  
  Specified by:
  
  getNextNodeIdentity in class DTMDefaultBase
  
  Parameters:
  
  identity - The node identity (index).
  
  Returns:
  
  identity+1, or DTM.NULL.
- dispatchToEvents
  
  public void dispatchToEvents(int nodeHandle, ContentHandler ch) throws SAXException
  
  Directly create SAX parser events from a subtree.
  
  Specified by:
  
  dispatchToEvents in interface DTM
  
  Specified by:
  
  dispatchToEvents in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - The node ID.
  
  ch - A non-null reference to a ContentHandler.
  
  Throws:
  
  SAXException
- getNumberOfNodes
  
  public int getNumberOfNodes()
  
  Get the number of nodes that have been added.
  
  Specified by:
  
  getNumberOfNodes in class DTMDefaultBase
  
  Returns:
  
  The number of that are currently in the tree.
- nextNode
  
  protected boolean nextNode()
  
  This method should try and build one or more nodes in the table.
  
  Specified by:
  
  nextNode in class DTMDefaultBase
  
  Returns:
  
  The true if a next node is found or false if there are no more nodes.
- addNode
  
  protected int addNode(int type, int expandedTypeID, int parentIndex, int previousSibling, int dataOrPrefix, boolean canHaveFirstChild)
  
  Construct the node map from the node.
  
  Parameters:
  
  type - raw type ID, one of DTM.XXX_NODE.
  
  expandedTypeID - The expended type ID.
  
  parentIndex - The current parent index.
  
  previousSibling - The previous sibling index.
  
  dataOrPrefix - index into m_data table, or string handle.
  
  canHaveFirstChild - true if the node can have a first child, false if it is atomic.
  
  Returns:
  
  The index identity of the node that was added.
- addNewDTMID
  
  protected void addNewDTMID(int nodeIndex)
  
  Get a new DTM ID beginning at the specified node index.
  
  Parameters:
  
  nodeIndex - The node identity at which the new DTM ID will begin addressing.
- migrateTo
  
  public void migrateTo(DTMManager manager)
  
  Migrate a DTM built with an old DTMManager to a new DTMManager. After the migration, the new DTMManager will treat the DTM as one that is built by itself. This is used to support DTM sharing between multiple transformations.
  
  Specified by:
  
  migrateTo in interface DTM
  
  Overrides:
  
  migrateTo in class DTMDefaultBase
  
  Parameters:
  
  manager - the DTMManager
- setSourceLocation
  
  protected void setSourceLocation()
  
  Store the source location of the current node. This method must be called as every node is added to the DTM or for no node.
- getNodeValue
  
  public String getNodeValue(int nodeHandle)
  
  Given a node handle, return its node value. This is mostly as defined by the DOM, but may ignore some conveniences.
  
  Specified by:
  
  getNodeValue in interface DTM
  
  Specified by:
  
  getNodeValue in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - The node id.
  
  Returns:
  
  String Value of this node, or null if not meaningful for this node type.
- getLocalName
  
  public String getLocalName(int nodeHandle)
  
  Given a node handle, return its XPath-style localname. (As defined in Namespaces, this is the portion of the name after any colon character).
  
  Specified by:
  
  getLocalName in interface DTM
  
  Specified by:
  
  getLocalName in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - the id of the node.
  
  Returns:
  
  String Local name of this node.
- getUnparsedEntityURI
  
  public String getUnparsedEntityURI(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]). 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. TODO: 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.) TODO: 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 DTM
  
  Specified by:
  
  getUnparsedEntityURI in class DTMDefaultBase
  
  Parameters:
  
  name - A string containing the Entity Name of the unparsed entity.
  
  Returns:
  
  String containing the URI of the Unparsed Entity, or an empty string if no such entity exists.
- getPrefix
  
  public String getPrefix(int nodeHandle)
  
  Given a namespace handle, return the prefix that the namespace decl is mapping. Given a node handle, return the prefix used to map to the namespace.
  %REVIEW% Are you sure you want "" for no prefix?
  
  %REVIEW-COMMENT% I think so... not totally sure. -sb
  
  Specified by:
  
  getPrefix in interface DTM
  
  Specified by:
  
  getPrefix in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - the id of the node.
  
  Returns:
  
  String prefix of this node's name, or "" if no explicit namespace prefix was given.
- getAttributeNode
  
  public int getAttributeNode(int nodeHandle, String namespaceURI, String name)
  
  Retrieves an attribute node by by qualified name and namespace URI.
  
  Specified by:
  
  getAttributeNode in interface DTM
  
  Specified by:
  
  getAttributeNode in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - int Handle of the node upon which to look up this attribute..
  
  namespaceURI - The namespace URI of the attribute to retrieve, or null.
  
  name - The local name of the attribute to retrieve.
  
  Returns:
  
  The attribute node handle with the specified name ( nodeName) or DTM.NULL if there is no such attribute.
- getDocumentTypeDeclarationPublicIdentifier
  
  public String getDocumentTypeDeclarationPublicIdentifier()
  
  Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML]. If there is no external subset or if it has no public identifier, this property has no value.
  
  Specified by:
  
  getDocumentTypeDeclarationPublicIdentifier in interface DTM
  
  Specified by:
  
  getDocumentTypeDeclarationPublicIdentifier in class DTMDefaultBase
  
  Returns:
  
  the public identifier String object, or null if there is none.
- getNamespaceURI
  
  public 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.)
  %REVIEW% Null or ""? -sb
  
  Specified by:
  
  getNamespaceURI in interface DTM
  
  Specified by:
  
  getNamespaceURI in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - the id of the node.
  
  Returns:
  
  String URI value of this node's namespace, or null if no namespace was resolved.
- 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
  
  Specified by:
  
  getStringValue in class DTMDefaultBase
  
  Parameters:
  
  nodeHandle - The node ID.
  
  Returns:
  
  A string object that represents the string-value of the given node.
- isWhitespace
  
  public boolean isWhitespace(int nodeHandle)
  
  Determine if the string-value of a node is whitespace
  
  Parameters:
  
  nodeHandle - The node Handle.
  
  Returns:
  
  Return true if the given node is whitespace.
- getElementById
  
  public int getElementById(String elementId)
  
  Returns the Element whose ID is given by elementId. If no such element exists, returns DTM.NULL. Behavior is not defined if more than one element has this ID. Attributes (including those with the name "ID") are not of type ID unless so defined by DTD/Schema information available to the DTM implementation. Implementations that do not know whether attributes are of type ID or not are expected to return DTM.NULL.
  %REVIEW% Presumably IDs are still scoped to a single document, and this operation searches only within a single document, right? Wouldn't want collisions between DTMs in the same process.
  
  Specified by:
  
  getElementById in interface DTM
  
  Specified by:
  
  getElementById in class DTMDefaultBase
  
  Parameters:
  
  elementId - The unique id value for an element.
  
  Returns:
  
  The handle of the matching element.
- getPrefix
  
  public String getPrefix(String qname, String uri)
  
  Get a prefix either from the qname or from the uri mapping, or just make one up!
  
  Parameters:
  
  qname - The qualified name, which may be null.
  
  uri - The namespace URI, which may be null.
  
  Returns:
  
  The prefix if there is one, or null.
- getIdForNamespace
  
  public int getIdForNamespace(String uri)
  
  Get a prefix either from the uri mapping, or just make one up!
  
  Parameters:
  
  uri - The namespace URI, which may be null.
  
  Returns:
  
  The prefix if there is one, or null.
- getNamespaceURI
  
  public String getNamespaceURI(String prefix)
  
  Get a prefix either from the qname or from the uri mapping, or just make one up!
  
  Returns:
  
  The prefix if there is one, or null.
- setIDAttribute
  
  public void setIDAttribute(String id, int elem)
  
  Set an ID string to node association in the ID table.
  
  Parameters:
  
  id - The ID string.
  
  elem - The associated element handle.
- charactersFlush
  
  protected void charactersFlush()
  
  Check whether accumulated text should be stripped; if not, append the appropriate flavor of text/cdata node.
- resolveEntity
  
  public InputSource resolveEntity(String publicId, String systemId) throws SAXException
  
  Resolve an external entity.
  Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.
  
  Specified by:
  
  resolveEntity in interface EntityResolver
  
  Parameters:
  
  publicId - The public identifer, or null if none is available.
  
  systemId - The system identifier provided in the XML document.
  
  Returns:
  
  The new input source, or null to require the default behaviour.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  SAXException
  
  See Also:
  
  EntityResolver.resolveEntity(java.lang.String, java.lang.String)
- notationDecl
  
  public void notationDecl(String name, String publicId, String systemId) throws SAXException
  
  Receive notification of a notation declaration.
  By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.
  
  Specified by:
  
  notationDecl in interface DTDHandler
  
  Parameters:
  
  name - The notation name.
  
  publicId - The notation public identifier, or null if not available.
  
  systemId - The notation system identifier.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  SAXException
  
  See Also:
  
  DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
- unparsedEntityDecl
  
  public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
  
  Receive notification of an unparsed entity declaration.
  By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.
  
  Specified by:
  
  unparsedEntityDecl in interface DTDHandler
  
  Parameters:
  
  name - The entity name.
  
  publicId - The entity public identifier, or null if not available.
  
  systemId - The entity system identifier.
  
  notationName - The name of the associated notation.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  SAXException
  
  See Also:
  
  DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- setDocumentLocator
  
  public void setDocumentLocator(Locator locator)
  
  Receive a Locator object for document events.
  By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.
  
  Specified by:
  
  setDocumentLocator in interface ContentHandler
  
  Parameters:
  
  locator - A locator for all SAX document events.
  
  See Also:
  
  ContentHandler.setDocumentLocator(org.xml.sax.Locator), Locator
- startDocument
  
  public void startDocument() throws SAXException
  
  Receive notification of the beginning of the document.
  
  Specified by:
  
  startDocument in interface ContentHandler
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.startDocument()
- endDocument
  
  public void endDocument() throws SAXException
  
  Receive notification of the end of the document.
  
  Specified by:
  
  endDocument in interface ContentHandler
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.endDocument()
- startPrefixMapping
  
  public void startPrefixMapping(String prefix, String uri) throws SAXException
  
  Receive notification of the start of a Namespace mapping.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).
  
  Specified by:
  
  startPrefixMapping in interface ContentHandler
  
  Parameters:
  
  prefix - The Namespace prefix being declared.
  
  uri - The Namespace URI mapped to the prefix.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
- endPrefixMapping
  
  public void endPrefixMapping(String prefix) throws SAXException
  
  Receive notification of the end of a Namespace mapping.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.
  
  Specified by:
  
  endPrefixMapping in interface ContentHandler
  
  Parameters:
  
  prefix - The Namespace prefix being declared.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.endPrefixMapping(java.lang.String)
- declAlreadyDeclared
  
  protected boolean declAlreadyDeclared(String prefix)
  
  Check if a declaration has already been made for a given prefix.
  
  Parameters:
  
  prefix - non-null prefix string.
  
  Returns:
  
  true if the declaration has already been declared in the current context.
- startElement
  
  public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
  
  Receive notification of the start of an element.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).
  
  Specified by:
  
  startElement in interface ContentHandler
  
  Parameters:
  
  uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
  
  localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
  
  qName - The qualified name (with prefix), or the empty string if qualified names are not available.
  
  attributes - The specified or defaulted attributes.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
- endElement
  
  public void endElement(String uri, String localName, String qName) throws SAXException
  
  Receive notification of the end of an element.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
  
  Specified by:
  
  endElement in interface ContentHandler
  
  Parameters:
  
  uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
  
  localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
  
  qName - The qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
- characters
  
  public void characters(char[] ch, int start, int length) throws SAXException
  
  Receive notification of character data inside an element.
  By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).
  
  Specified by:
  
  characters in interface ContentHandler
  
  Parameters:
  
  ch - The characters.
  
  start - The start position in the character array.
  
  length - The number of characters to use from the character array.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.characters(char[], int, int)
- ignorableWhitespace
  
  public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
  
  Receive notification of ignorable whitespace in element content.
  By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).
  
  Specified by:
  
  ignorableWhitespace in interface ContentHandler
  
  Parameters:
  
  ch - The whitespace characters.
  
  start - The start position in the character array.
  
  length - The number of characters to use from the character array.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.ignorableWhitespace(char[], int, int)
- processingInstruction
  
  public void processingInstruction(String target, String data) throws SAXException
  
  Receive notification of a processing instruction.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.
  
  Specified by:
  
  processingInstruction in interface ContentHandler
  
  Parameters:
  
  target - The processing instruction target.
  
  data - The processing instruction data, or null if none is supplied.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.processingInstruction(java.lang.String, java.lang.String)
- skippedEntity
  
  public void skippedEntity(String name) throws SAXException
  
  Receive notification of a skipped entity.
  By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.
  
  Specified by:
  
  skippedEntity in interface ContentHandler
  
  Parameters:
  
  name - The name of the skipped entity.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ContentHandler.processingInstruction(java.lang.String, java.lang.String)
- warning
  
  public void warning(SAXParseException e) throws SAXException
  
  Receive notification of a parser warning.
  The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.
  
  Specified by:
  
  warning in interface ErrorHandler
  
  Parameters:
  
  e - The warning information encoded as an exception.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException
- error
  
  public void error(SAXParseException e) throws SAXException
  
  Receive notification of a recoverable parser error.
  The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.
  
  Specified by:
  
  error in interface ErrorHandler
  
  Parameters:
  
  e - The warning information encoded as an exception.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ErrorHandler.warning(org.xml.sax.SAXParseException), SAXParseException
- fatalError
  
  public void fatalError(SAXParseException e) throws SAXException
  
  Report a fatal XML parsing error.
  The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.
  
  Specified by:
  
  fatalError in interface ErrorHandler
  
  Parameters:
  
  e - The error information encoded as an exception.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  ErrorHandler.fatalError(org.xml.sax.SAXParseException), SAXParseException
- elementDecl
  
  public void elementDecl(String name, String model) throws SAXException
  
  Report an element type declaration.
  The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all whitespace is removed,and will include the enclosing parentheses.
  
  Specified by:
  
  elementDecl in interface DeclHandler
  
  Parameters:
  
  name - The element type name.
  
  model - The content model as a normalized string.
  
  Throws:
  
  SAXException - The application may raise an exception.
- attributeDecl
  
  public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException
  
  Report an attribute type declaration.
  Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.
  
  Specified by:
  
  attributeDecl in interface DeclHandler
  
  Parameters:
  
  eName - The name of the associated element.
  
  aName - The name of the attribute.
  
  type - A string representing the attribute type.
  
  valueDefault - A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
  
  value - A string representing the attribute's default value, or null if there is none.
  
  Throws:
  
  SAXException - The application may raise an exception.
- internalEntityDecl
  
  public void internalEntityDecl(String name, String value) throws SAXException
  
  Report an internal entity declaration.
  Only the effective (first) declaration for each entity will be reported.
  
  Specified by:
  
  internalEntityDecl in interface DeclHandler
  
  Parameters:
  
  name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
  
  value - The replacement text of the entity.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  externalEntityDecl(java.lang.String, java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- externalEntityDecl
  
  public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException
  
  Report a parsed external entity declaration.
  Only the effective (first) declaration for each entity will be reported.
  
  Specified by:
  
  externalEntityDecl in interface DeclHandler
  
  Parameters:
  
  name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
  
  publicId - The declared public identifier of the entity, or null if none was declared.
  
  systemId - The declared system identifier of the entity.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  internalEntityDecl(java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- startDTD
  
  public void startDTD(String name, String publicId, String systemId) throws SAXException
  
  Report the start of DTD declarations, if any.
  Any declarations are assumed to be in the internal subset unless otherwise indicated by a startEntity event.
  
  Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.
  
  Specified by:
  
  startDTD in interface LexicalHandler
  
  Parameters:
  
  name - The document type name.
  
  publicId - The declared public identifier for the external DTD subset, or null if none was declared.
  
  systemId - The declared system identifier for the external DTD subset, or null if none was declared.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  endDTD(), startEntity(java.lang.String)
- endDTD
  
  public void endDTD() throws SAXException
  
  Report the end of DTD declarations.
  
  Specified by:
  
  endDTD in interface LexicalHandler
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  startDTD(java.lang.String, java.lang.String, java.lang.String)
- startEntity
  
  public void startEntity(String name) throws SAXException
  
  Report the beginning of an entity in content.
  NOTE: entity references in attribute values -- and the start and end of the document entity -- are never reported.
  
  The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.
  
  Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.
  
  Specified by:
  
  startEntity in interface LexicalHandler
  
  Parameters:
  
  name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  endEntity(java.lang.String), DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)

Class SAX2DTM

Nested Class Summary

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

Field Summary

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

Fields inherited from interface org.apache.xml.dtm.DTM

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Details

m_chars

m_data

m_parents

m_previous

m_prefixMappings

m_contextIndexes

m_textType

m_coalescedTextType

m_locator

m_insideDTD

m_walker

m_valuesOrPrefixes

m_endDocumentOccured

m_dataOrQName

m_idAttributes

m_textPendingStart

m_useSourceLocationProperty

m_sourceSystemId

m_sourceLine

m_sourceColumn

Constructor Details

SAX2DTM

SAX2DTM

Method Details

setUseSourceLocation

_dataOrQName

clearCoRoutine

clearCoRoutine

setIncrementalSAXSource

getContentHandler

getLexicalHandler

getEntityResolver

getDTDHandler

getErrorHandler

getDeclHandler

needsTwoThreads

dispatchCharactersEvents

getNodeName

getNodeNameX

isAttributeSpecified

getDocumentTypeDeclarationSystemIdentifier

getNextNodeIdentity

dispatchToEvents

getNumberOfNodes

nextNode

addNode

addNewDTMID

migrateTo

setSourceLocation

getNodeValue

getLocalName

getUnparsedEntityURI

getPrefix

getAttributeNode

getDocumentTypeDeclarationPublicIdentifier

getNamespaceURI

getStringValue

isWhitespace

getElementById

getPrefix

getIdForNamespace

getNamespaceURI

setIDAttribute

charactersFlush

resolveEntity

notationDecl

unparsedEntityDecl