|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xml.serialize.BaseMarkupSerializer
public abstract class BaseMarkupSerializer
Base class for a serializer supporting both DOM and SAX pretty serializing of XML/HTML/XHTML documents. Derives classes perform the method-specific serializing, this class provides the common serializing mechanisms.
The serializer must be initialized with the proper writer and
output format before it can be used by calling setOutputCharStream(java.io.Writer)
or setOutputByteStream(java.io.OutputStream)
for the writer and setOutputFormat(org.apache.xml.serialize.OutputFormat)
for the output format.
The serializer can be reused any number of times, but cannot be used concurrently by two threads.
If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.
The serializer supports both DOM and SAX. DOM serializing is done
by calling serialize(Document)
and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
This also applies to derived class.
If an I/O exception occurs while serializing, the serializer
will not throw an exception directly, but only throw it
at the end of serializing (either DOM or SAX's DocumentHandler.endDocument()
.
For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.
When indenting, the serializer is capable of detecting seemingly element content, and serializing these elements indented on separate lines. An element is serialized indented when it is the first or last child of an element, or immediate following or preceding another element.
Serializer
,
LSSerializer
Method Summary | |
---|---|
ContentHandler |
asContentHandler()
Deprecated. Return a ContentHandler interface into this serializer. |
DocumentHandler |
asDocumentHandler()
Deprecated. Return a DocumentHandler interface into this serializer. |
DOMSerializer |
asDOMSerializer()
Deprecated. Return a DOMSerializer interface into this serializer. |
void |
attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
Deprecated. Report an attribute type declaration. |
void |
characters(char[] chars,
int start,
int length)
Deprecated. Receive notification of character data. |
void |
comment(char[] chars,
int start,
int length)
Deprecated. Report an XML comment anywhere in the document. |
void |
comment(java.lang.String text)
Deprecated. |
void |
elementDecl(java.lang.String name,
java.lang.String model)
Deprecated. Report an element type declaration. |
void |
endCDATA()
Deprecated. Report the end of a CDATA section. |
void |
endDocument()
Deprecated. Called at the end of the document to wrap it up. |
void |
endDTD()
Deprecated. Report the end of DTD declarations. |
void |
endEntity(java.lang.String name)
Deprecated. Report the end of an entity. |
void |
endNonEscaping()
Deprecated. |
void |
endPrefixMapping(java.lang.String prefix)
Deprecated. End the scope of a prefix-URI mapping. |
void |
endPreserving()
Deprecated. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. Report a parsed external entity declaration. |
void |
ignorableWhitespace(char[] chars,
int start,
int length)
Deprecated. Receive notification of ignorable whitespace in element content. |
void |
internalEntityDecl(java.lang.String name,
java.lang.String value)
Deprecated. Report an internal entity declaration. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. Receive notification of a notation declaration event. |
void |
processingInstruction(java.lang.String target,
java.lang.String code)
Deprecated. Receive notification of a processing instruction. |
void |
processingInstructionIO(java.lang.String target,
java.lang.String code)
Deprecated. |
boolean |
reset()
Deprecated. |
void |
serialize(Document doc)
Deprecated. Serializes the DOM document using the previously specified writer and output format. |
void |
serialize(DocumentFragment frag)
Deprecated. Serializes the DOM document fragmnt using the previously specified writer and output format. |
void |
serialize(Element elem)
Deprecated. Serializes the DOM element using the previously specified writer and output format. |
void |
setDocumentLocator(Locator locator)
Deprecated. Receive an object for locating the origin of SAX document events. |
void |
setOutputByteStream(java.io.OutputStream output)
Deprecated. Specifies an output stream to which the document should be serialized. |
void |
setOutputCharStream(java.io.Writer writer)
Deprecated. Specifies a writer to which the document should be serialized. |
void |
setOutputFormat(OutputFormat format)
Deprecated. Specifies an output format for this serializer. |
void |
skippedEntity(java.lang.String name)
Deprecated. Receive notification of a skipped entity. |
void |
startCDATA()
Deprecated. Report the start of a CDATA section. |
void |
startDocument()
Deprecated. Receive notification of the beginning of a document. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. Report the start of DTD declarations, if any. |
void |
startEntity(java.lang.String name)
Deprecated. Report the beginning of some internal and external XML entities. |
void |
startNonEscaping()
Deprecated. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Deprecated. Begin the scope of a prefix-URI Namespace mapping. |
void |
startPreserving()
Deprecated. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
Deprecated. Receive notification of an unparsed entity declaration event. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.xml.sax.ContentHandler |
---|
endElement, startElement |
Methods inherited from interface org.xml.sax.DocumentHandler |
---|
endElement, startElement |
Method Detail |
---|
public DocumentHandler asDocumentHandler() throws java.io.IOException
Serializer
DocumentHandler
interface into this serializer.
If the serializer does not support the DocumentHandler
interface, it should return null.
asDocumentHandler
in interface Serializer
java.io.IOException
public ContentHandler asContentHandler() throws java.io.IOException
Serializer
ContentHandler
interface into this serializer.
If the serializer does not support the ContentHandler
interface, it should return null.
asContentHandler
in interface Serializer
java.io.IOException
public DOMSerializer asDOMSerializer() throws java.io.IOException
Serializer
DOMSerializer
interface into this serializer.
If the serializer does not support the DOMSerializer
interface, it should return null.
asDOMSerializer
in interface Serializer
java.io.IOException
public void setOutputByteStream(java.io.OutputStream output)
Serializer
setOutputByteStream
in interface Serializer
public void setOutputCharStream(java.io.Writer writer)
Serializer
setOutputCharStream
in interface Serializer
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
format
- The output format to usepublic boolean reset()
public void serialize(Element elem) throws java.io.IOException
serialize
in interface DOMSerializer
elem
- The element to serialize
java.io.IOException
- An I/O exception occured while
serializingpublic void serialize(DocumentFragment frag) throws java.io.IOException
serialize
in interface DOMSerializer
frag
- The document fragment to serialize
java.io.IOException
- An I/O exception occured while
serializingpublic void serialize(Document doc) throws java.io.IOException
serialize
in interface DOMSerializer
doc
- The document to serialize
java.io.IOException
- An I/O exception occured while
serializingpublic 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
startDocument
in interface DocumentHandler
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endDocument()
public void characters(char[] chars, 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
characters
in interface DocumentHandler
chars
- the characters from the XML documentstart
- the start position in the arraylength
- 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 ignorableWhitespace(char[] chars, 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
ignorableWhitespace
in interface DocumentHandler
chars
- the characters from the XML documentstart
- the start position in the arraylength
- the number of characters to read from the array
SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.characters(char[], int, int)
public final void processingInstruction(java.lang.String target, java.lang.String code) 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
processingInstruction
in interface DocumentHandler
target
- the processing instruction targetcode
- 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 processingInstructionIO(java.lang.String target, java.lang.String code) throws java.io.IOException
java.io.IOException
public void comment(char[] chars, 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
chars
- 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 comment(java.lang.String text) throws java.io.IOException
java.io.IOException
public void startCDATA()
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
LexicalHandler.endCDATA()
public void endCDATA()
LexicalHandler
endCDATA
in interface LexicalHandler
LexicalHandler.startCDATA()
public void startNonEscaping()
public void endNonEscaping()
public void startPreserving()
public void endPreserving()
public void endDocument() throws SAXException
endDocument
in interface ContentHandler
endDocument
in interface DocumentHandler
SAXException
- An I/O exception occured during
serializingContentHandler.startDocument()
public void startEntity(java.lang.String name)
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]".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 void endEntity(java.lang.String name)
LexicalHandler
endEntity
in interface LexicalHandler
name
- The name of the entity that is ending.LexicalHandler.startEntity(java.lang.String)
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 SAX event callbacks after
startDocument
returns and before
endDocument
is called. The
application should not attempt to use it at any other time.
setDocumentLocator
in interface ContentHandler
setDocumentLocator
in interface DocumentHandler
locator
- an object that can return the location of
any SAX document eventLocator
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 exceptionpublic 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 processingContentHandler.endPrefixMapping(java.lang.String)
,
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
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 mapped.
This is the empty string when a default mapping scope ends.
SAXException
- the client may throw
an exception during processingContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
,
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public final 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 endDTD()
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
LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)
public void elementDecl(java.lang.String name, java.lang.String model) 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.
elementDecl
in interface DeclHandler
name
- The element type name.model
- The content model as a normalized string.
SAXException
- The application may raise an exception.public void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value) 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.
attributeDecl
in interface DeclHandler
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 defaulting mode
("#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.
SAXException
- The application may raise an exception.public void internalEntityDecl(java.lang.String name, java.lang.String value) 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.
internalEntityDecl
in interface DeclHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.value
- The replacement text of the entity.
SAXException
- The application may raise an exception.DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
DeclHandler
Only the effective (first) declaration for each entity will be reported.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
externalEntityDecl
in interface DeclHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.publicId
- The entity's public identifier, or null if none
was given.systemId
- The entity's system identifier.
SAXException
- The application may raise an exception.DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) throws SAXException
DTDHandler
Note that the notation name corresponds to a notation
reported by the notationDecl
event.
It is up to the application to record the entity for later
reference, if necessary;
unparsed entities may appear as attribute values.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
unparsedEntityDecl
in interface DTDHandler
name
- The unparsed entity's name.publicId
- The entity's public identifier, or null if none
was given.systemId
- The entity's system identifier.notationName
- The name of the associated notation.
SAXException
- Any SAX exception, possibly
wrapping another exception.DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
DTDHandler
It is up to the application to record the notation for later reference, if necessary; notations may appear as attribute values and in unparsed entity declarations, and are sometime used with processing instruction target names.
At least one of publicId and systemId must be non-null. If a system identifier is present, and it is a URL, the SAX parser must resolve it fully before passing it to the application through this event.
There is no guarantee that the notation declaration will be reported before any unparsed entities that use it.
notationDecl
in interface DTDHandler
name
- The notation name.publicId
- The notation's public identifier, or null if
none was given.systemId
- The notation's system identifier, or null if
none was given.
SAXException
- Any SAX exception, possibly
wrapping another exception.DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
,
Attributes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |