org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM

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.
Constructor Summary
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
voidattributeDecl(String eName, String aName, String type, String valueDefault, String value)
Report an attribute type declaration.
voidcharacters(char[] ch, int start, int length)
Receive notification of character data inside an element.
voidclearCoRoutine()
Ask the CoRoutine parser to doTerminate and clear the reference.
voidclearCoRoutine(boolean callDoTerminate)
Ask the CoRoutine parser to doTerminate and clear the reference.
voidcomment(char[] ch, int start, int length)
Report an XML comment anywhere in the document.
voiddispatchCharactersEvents(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).
voiddispatchToEvents(int nodeHandle, ContentHandler ch)
Directly create SAX parser events from a subtree.
voidelementDecl(String name, String model)
Report an element type declaration.
voidendCDATA()
Report the end of a CDATA section.
voidendDocument()
Receive notification of the end of the document.
voidendDTD()
Report the end of DTD declarations.
voidendElement(String uri, String localName, String qName)
Receive notification of the end of an element.
voidendEntity(String name)
Report the end of an entity.
voidendPrefixMapping(String prefix)
Receive notification of the end of a Namespace mapping.
voiderror(SAXParseException e)
Receive notification of a recoverable parser error.
voidexternalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.
voidfatalError(SAXParseException e)
Report a fatal XML parsing error.
intgetAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.
ContentHandlergetContentHandler()
getContentHandler returns "our SAX builder" -- the thing that someone else should send SAX events to in order to extend this DTM model.
DeclHandlergetDeclHandler()
Return this DTM's DeclHandler.
StringgetDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML].
StringgetDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties: 1. [system identifier] The system identifier of the external subset, if it exists.
DTDHandlergetDTDHandler()
Return this DTM's DTDHandler.
intgetElementById(String elementId)
Returns the Element whose ID is given by elementId.
EntityResolvergetEntityResolver()
Return this DTM's EntityResolver.
ErrorHandlergetErrorHandler()
Return this DTM's ErrorHandler.
StringgetFixedNames(int type)
intgetIdForNamespace(String uri)
Get a prefix either from the uri mapping, or just make one up!
LexicalHandlergetLexicalHandler()
Return this DTM's lexical handler.
StringgetLocalName(int nodeHandle)
Given a node handle, return its XPath-style localname.
StringgetNamespaceURI(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.)
StringgetNamespaceURI(String prefix)
Get a prefix either from the qname or from the uri mapping, or just make one up!
StringgetNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name.
StringgetNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name.
StringgetNodeValue(int nodeHandle)
Given a node handle, return its node value.
intgetNumberOfNodes()
Get the number of nodes that have been added.
StringgetPrefix(int nodeHandle)
Given a namespace handle, return the prefix that the namespace decl is mapping.
StringgetPrefix(String qname, String uri)
Get a prefix either from the qname or from the uri mapping, or just make one up!
SourceLocatorgetSourceLocatorFor(int node)
Retrieve the SourceLocator associated with a specific node.
XMLStringgetStringValue(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).
StringgetUnparsedEntityURI(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]).
voidignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.
voidinternalEntityDecl(String name, String value)
Report an internal entity declaration.
booleanisAttributeSpecified(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.
booleanisWhitespace(int nodeHandle)
Determine if the string-value of a node is whitespace
voidmigrateTo(DTMManager manager)
Migrate a DTM built with an old DTMManager to a new DTMManager.
booleanneedsTwoThreads()
voidnotationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration.
voidprocessingInstruction(String target, String data)
Receive notification of a processing instruction.
InputSourceresolveEntity(String publicId, String systemId)
Resolve an external entity.
voidsetDocumentLocator(Locator locator)
Receive a Locator object for document events.
voidsetIDAttribute(String id, int elem)
Set an ID string to node association in the ID table.
voidsetIncrementalSAXSource(IncrementalSAXSource incrementalSAXSource)
Bind a IncrementalSAXSource to this DTM.
voidsetProperty(String property, Object value)
Set a run time property for this DTM instance.
voidsetUseSourceLocation(boolean useSourceLocation)
Set whether information about document source location should be maintained or not.
voidskippedEntity(String name)
Receive notification of a skipped entity.
voidstartCDATA()
Report the start of a CDATA section.
voidstartDocument()
Receive notification of the beginning of the document.
voidstartDTD(String name, String publicId, String systemId)
Report the start of DTD declarations, if any.
voidstartElement(String uri, String localName, String qName, Attributes attributes)
Receive notification of the start of an element.
voidstartEntity(String name)
Report the beginning of an entity in content.
voidstartPrefixMapping(String prefix, String uri)
Receive notification of the start of a Namespace mapping.
voidunparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.
voidwarning(SAXParseException e)
Receive notification of a parser warning.

Constructor Detail

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 Detail

attributeDecl

public void attributeDecl(String eName, String aName, String type, String valueDefault, String value)
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.

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.

characters

public void characters(char[] ch, int start, int length)
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).

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: org.xml.sax.ContentHandler#characters

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.

comment

public void comment(char[] ch, int start, int length)
Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).

Parameters: ch An array holding the characters in the comment. start The starting position in the array. length The number of characters to use from the array.

Throws: SAXException The application may raise an exception.

dispatchCharactersEvents

public 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). Multiple calls to the ContentHandler's characters methods may well occur for a single call to this method.

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

dispatchToEvents

public void dispatchToEvents(int nodeHandle, ContentHandler ch)
Directly create SAX parser events from a subtree.

Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler.

Throws: org.xml.sax.SAXException

elementDecl

public void elementDecl(String name, String model)
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.

Parameters: name The element type name. model The content model as a normalized string.

Throws: SAXException The application may raise an exception.

endCDATA

public void endCDATA()
Report the end of a CDATA section.

Throws: SAXException The application may raise an exception.

See Also: SAX2DTM

endDocument

public void endDocument()
Receive notification of the end of the document.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ContentHandler#endDocument

endDTD

public void endDTD()
Report the end of DTD declarations.

Throws: SAXException The application may raise an exception.

See Also: SAX2DTM

endElement

public void endElement(String uri, String localName, String qName)
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).

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: org.xml.sax.ContentHandler#endElement

endEntity

public void endEntity(String name)
Report the end of an entity.

Parameters: name The name of the entity that is ending.

Throws: SAXException The application may raise an exception.

See Also: SAX2DTM

endPrefixMapping

public void endPrefixMapping(String prefix)
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.

Parameters: prefix The Namespace prefix being declared.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ContentHandler#endPrefixMapping

error

public void error(SAXParseException e)
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.

Parameters: e The warning information encoded as an exception.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ErrorHandler#warning org.xml.sax.SAXParseException

externalEntityDecl

public void externalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

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: SAX2DTM org.xml.sax.DTDHandler#unparsedEntityDecl

fatalError

public void fatalError(SAXParseException e)
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.

Parameters: e The error information encoded as an exception.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ErrorHandler#fatalError org.xml.sax.SAXParseException

getAttributeNode

public int getAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.

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.

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?

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...

getDeclHandler

public DeclHandler getDeclHandler()
Return this DTM's DeclHandler.

Returns: null if this model doesn't respond to SAX Decl events.

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.

Returns: the public identifier String object, or null if there is none.

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.

Returns: the system identifier String object, or null if there is none.

getDTDHandler

public DTDHandler getDTDHandler()
Return this DTM's DTDHandler.

Returns: null if this model doesn't respond to SAX dtd events.

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.

Parameters: elementId The unique id value for an element.

Returns: The handle of the matching element.

getEntityResolver

public EntityResolver getEntityResolver()
Return this DTM's EntityResolver.

Returns: null if this model doesn't respond to SAX entity ref events.

getErrorHandler

public ErrorHandler getErrorHandler()
Return this DTM's ErrorHandler.

Returns: null if this model doesn't respond to SAX error events.

getFixedNames

public String getFixedNames(int type)

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.

getLexicalHandler

public LexicalHandler getLexicalHandler()
Return this DTM's lexical handler. %REVIEW% Should this return null if constrution already done/begun?

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...

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).

Parameters: nodeHandle the id of the node.

Returns: String Local name of this node.

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

Parameters: nodeHandle the id of the node.

Returns: String URI value of this node's namespace, or null if no namespace was resolved.

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.

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.

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.

Parameters: nodeHandle the id of the node.

Returns: String Name of this node, which may be an empty string.

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.

Parameters: nodeHandle The node id.

Returns: String Value of this node, or null if not meaningful for this node type.

getNumberOfNodes

public int getNumberOfNodes()
Get the number of nodes that have been added.

Returns: The number of that are currently in the tree.

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

Parameters: nodeHandle the id of the node.

Returns: String prefix of this node's name, or "" if no explicit namespace prefix was given.

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.

getSourceLocatorFor

public SourceLocator getSourceLocatorFor(int node)
Retrieve the SourceLocator associated with a specific node. This is only meaningful if the XalanProperties.SOURCE_LOCATION flag was set True using setProperty; if it was never set, or was set false, we will return null. (We _could_ return a locator with the document's base URI and bogus line/column information. Trying that; see the else clause.)

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).

Parameters: nodeHandle The node ID.

Returns: A string object that represents the string-value of the given 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.)

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.

ignorableWhitespace

public void ignorableWhitespace(char[] ch, int start, int length)
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).

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: org.xml.sax.ContentHandler#ignorableWhitespace

internalEntityDecl

public void internalEntityDecl(String name, String value)
Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported.

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: SAX2DTM org.xml.sax.DTDHandler#unparsedEntityDecl

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.

Parameters: attributeHandle Must be a valid handle to an attribute node.

Returns: true if the attribute was specified; false if it was defaulted.

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.

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.

Parameters: manager the DTMManager

needsTwoThreads

public boolean needsTwoThreads()

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.

notationDecl

public void notationDecl(String name, String publicId, String systemId)
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.

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: org.xml.sax.DTDHandler#notationDecl

processingInstruction

public void processingInstruction(String target, String data)
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.

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: org.xml.sax.ContentHandler#processingInstruction

resolveEntity

public InputSource resolveEntity(String publicId, String systemId)
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.

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: org.xml.sax.EntityResolver#resolveEntity

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.

Parameters: locator A locator for all SAX document events.

See Also: org.xml.sax.ContentHandler#setDocumentLocator org.xml.sax.Locator

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.

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.

setProperty

public void setProperty(String property, Object value)
Set a run time property for this DTM instance. %REVIEW% Now that we no longer use this method to support getSourceLocatorFor, can we remove it?

Parameters: property a String value value an Object value

setUseSourceLocation

public void setUseSourceLocation(boolean useSourceLocation)
Set whether information about document source location should be maintained or not.

skippedEntity

public void skippedEntity(String name)
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.

Parameters: name The name of the skipped entity.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ContentHandler#processingInstruction

startCDATA

public void startCDATA()
Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular org.xml.sax.ContentHandler#characters characters event.

Throws: SAXException The application may raise an exception.

See Also: SAX2DTM

startDocument

public void startDocument()
Receive notification of the beginning of the document.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ContentHandler#startDocument

startDTD

public void startDTD(String name, String publicId, String systemId)
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.

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: SAX2DTM SAX2DTM

startElement

public void startElement(String uri, String localName, String qName, Attributes attributes)
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).

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: org.xml.sax.ContentHandler#startElement

startEntity

public void startEntity(String name)
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 org.xml.sax.ContentHandler#skippedEntity skippedEntity event, which is part of the ContentHandler interface.

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: SAX2DTM org.xml.sax.ext.DeclHandler#internalEntityDecl org.xml.sax.ext.DeclHandler#externalEntityDecl

startPrefixMapping

public void startPrefixMapping(String prefix, String uri)
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).

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: org.xml.sax.ContentHandler#startPrefixMapping

unparsedEntityDecl

public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
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.

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: org.xml.sax.DTDHandler#unparsedEntityDecl

warning

public void warning(SAXParseException e)
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.

Parameters: e The warning information encoded as an exception.

Throws: SAXException Any SAX exception, possibly wrapping another exception.

See Also: org.xml.sax.ErrorHandler#warning org.xml.sax.SAXParseException

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