|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xml.dtm.ref.DTMDocumentImpl
public class DTMDocumentImpl
This is the implementation of the DTM document interface. It receives requests from an XML content handler similar to that of an XML DOM or SAX parser to store information from the xml document in an array based dtm table structure. This informtion is used later for document navigation, query, and SAX event dispatch functions. The DTM can also be used directly as a document composition model for an application. The requests received are:
State: In progress!!
%REVIEW% I _think_ the SAX convention is that "no namespace" is expressed as "" rather than as null (which is the DOM's convention). What should DTM expect? What should it do with the other?Origin: the implemention is a composite logic based on the DTM of XalanJ1 and DocImpl, DocumentImpl, ElementImpl, TextImpl, etc. of XalanJ2
Field Summary |
---|
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 | |
---|---|
DTMDocumentImpl(DTMManager mgr,
int documentNumber,
DTMWSFilter whiteSpaceFilter,
XMLStringFactory xstringfactory)
Construct a DTM. |
Method Summary | |
---|---|
void |
appendChild(int newChild,
boolean clone,
boolean cloneDepth)
Append a child to the end of the child list of the current node. |
void |
appendTextChild(java.lang.String str)
Append a text node child that will be constructed from a string, to the end of the document. |
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data. |
void |
comment(char[] ch,
int start,
int length)
Report an XML comment anywhere in the document. |
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 |
documentRegistration()
A dummy routine to satisify the abstract interface. |
void |
documentRelease()
A dummy routine to satisify the abstract interface. |
void |
endCDATA()
Report the end of a CDATA section. |
void |
endDocument()
Receive notification of the end of a document. |
void |
endDTD()
Report the end of DTD declarations. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
Receive notification of the end of an element. |
void |
endEntity(java.lang.String name)
Report the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI mapping. |
int |
getAttributeNode(int nodeHandle,
java.lang.String namespaceURI,
java.lang.String name)
Retrieves an attribute node by by qualified name and namespace URI. |
DTMAxisIterator |
getAxisIterator(int axis)
This is a shortcut to the iterators that implement the supported XPath axes (only namespace::) is not supported. |
DTMAxisTraverser |
getAxisTraverser(int axis)
This returns a stateless "traverser", that can navigate over an XPath axis, though not in document order. |
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. |
int |
getDocument()
Given a node handle, find the owning document node. |
boolean |
getDocumentAllDeclarationsProcessed()
Return an indication of whether the processor has read the complete DTD. |
java.lang.String |
getDocumentBaseURI()
Return the base URI of the document entity. |
java.lang.String |
getDocumentEncoding(int nodeHandle)
Return the name of the character encoding scheme in which the document entity is expressed. |
int |
getDocumentRoot()
Returns the root element of the document. |
int |
getDocumentRoot(int nodeHandle)
Given a node handle, find the owning document node. |
java.lang.String |
getDocumentStandalone(int nodeHandle)
Return an indication of the standalone status of the document, either "yes" or "no". |
java.lang.String |
getDocumentSystemIdentifier(int nodeHandle)
Return the system identifier of the document entity. |
java.lang.String |
getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML]. |
java.lang.String |
getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties: 1. |
java.lang.String |
getDocumentVersion(int documentHandle)
Return a string representing the XML version of the document. |
DTDHandler |
getDTDHandler()
Return this DTM's DTDHandler. |
int |
getElementById(java.lang.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. |
int |
getExpandedTypeID(int nodeHandle)
Given a node handle, return an ID that represents the node's expanded name. |
int |
getExpandedTypeID(java.lang.String namespace,
java.lang.String localName,
int type)
Given an expanded name, return an ID. |
int |
getFirstAttribute(int nodeHandle)
Given a node handle, get the index of the node's first attribute. |
int |
getFirstChild(int nodeHandle)
Given a node handle, get the handle of the node's first child. |
int |
getFirstNamespaceNode(int nodeHandle,
boolean inScope)
Given a node handle, get the index of the node's first child. |
int |
getLastChild(int nodeHandle)
Given a node handle, advance to its last child. |
short |
getLevel(int nodeHandle)
Get the depth level of this node in the tree (equals 1 for a parentless node). |
LexicalHandler |
getLexicalHandler()
Return this DTM's lexical handler. |
java.lang.String |
getLocalName(int nodeHandle)
Given a node handle, return its DOM-style localname. |
java.lang.String |
getLocalNameFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the local name part. |
DTMStringPool |
getLocalNameTable()
Get a reference pointer to the element name symbol table. |
java.lang.String |
getNamespaceFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the namespace URI part. |
java.lang.String |
getNamespaceURI(int nodeHandle)
Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.) |
int |
getNextAttribute(int nodeHandle)
Given a node handle, advance to the next attribute. |
int |
getNextDescendant(int subtreeRootHandle,
int nodeHandle)
Given a node handle, advance to its next descendant. |
int |
getNextFollowing(int axisContextHandle,
int nodeHandle)
Given a node handle, advance to the next node on the following axis. |
int |
getNextNamespaceNode(int baseHandle,
int namespaceHandle,
boolean inScope)
Given a namespace handle, advance to the next namespace. |
int |
getNextPreceding(int axisContextHandle,
int nodeHandle)
Given a node handle, advance to the next node on the preceding axis. |
int |
getNextSibling(int nodeHandle)
Given a node handle, advance to its next sibling. |
Node |
getNode(int nodeHandle)
Return an DOM node for the given node. |
java.lang.String |
getNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name. |
java.lang.String |
getNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name. |
short |
getNodeType(int nodeHandle)
Given a node handle, return its DOM-style node type. |
java.lang.String |
getNodeValue(int nodeHandle)
Given a node handle, return its node value. |
DTMStringPool |
getNsNameTable()
Get a reference pointer to the namespace URI symbol table. |
int |
getOwnerDocument(int nodeHandle)
Given a node handle, find the owning document node. |
int |
getParent(int nodeHandle)
Given a node handle, find its parent node. |
java.lang.String |
getPrefix(int nodeHandle)
Given a namespace handle, return the prefix that the namespace decl is mapping. |
DTMStringPool |
getPrefixNameTable()
Get a reference pointer to the prefix name symbol table. |
int |
getPreviousSibling(int nodeHandle)
Given a node handle, find its preceeding sibling. |
SourceLocator |
getSourceLocatorFor(int node)
Source information is not handled yet, so return null here. |
XMLString |
getStringValue(int nodeHandle)
Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). |
char[] |
getStringValueChunk(int nodeHandle,
int chunkIndex,
int[] startAndLen)
Get a character array chunk in the string-value of a node. |
int |
getStringValueChunkCount(int nodeHandle)
Get number of character array chunks in the string-value of a node. |
DTMAxisIterator |
getTypedAxisIterator(int axis,
int type)
Get an iterator that can navigate over an XPath Axis, predicated by the extended type ID. |
java.lang.String |
getUnparsedEntityURI(java.lang.String name)
The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]). |
boolean |
hasChildNodes(int nodeHandle)
Given a node handle, test if it has child nodes. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content. |
boolean |
isAttributeSpecified(int attributeHandle)
5. |
boolean |
isCharacterElementContentWhitespace(int nodeHandle)
2. |
boolean |
isDocumentAllDeclarationsProcessed(int documentHandle)
10. |
boolean |
isNodeAfter(int nodeHandle1,
int nodeHandle2)
Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model. |
boolean |
isSupported(java.lang.String feature,
java.lang.String version)
Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node. |
void |
migrateTo(DTMManager manager)
Migrate a DTM built with an old DTMManager to a new DTMManager. |
boolean |
needsTwoThreads()
|
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Receive notification of a processing instruction. |
void |
setDocumentBaseURI(java.lang.String baseURI)
Set the base URI of the document entity. |
void |
setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events. |
void |
setFeature(java.lang.String featureId,
boolean state)
Set an implementation dependent feature. |
void |
setIncrementalSAXSource(IncrementalSAXSource source)
Bind a IncrementalSAXSource to this DTM. |
void |
setLocalNameTable(DTMStringPool poolRef)
Set a reference pointer to the element name symbol table. |
void |
setNsNameTable(DTMStringPool poolRef)
Set a reference pointer to the namespace URI symbol table. |
void |
setPrefixNameTable(DTMStringPool poolRef)
Set a reference pointer to the prefix name symbol table. |
void |
setProperty(java.lang.String property,
java.lang.Object value)
For the moment all the run time properties are ignored by this class. |
void |
skippedEntity(java.lang.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 a document. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
Attributes atts)
Receive notification of the beginning of an element. |
void |
startEntity(java.lang.String name)
Report the beginning of some internal and external XML entities. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping. |
boolean |
supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the DTM document. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DTMDocumentImpl(DTMManager mgr, int documentNumber, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory)
documentNumber
- the ID number assigned to this document.
It will be shifted up into the high bits and returned as part of
all node ID numbers, so those IDs indicate which document they
came from as well as a location within the document. It is the
DTMManager's responsibility to assign a unique number to each
document.Method Detail |
---|
public void setIncrementalSAXSource(IncrementalSAXSource source)
source
- The IncrementalSAXSource that we want to recieve events from
on demand.public void setFeature(java.lang.String featureId, boolean state)
%REVIEW% Do we really expect to set features on DTMs?
setFeature
in interface DTM
featureId
- A feature URL.state
- true if this feature should be on, false otherwise.public void setLocalNameTable(DTMStringPool poolRef)
poolRef
- DTMStringPool reference to an instance of table.public DTMStringPool getLocalNameTable()
public void setNsNameTable(DTMStringPool poolRef)
poolRef
- DTMStringPool reference to an instance of table.public DTMStringPool getNsNameTable()
public void setPrefixNameTable(DTMStringPool poolRef)
poolRef
- DTMStringPool reference to an instance of table.public DTMStringPool getPrefixNameTable()
public ContentHandler getContentHandler()
getContentHandler
in interface DTM
public LexicalHandler getLexicalHandler()
getLexicalHandler
in interface DTM
public EntityResolver getEntityResolver()
getEntityResolver
in interface DTM
public DTDHandler getDTDHandler()
getDTDHandler
in interface DTM
public ErrorHandler getErrorHandler()
getErrorHandler
in interface DTM
public DeclHandler getDeclHandler()
getDeclHandler
in interface DTM
public boolean needsTwoThreads()
needsTwoThreads
in interface DTM
public void characters(char[] ch, int start, int length) throws SAXException
ContentHandler
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
char
value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a Surrogate Pair,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters.
Your code should not assume that algorithms using
char
-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.ignorableWhitespace(char[], int, int)
,
Locator
public void endDocument() throws SAXException
ContentHandler
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument
in interface ContentHandler
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.startDocument()
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) throws SAXException
ContentHandler
The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement
event for every endElement
event (even when the element is empty).
For information on the names, see startElement.
endElement
in interface ContentHandler
namespaceURI
- 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.
SAXException
- Any SAX exception, possibly
wrapping another exception.public void endPrefixMapping(java.lang.String prefix) throws SAXException
ContentHandler
See startPrefixMapping
for
details. These events will always occur immediately after the
corresponding endElement
event, but the order of
endPrefixMapping
events is not otherwise
guaranteed.
endPrefixMapping
in interface ContentHandler
prefix
- The prefix that was being mapping.
This is the empty string when a default mapping scope ends.
SAXException
- The client may throw
an exception during processing.ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
,
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
ContentHandler
Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
ignorableWhitespace
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.characters(char[], int, int)
public void processingInstruction(java.lang.String target, java.lang.String data) throws SAXException
ContentHandler
The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
Like characters()
, processing instruction
data may have characters that need more than one char
value.
processingInstruction
in interface ContentHandler
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the target.
SAXException
- Any SAX exception, possibly
wrapping another exception.public void setDocumentLocator(Locator locator)
ContentHandler
SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.
The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.
setDocumentLocator
in interface ContentHandler
locator
- An object that can return the location of
any SAX document event.Locator
public void skippedEntity(java.lang.String name) throws SAXException
ContentHandler
The Parser will invoke this method each time the entity is
skipped. Non-validating processors may skip entities if they
have not seen the declarations (because, for example, the
entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
http://xml.org/sax/features/external-general-entities
and the
http://xml.org/sax/features/external-parameter-entities
properties.
skippedEntity
in interface ContentHandler
name
- The name of the skipped entity. If it is a
parameter entity, the name will begin with '%', and if
it is the external DTD subset, it will be the string
"[dtd]".
SAXException
- Any SAX exception, possibly
wrapping another exception.public void startDocument() throws SAXException
ContentHandler
The SAX parser will invoke this method only once, before any
other event callbacks (except for setDocumentLocator
).
startDocument
in interface ContentHandler
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endDocument()
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, Attributes atts) throws SAXException
ContentHandler
The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement
event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
Like characters()
, attribute values may have
characters that need more than one char
value.
startElement
in interface ContentHandler
namespaceURI
- 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.atts
- The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws SAXException
ContentHandler
The information from this event is not necessary for
normal Namespace processing: the SAX XML reader will
automatically replace prefixes for element and attribute
names when the http://xml.org/sax/features/namespaces
feature is true (the default).
There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not
guaranteed to be properly nested relative to each other:
all startPrefixMapping events will occur immediately before the
corresponding startElement
event,
and all endPrefixMapping
events will occur immediately after the corresponding
endElement
event,
but their order is not otherwise
guaranteed.
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
startPrefixMapping
in interface ContentHandler
prefix
- The Namespace prefix being declared.
An empty string is used for the default element namespace,
which has no prefix.uri
- The Namespace URI the prefix is mapped to.
SAXException
- The client may throw
an exception during processing.ContentHandler.endPrefixMapping(java.lang.String)
,
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void comment(char[] ch, int start, int length) throws SAXException
LexicalHandler
This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).
comment
in interface LexicalHandler
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.
SAXException
- The application may raise an exception.public void endCDATA() throws SAXException
LexicalHandler
endCDATA
in interface LexicalHandler
SAXException
- The application may raise an exception.LexicalHandler.startCDATA()
public void endDTD() throws SAXException
LexicalHandler
This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
endDTD
in interface LexicalHandler
SAXException
- The application may raise an exception.LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)
public void endEntity(java.lang.String name) throws SAXException
LexicalHandler
endEntity
in interface LexicalHandler
name
- The name of the entity that is ending.
SAXException
- The application may raise an exception.LexicalHandler.startEntity(java.lang.String)
public void startCDATA() throws SAXException
LexicalHandler
The contents of the CDATA section will be reported through
the regular characters
event; this event is intended only to report
the boundary.
startCDATA
in interface LexicalHandler
SAXException
- The application may raise an exception.LexicalHandler.endCDATA()
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
LexicalHandler
This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
All declarations reported through
DTDHandler
or
DeclHandler
events must appear
between the startDTD and endDTD
events.
Declarations are assumed to belong to the internal DTD subset
unless they appear between startEntity
and endEntity
events. Comments and
processing instructions from the DTD should also be reported
between the startDTD and endDTD events, in their original
order of (logical) occurrence; they are not required to
appear in their correct locations relative to DTDHandler
or DeclHandler events, however.
Note that the start/endDTD events will appear within
the start/endDocument events from ContentHandler and
before the first
startElement
event.
startDTD
in interface LexicalHandler
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.
(Note that this is not resolved against the document
base URI.)
SAXException
- The application may raise an
exception.LexicalHandler.endDTD()
,
LexicalHandler.startEntity(java.lang.String)
public void startEntity(java.lang.String name) throws SAXException
LexicalHandler
The reporting of parameter entities (including
the external DTD subset) is optional, and SAX2 drivers that
report LexicalHandler events may not implement it; you can use the
http://xml.org/sax/features/lexical-handler/parameter-entities
feature to query or control the reporting of parameter entities.
General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".
When a SAX2 driver is providing these events, all other
events must be properly nested within start/end entity
events. There is no additional requirement that events from
DeclHandler
or
DTDHandler
be properly ordered.
Note that skipped entities will be reported through the
skippedEntity
event, which is part of the ContentHandler interface.
Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:
These will be silently expanded, with no indication of where the original entity boundaries were.
Note also that the boundaries of character references (which are not really entities anyway) are not reported.
All start/endEntity events must be properly nested.
startEntity
in interface LexicalHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%', and if it is the
external DTD subset, it will be "[dtd]".
SAXException
- The application may raise an exception.LexicalHandler.endEntity(java.lang.String)
,
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)
,
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
public boolean hasChildNodes(int nodeHandle)
%REVIEW% This is obviously useful at the DOM layer, where it would permit testing this without having to create a proxy node. It's less useful in the DTM API, where (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and almost as self-evident. But it's a convenience, and eases porting of DOM code to DTM.
hasChildNodes
in interface DTM
nodeHandle
- int Handle of the node.
public int getFirstChild(int nodeHandle)
getFirstChild
in interface DTM
nodeHandle
- int Handle of the node.
public int getLastChild(int nodeHandle)
getLastChild
in interface DTM
nodeHandle
- int Handle of the node.
public int getAttributeNode(int nodeHandle, java.lang.String namespaceURI, java.lang.String name)
getAttributeNode
in interface DTM
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.
nodeName
) or DTM.NULL
if there is no such
attribute.public int getFirstAttribute(int nodeHandle)
getFirstAttribute
in interface DTM
nodeHandle
- int Handle of the Element node.
public int getFirstNamespaceNode(int nodeHandle, boolean inScope)
getFirstNamespaceNode
in interface DTM
nodeHandle
- handle to node, which should probably be an element
node, but need not be.inScope
- true if all namespaces in scope should be returned,
false if only the namespace declarations should be
returned.
public int getNextSibling(int nodeHandle)
getNextSibling
in interface DTM
nodeHandle
- int Handle of the node.
public int getPreviousSibling(int nodeHandle)
getPreviousSibling
in interface DTM
nodeHandle
- the id of the node.
public int getNextAttribute(int nodeHandle)
getNextAttribute
in interface DTM
nodeHandle
- int Handle of the node.
public int getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)
getNextNamespaceNode
in interface DTM
namespaceHandle
- handle to node which must be of type NAMESPACE_NODE.baseHandle
- handle to original node from where the first child
was relative to (needed to return nodes in document order).
public int getNextDescendant(int subtreeRootHandle, int nodeHandle)
subtreeRootNodeHandle
- nodeHandle
- int Handle of the node.
public int getNextFollowing(int axisContextHandle, int nodeHandle)
axisContextHandle
- the start of the axis that is being traversed.nodeHandle
-
public int getNextPreceding(int axisContextHandle, int nodeHandle)
axisContextHandle
- the start of the axis that is being traversed.nodeHandle
- the id of the node.
public int getParent(int nodeHandle)
getParent
in interface DTM
nodeHandle
- the id of the node.
public int getDocumentRoot()
public int getDocument()
getDocument
in interface DTM
nodeHandle
- the id of the node.
public int getOwnerDocument(int nodeHandle)
%REVIEW% Since this is DOM-specific, it may belong at the DOM binding layer. Included here as a convenience function and to aid porting of DOM code to DTM.
getOwnerDocument
in interface DTM
nodeHandle
- the id of the node.
DTM.getDocumentRoot(int nodeHandle)
public int getDocumentRoot(int nodeHandle)
%REVIEW% Since this is DOM-specific, it may belong at the DOM binding layer. Included here as a convenience function and to aid porting of DOM code to DTM.
getDocumentRoot
in interface DTM
nodeHandle
- the id of the node.
DTM.getOwnerDocument(int nodeHandle)
public XMLString getStringValue(int nodeHandle)
getStringValue
in interface DTM
nodeHandle
- The node ID.
public int getStringValueChunkCount(int nodeHandle)
getStringValueChunkCount
in interface DTM
nodeHandle
- The node ID.
public char[] getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
getStringValueChunk
in interface DTM
nodeHandle
- The node ID.chunkIndex
- Which chunk to get.startAndLen
- An array of 2 where the start position and length of
the chunk will be returned.
public int getExpandedTypeID(int nodeHandle)
getExpandedTypeID
in interface DTM
nodeHandle
- The handle to the node in question.
public int getExpandedTypeID(java.lang.String namespace, java.lang.String localName, int type)
getExpandedTypeID
in interface DTM
nodeHandle
- The handle to the node in question.
public java.lang.String getLocalNameFromExpandedNameID(int ExpandedNameID)
getLocalNameFromExpandedNameID
in interface DTM
ExpandedNameID
- an ID that represents an expanded-name.
public java.lang.String getNamespaceFromExpandedNameID(int ExpandedNameID)
getNamespaceFromExpandedNameID
in interface DTM
ExpandedNameID
- an ID that represents an expanded-name.
public java.lang.String getNodeName(int nodeHandle)
getNodeName
in interface DTM
nodeHandle
- the id of the node.
public java.lang.String getNodeNameX(int nodeHandle)
getNodeNameX
in interface DTM
nodeHandle
- the id of the node.
public java.lang.String getLocalName(int nodeHandle)
getLocalName
in interface DTM
nodeHandle
- the id of the node.
public java.lang.String getPrefix(int nodeHandle)
%REVIEW% Are you sure you want "" for no prefix?
%REVIEW% Should this be DOM-style (undefined unless namespaced), or other?
getPrefix
in interface DTM
nodeHandle
- the id of the node.
public java.lang.String getNamespaceURI(int nodeHandle)
getNamespaceURI
in interface DTM
nodeHandle
- the id of the node.
public java.lang.String getNodeValue(int nodeHandle)
getNodeValue
in interface DTM
nodeHandle
- The node id.
public short getNodeType(int nodeHandle)
%REVIEW% Generally, returning short is false economy. Return int?
getNodeType
in interface DTM
nodeHandle
- The node id.
public short getLevel(int nodeHandle)
getLevel
in interface DTM
nodeHandle
- The node id.
public boolean isSupported(java.lang.String feature, java.lang.String version)
isSupported
in interface DTM
feature
- The name of the feature to test.versionThis
- is the version number of the feature to test.
If the version is not
specified, supporting any version of the feature will cause the
method to return true
.
true
if the specified feature is
supported on this node, false
otherwise.public java.lang.String getDocumentBaseURI()
getDocumentBaseURI
in interface DTM
public void setDocumentBaseURI(java.lang.String baseURI)
setDocumentBaseURI
in interface DTM
baseURI
- the document base URI String object or null if unknown.public java.lang.String getDocumentSystemIdentifier(int nodeHandle)
getDocumentSystemIdentifier
in interface DTM
nodeHandle
- The node id, which can be any valid node handle.
public java.lang.String getDocumentEncoding(int nodeHandle)
getDocumentEncoding
in interface DTM
nodeHandle
- The node id, which can be any valid node handle.
public java.lang.String getDocumentStandalone(int nodeHandle)
getDocumentStandalone
in interface DTM
nodeHandle
- The node id, which can be any valid node handle.
public java.lang.String getDocumentVersion(int documentHandle)
getDocumentVersion
in interface DTM
the
- document handle
public boolean getDocumentAllDeclarationsProcessed()
getDocumentAllDeclarationsProcessed
in interface DTM
true
if all declarations were processed {};
false
otherwise.public java.lang.String getDocumentTypeDeclarationSystemIdentifier()
getDocumentTypeDeclarationSystemIdentifier
in interface DTM
public java.lang.String getDocumentTypeDeclarationPublicIdentifier()
getDocumentTypeDeclarationPublicIdentifier
in interface DTM
the
- document type declaration handle
public int getElementById(java.lang.String elementId)
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.
getElementById
in interface DTM
elementId
- The unique id
value for an element.
public java.lang.String getUnparsedEntityURI(java.lang.String name)
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.)
getUnparsedEntityURI
in interface DTM
name
- A string containing the Entity Name of the unparsed
entity.
public boolean supportsPreStripping()
%REVEIW% Presumes a 1:1 mapping from DTM to Document, since we aren't saying which Document to query...?
supportsPreStripping
in interface DTM
public boolean isNodeAfter(int nodeHandle1, int nodeHandle2)
There are some cases where ordering isn't defined, and neither are the results of this function -- though we'll generally return true. TODO: Make sure this does the right thing with attribute nodes!!!
isNodeAfter
in interface DTM
node1
- DOM Node to perform position comparison on.node2
- DOM Node to perform position comparison on .
(node1.documentOrderPosition <= node2.documentOrderPosition)
.public boolean isCharacterElementContentWhitespace(int nodeHandle)
isCharacterElementContentWhitespace
in interface DTM
nodeHandle
- the node ID.
true
if the character data is whitespace;
false
otherwise.public boolean isDocumentAllDeclarationsProcessed(int documentHandle)
isDocumentAllDeclarationsProcessed
in interface DTM
the
- document handledocumentHandle
- A node handle that must identify a document.
true
if all declarations were processed;
false
otherwise.public boolean isAttributeSpecified(int attributeHandle)
isAttributeSpecified
in interface DTM
the
- attribute handle
NEEDSDOC @param attributeHandle
true
if the attribute was specified;
false
if it was defaulted.public void dispatchCharactersEvents(int nodeHandle, ContentHandler ch, boolean normalize) throws SAXException
dispatchCharactersEvents
in interface DTM
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.
SAXException
public void dispatchToEvents(int nodeHandle, ContentHandler ch) throws SAXException
dispatchToEvents
in interface DTM
nodeHandle
- The node ID.ch
- A non-null reference to a ContentHandler.
SAXException
public Node getNode(int nodeHandle)
getNode
in interface DTM
nodeHandle
- The node ID.
public void appendChild(int newChild, boolean clone, boolean cloneDepth)
%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?
appendChild
in interface DTM
newChild
- Must be a valid new node handle.clone
- true if the child should be cloned into the document.cloneDepth
- if the clone argument is true, specifies that the
clone should include all it's children.public void appendTextChild(java.lang.String str)
%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?
appendTextChild
in interface DTM
str
- Non-null reference to a string.public DTMAxisTraverser getAxisTraverser(int axis)
getAxisTraverser
in interface DTM
axis
- One of Axes.ANCESTORORSELF, etc.
public DTMAxisIterator getAxisIterator(int axis)
getAxisIterator
in interface DTM
axis
- One of Axes.ANCESTORORSELF, etc.
public DTMAxisIterator getTypedAxisIterator(int axis, int type)
getTypedAxisIterator
in interface DTM
axis
- type
- An extended type ID.
public void setProperty(java.lang.String property, java.lang.Object value)
setProperty
in interface DTM
property
- a String
valuevalue
- an Object
valuepublic SourceLocator getSourceLocatorFor(int node)
null
here.
getSourceLocatorFor
in interface DTM
node
- an int
value
public void documentRegistration()
documentRegistration
in interface DTM
public void documentRelease()
documentRelease
in interface DTM
public void migrateTo(DTMManager manager)
migrateTo
in interface DTM
manager
- the DTMManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |