This class takes SAX events (in addition to some extra events
that SAX doesn't handle yet) and adds the result to a document
or document fragment.
cdata
public void cdata(ch[] ,
int start,
int length)
throws SAXException
Receive notification of cdata.
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.
Note that some parsers will report whitespace using the
ignorableWhitespace() method rather than this one (validating
parsers must do so).
start
- The start position in the array.length
- The number of characters to read from the array.
ignorableWhitespace(ch[],int,int)
, Locator
characters
public void characters(ch[] ,
int start,
int length)
throws SAXException
Receive notification of character data.
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.
Note that some parsers will report whitespace using the
ignorableWhitespace() method rather than this one (validating
parsers must do so).
- characters in interface ContentHandler
start
- The start position in the array.length
- The number of characters to read from the array.
ignorableWhitespace(ch[],int,int)
, Locator
charactersRaw
public void charactersRaw(ch[] ,
int start,
int length)
throws SAXException
If available, when the disable-output-escaping attribute is used,
output raw text without escaping. A PI will be inserted in front
of the node with the name "lotusxsl-next-is-raw" and a value of
"formatter-to-dom".
start
- Index to start of characters in the arraylength
- Number of characters in the array
comment
public void comment(ch[] ,
int start,
int length)
throws SAXException
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).
- comment in interface LexicalHandler
start
- The starting position in the array.length
- The number of characters to use from the array.
endDocument
public void endDocument()
throws SAXException
Receive notification of the end of a document.
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
endElement
public void endElement(String ns,
String localName,
String name)
throws SAXException
Receive notification of the end of an element.
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).
If the element name has a namespace prefix, the prefix will
still be attached to the name.
- endElement in interface ContentHandler
ns
- the namespace of the elementlocalName
- The local part of the qualified name of the elementname
- The element name
entityReference
public void entityReference(String name)
throws SAXException
Receive notivication of a entityReference.
name
- name of the entity reference
getCurrentNode
public Node getCurrentNode()
Get the node currently being processed.
- the current node being processed
getRootNode
public Node getRootNode()
Get the root node of the DOM being created. This
is either a Document or a DocumentFragment.
- The root document or document fragment if not null
getWriter
public java.io.Writer getWriter()
Return null since there is no Writer for this class.
- null
ignorableWhitespace
public void ignorableWhitespace(ch[] ,
int start,
int length)
throws SAXException
Receive notification of ignorable whitespace in element content.
Validating Parsers must use this method to report each chunk
of ignorable whitespace (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
start
- The start position in the array.length
- The number of characters to read from the array.
characters(ch[],int,int)
processingInstruction
public void processingInstruction(String target,
String data)
throws SAXException
Receive notification of a processing instruction.
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 should 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.
- processingInstruction in interface ContentHandler
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied.
setDocumentLocator
public void setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events.
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
setIDAttribute
public void setIDAttribute(String id,
Element elem)
Set an ID string to node association in the ID table.
id
- The ID string.elem
- The associated ID.
skippedEntity
public void skippedEntity(String name)
throws SAXException
Receive notification of a skipped entity.
The Parser will invoke this method once for each entity
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 '%'.
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.
- 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.
endDTD()
, startEntity(String)
startDocument
public void startDocument()
throws SAXException
Receive notification of the beginning of a document.
The SAX parser will invoke this method only once, before any
other methods in this interface or in DTDHandler (except for
setDocumentLocator).
- startDocument in interface ContentHandler
startElement
public void startElement(String ns,
String localName,
String name,
Attributes atts)
throws SAXException
Receive notification of the beginning of an element.
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.
If the element name has a namespace prefix, the prefix will
still be attached. Note that the attribute list provided will
contain only attributes with explicit values (specified or
defaulted): #IMPLIED attributes will be omitted.
- startElement in interface ContentHandler
ns
- The namespace of the nodelocalName
- The local part of the qualified namename
- The element name.atts
- The attributes attached to the element, if any.
endElement(String,String,String)
, Attributes
startPrefixMapping
public void startPrefixMapping(String prefix,
String uri)
throws SAXException
Begin the scope of a prefix-URI Namespace mapping.
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 before the
corresponding startElement event, and all endPrefixMapping
events will occur after the corresponding endElement event,
but their order is not guaranteed.
- startPrefixMapping in interface ContentHandler
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.
endPrefixMapping(String)
, startElement(String,String,String,Attributes)