|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xml.serializer.SerializerBase
org.apache.xml.serializer.ToSAXHandler
org.apache.xml.serializer.ToXMLSAXHandler
This class receives notification of SAX-like events, and with gathered information over these calls it will invoke the equivalent SAX methods on a handler, the ultimate output is known to be XML.
Field Summary |
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler |
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS |
Fields inherited from interface org.apache.xml.serializer.SerializerConstants |
BEGCDATA, CDATA_CONTINUE, CDATA_DELIMITER_CLOSE, CDATA_DELIMITER_OPEN, CNTCDATA, DEFAULT_SAX_SERIALIZER, EMPTYSTRING, ENDCDATA, ENTITY_AMP, ENTITY_CRLF, ENTITY_GT, ENTITY_LT, ENTITY_QUOT, XML_PREFIX, XMLNS_PREFIX, XMLNS_URI |
Constructor Summary | |
ToXMLSAXHandler()
|
|
ToXMLSAXHandler(ContentHandler handler,
LexicalHandler lex,
java.lang.String encoding)
|
|
ToXMLSAXHandler(ContentHandler handler,
java.lang.String encoding)
|
Method Summary | |
void |
addAttribute(java.lang.String uri,
java.lang.String localName,
java.lang.String rawName,
java.lang.String type,
java.lang.String value)
Adds the given attribute to the set of attributes, and also makes sure that the needed prefix/uri mapping is declared, but only if there is a currently open element. |
void |
attributeDecl(java.lang.String arg0,
java.lang.String arg1,
java.lang.String arg2,
java.lang.String arg3,
java.lang.String arg4)
Report an attribute type declaration. |
void |
characters(char[] ch,
int off,
int len)
Receive notification of character data. |
void |
characters(java.lang.String chars)
Receive notification of character data. |
void |
closeCDATA()
Closes ane open cdata tag, and unlike the this.endCDATA() method (from the LexicalHandler) interface, this "internal" method will send the endCDATA() call to the wrapped handler. |
void |
comment(char[] arg0,
int arg1,
int arg2)
Report an XML comment anywhere in the document. |
void |
elementDecl(java.lang.String arg0,
java.lang.String arg1)
Report an element type declaration. |
void |
endCDATA()
Report the end of a CDATA section. |
void |
endDocument()
Receives notification of the end of the document. |
void |
endDTD()
Report the end of DTD declarations. |
void |
endElement(java.lang.String elemName)
This method is used to notify that an element has ended. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
Receive notification of the end of an element. |
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI mapping. |
void |
externalEntityDecl(java.lang.String arg0,
java.lang.String arg1,
java.lang.String arg2)
Report a parsed external entity declaration. |
java.util.Properties |
getOutputFormat()
Returns the output format properties for this serializer. |
java.io.OutputStream |
getOutputStream()
Get the output stream where the events will be serialized to. |
java.io.Writer |
getWriter()
Get the character stream where the events will be serialized to. |
void |
ignorableWhitespace(char[] arg0,
int arg1,
int arg2)
Receive notification of ignorable whitespace in element content. |
void |
indent(int n)
Do nothing for SAX. |
void |
internalEntityDecl(java.lang.String arg0,
java.lang.String arg1)
Report an internal entity declaration. |
void |
namespaceAfterStartElement(java.lang.String prefix,
java.lang.String uri)
Send a namespace declaration in the output document. |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Do nothing as this is an abstract class. |
boolean |
reset()
Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons). |
void |
serialize(Node node)
Notify that the serializer should take this DOM node as input to be serialized. |
void |
setDocumentLocator(Locator arg0)
Receive an object for locating the origin of SAX document events. |
boolean |
setEscaping(boolean escape)
Turns special character escaping on/off. |
void |
setOutputFormat(java.util.Properties format)
Specifies an output format for this serializer. |
void |
setOutputStream(java.io.OutputStream output)
Specifies an output stream to which the document should be serialized. |
void |
setWriter(java.io.Writer writer)
Specifies a writer to which the document should be serialized. |
void |
skippedEntity(java.lang.String arg0)
Receive notification of a skipped entity. |
void |
startCDATA()
Report the start of a CDATA section. |
void |
startElement(java.lang.String elementName)
An element starts, but attributes are not fully known yet. |
void |
startElement(java.lang.String elementNamespaceURI,
java.lang.String elementLocalName,
java.lang.String elementName)
Start an element in the output document. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String name,
Attributes atts)
Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element. |
void |
startEntity(java.lang.String arg0)
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 |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri,
boolean shouldFlush)
Remember the prefix/uri mapping at the current nested element depth. |
Methods inherited from class org.apache.xml.serializer.ToSAXHandler |
addUniqueAttribute, characters, comment, error, fatalError, flushPending, setCdataSectionElements, setContentHandler, setLexHandler, setShouldOutputNSAttr, setTransformState, startDTD, warning |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ToXMLSAXHandler()
public ToXMLSAXHandler(ContentHandler handler, java.lang.String encoding)
public ToXMLSAXHandler(ContentHandler handler, LexicalHandler lex, java.lang.String encoding)
Method Detail |
public java.util.Properties getOutputFormat()
Serializer
Serializer.getOutputFormat()
public java.io.OutputStream getOutputStream()
Serializer
Serializer.getOutputStream()
public java.io.Writer getWriter()
Serializer
Serializer.getWriter()
public void indent(int n) throws SAXException
SAXException
public void serialize(Node node) throws java.io.IOException
SerializationHandler
node
- the DOM node to be serialized.
java.io.IOException
DOMSerializer.serialize(Node)
public boolean setEscaping(boolean escape) throws SAXException
SerializationHandler
SAXException
SerializationHandler.setEscaping(boolean)
public void setOutputFormat(java.util.Properties format)
Serializer
format
- The output format to useSerializer.setOutputFormat(Properties)
public void setOutputStream(java.io.OutputStream output)
Serializer
The encoding specified in the output Properties
is used, or
if no encoding was specified, the default for the selected
output method.
output
- The output streamSerializer.setOutputStream(OutputStream)
public void setWriter(java.io.Writer writer)
Serializer
The encoding specified for the output Properties
must be
identical to the output format used with the writer.
writer
- The output writer streamSerializer.setWriter(Writer)
public void attributeDecl(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3, java.lang.String arg4) throws SAXException
DeclHandler
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", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.
The value will be the value as reported to applications, appropriately normalized and with entity and character references expanded.
arg0
- The name of the associated element.arg1
- The name of the attribute.arg2
- A string representing the attribute type.arg3
- A string representing the attribute defaulting mode
("#IMPLIED", "#REQUIRED", or "#FIXED") or null if
none of these applies.arg4
- A string representing the attribute's default value,
or null if there is none.
SAXException
- The application may raise an exception.DeclHandler.attributeDecl(String, String, String, String, String)
public void elementDecl(java.lang.String arg0, java.lang.String arg1) throws SAXException
DeclHandler
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 parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.
arg0
- The element type name.arg1
- The content model as a normalized string.
SAXException
- The application may raise an exception.DeclHandler.elementDecl(String, String)
public void externalEntityDecl(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2) throws SAXException
DeclHandler
Only the effective (first) declaration for each entity will be reported.
arg0
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.arg1
- The declared public identifier of the entity, or
null if none was declared.arg2
- The declared system identifier of the entity.
SAXException
- The application may raise an exception.DeclHandler.externalEntityDecl(String, String, String)
public void internalEntityDecl(java.lang.String arg0, java.lang.String arg1) throws SAXException
DeclHandler
Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.
arg0
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.arg1
- The replacement text of the entity.
SAXException
- The application may raise an exception.DeclHandler.internalEntityDecl(String, String)
public void endDocument() throws SAXException
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endDocument()
public void closeCDATA() throws SAXException
SAXException
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.
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.ContentHandler.endElement(String, String, String)
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.
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.endPrefixMapping(String)
public void ignorableWhitespace(char[] arg0, int arg1, int arg2) 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.
arg0
- The characters from the XML document.arg1
- The start position in the array.arg2
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.ignorableWhitespace(char[], int, int)
public void setDocumentLocator(Locator arg0)
SerializerBase
setDocumentLocator
in interface ContentHandler
setDocumentLocator
in class SerializerBase
arg0
- An object that can return the location of any SAX document
event.
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 DocumentHandler 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.
ContentHandler.setDocumentLocator(Locator)
public void skippedEntity(java.lang.String arg0) 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.
arg0
- 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.ContentHandler.skippedEntity(String)
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.
prefix
- The prefix that maps to the URIuri
- The URI for the namespace
SAXException
- The client may throw
an exception during processing.ContentHandler.startPrefixMapping(String, String)
public boolean startPrefixMapping(java.lang.String prefix, java.lang.String uri, boolean shouldFlush) throws SAXException
prefix
- The prefix that maps to the URIuri
- The URI for the namespaceshouldFlush
- a flag indicating if the mapping applies to the
current element or an up coming child (not used).
SAXException
ContentHandler.startPrefixMapping(String, String)
public void comment(char[] arg0, int arg1, int arg2) 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).
arg0
- An array holding the characters in the comment.arg1
- The starting position in the array.arg2
- The number of characters to use from the array.
SAXException
- The application may raise an exception.LexicalHandler.comment(char[], int, int)
public void endCDATA() throws SAXException
LexicalHandler
SAXException
- The application may raise an exception.LexicalHandler.endCDATA()
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.
SAXException
- The application may raise an exception.LexicalHandler.endDTD()
public void startEntity(java.lang.String arg0) 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.
arg0
- 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.startEntity(String)
public void characters(java.lang.String chars) throws SAXException
ToSAXHandler
characters
in interface ExtendedContentHandler
characters
in class ToSAXHandler
SAXException
ExtendedContentHandler.characters(String)
public void startElement(java.lang.String elementNamespaceURI, java.lang.String elementLocalName, java.lang.String elementName) throws SAXException
startElement
in interface ExtendedContentHandler
startElement
in class ToSAXHandler
elementNamespaceURI
- the URI of the namespace of the element (optional)elementLocalName
- the element name, but without prefix (optional)elementName
- the element name, with prefix, if any (required)
SAXException
ExtendedContentHandler.startElement(String, String, String)
public void startElement(java.lang.String elementName) throws SAXException
ToSAXHandler
startElement
in interface ExtendedContentHandler
startElement
in class ToSAXHandler
SAXException
ExtendedContentHandler.startElement(String)
public void characters(char[] ch, int off, int len) 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).
ch
- The characters from the XML document.off
- The start position in the array.len
- 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 endElement(java.lang.String elemName) throws SAXException
ExtendedContentHandler
endElement(namespaceURI,localName,qName)only the last parameter is passed. If needed the serializer can derive the localName from the qualified name and derive the namespaceURI from its implementation.
elemName
- the fully qualified element name.
SAXException
ExtendedContentHandler.endElement(String)
public void namespaceAfterStartElement(java.lang.String prefix, java.lang.String uri) throws SAXException
namespaceAfterStartElement
in interface ExtendedContentHandler
namespaceAfterStartElement
in class SerializerBase
prefix
- the URI of the namespaceuri
- the prefix associated with the given URI.
SAXException
ExtendedContentHandler.namespaceAfterStartElement(String, String)
public void processingInstruction(java.lang.String target, java.lang.String data) throws SAXException
ToSAXHandler
processingInstruction
in interface ContentHandler
processingInstruction
in class ToSAXHandler
SAXException
Send a processing instruction to the output document
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.
SAXException
- The application may raise an exception.LexicalHandler.endCDATA()
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name, Attributes atts) throws SAXException
ToSAXHandler
startElement
in interface ContentHandler
startElement
in class ToSAXHandler
SAXException
ContentHandler.startElement(String, String, String, Attributes)
public void addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value) throws SAXException
addAttribute
in interface ExtendedContentHandler
addAttribute
in class SerializerBase
uri
- the URI of the attributelocalName
- the local name of the attributerawName
- the qualified name of the attributetype
- the type of the attribute (probably CDATA)value
- the value of the attribute
SAXException
ExtendedContentHandler.addAttribute(String, String, String, String, String)
public boolean reset()
reset
in interface Serializer
reset
in class ToSAXHandler
Serializer.reset()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |