| java.lang.Object
 org.apache.xml.serialize.BaseMarkupSerializer
All known Subclasses: org.apache.xml.serialize.XMLSerializer, org.apache.xml.serialize.TextSerializer, org.apache.xml.serialize.HTMLSerializer,
| BaseMarkupSerializer | | abstract public class BaseMarkupSerializer implements ContentHandler,DocumentHandler,LexicalHandler,DTDHandler,DeclHandler,DOMSerializer,Serializer(Code) | | 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
BaseMarkupSerializer.init .
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
BaseMarkupSerializer.serialize 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
org.xml.sax.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.
version:
$Revision: 1.26 $ $Date: 2001/07/11 15:40:10 $
author:
Assaf Arkin
See Also: Serializer
See Also: DOMSerializer |
| Field Summary | |
| protected String | _docTypePublicId
The system identifier of the document type, if known. | | protected String | _docTypeSystemId
The system identifier of the document type, if known. | | protected OutputFormat | _format
The output format associated with this serializer. | | protected boolean | _indenting
True if indenting printer. | | protected Hashtable | _prefixes
Association between namespace URIs (keys) and prefixes (values). | | protected Printer | _printer
The printer used for printing text parts. | | protected boolean | _started
If the document has been started (header serialized), this
flag is set to true so it's not started twice. |
| Method Summary | |
| public ContentHandler | asContentHandler()
| | public DOMSerializer | asDOMSerializer()
| | public DocumentHandler | asDocumentHandler()
| | public void | attributeDecl(String eName, String aName, String type, String valueDefault, String value)
| | public void | characters(char[] chars, int start, int length)
| | protected void | characters(String text)
Called to print the text contents in the prevailing element format.
Since this method is capable of printing text as CDATA, it is used
for that purpose as well. | | public void | comment(char[] chars, int start, int length)
| | public void | comment(String text)
| | protected ElementState | content()
Must be called by a method about to print any type of content.
If the element was just opened, the opening tag is closed and
will be matched to a closing tag. | | public void | elementDecl(String name, String model)
| | public void | endCDATA()
| | public void | endDTD()
| | public void | endDocument()
Called at the end of the document to wrap it up. | | public void | endEntity(String name)
| | public void | endNonEscaping()
| | public void | endPrefixMapping(String prefix)
| | public void | endPreserving()
| | protected ElementState | enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)
Enter a new element state for the specified element. | | public void | externalEntityDecl(String name, String publicId, String systemId)
| | protected ElementState | getElementState()
Return the state of the current element. | | abstract protected String | getEntityRef(int ch)
Returns the suitable entity reference for this character value,
or null if no such entity exists. | | protected String | getPrefix(String namespaceURI)
Returns the namespace prefix for the specified URI. | | public void | ignorableWhitespace(char[] chars, int start, int length)
| | public void | internalEntityDecl(String name, String value)
| | protected boolean | isDocumentState()
Returns true if in the state of the document. | | protected ElementState | leaveElementState()
Leave the current element state and return to the
state of the parent element. | | public void | notationDecl(String name, String publicId, String systemId)
| | protected void | prepare()
| | protected void | printDoctypeURL(String url)
Print a document type public or system identifier URL. | | protected void | printEscaped(int ch)
| | protected void | printEscaped(String source)
Escapes a string so it may be printed as text content or attribute
value. | | final protected void | printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
Called to print additional text with whitespace handling.
If spaces are preserved, the text is printed as if by calling
BaseMarkupSerializer.printText(String) with a call to
BaseMarkupSerializer.breakLine for each new line. | | final protected void | printText(String text, boolean preserveSpace, boolean unescaped)
| | final public void | processingInstruction(String target, String code)
| | public void | processingInstructionIO(String target, String code)
| | public boolean | reset()
| | public void | serialize(Element elem)
Serializes the DOM element using the previously specified
writer and output format. | | public void | serialize(DocumentFragment frag)
Serializes the DOM document fragmnt using the previously specified
writer and output format. | | public void | serialize(Document doc)
Serializes the DOM document using the previously specified
writer and output format. | | abstract protected void | serializeElement(Element elem)
Called to serializee the DOM element. | | protected void | serializeNode(Node node)
Serialize the DOM node. | | protected void | serializePreRoot()
Comments and PIs cannot be serialized before the root element,
because the root element serializes the document type, which
generally comes first. | | public void | setDocumentLocator(Locator locator)
| | public void | setOutputByteStream(OutputStream output)
| | public void | setOutputCharStream(Writer writer)
| | public void | setOutputFormat(OutputFormat format)
| | public void | skippedEntity(String name)
| | public void | startCDATA()
| | final public void | startDTD(String name, String publicId, String systemId)
| | public void | startDocument()
| | public void | startEntity(String name)
| | public void | startNonEscaping()
| | public void | startPrefixMapping(String prefix, String uri)
| | public void | startPreserving()
| | public void | unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
|
| _docTypePublicId | | protected String _docTypePublicId(Code) | | The system identifier of the document type, if known.
|
| _docTypeSystemId | | protected String _docTypeSystemId(Code) | | The system identifier of the document type, if known.
|
| _format | | protected OutputFormat _format(Code) | | The output format associated with this serializer. This will never
be a null reference. If no format was passed to the constructor,
the default one for this document type will be used. The format
object is never changed by the serializer.
|
| _indenting | | protected boolean _indenting(Code) | | True if indenting printer.
|
| _prefixes | | protected Hashtable _prefixes(Code) | | Association between namespace URIs (keys) and prefixes (values).
Accumulated here prior to starting an element and placing this
list in the element state.
|
| _printer | | protected Printer _printer(Code) | | The printer used for printing text parts.
|
| _started | | protected boolean _started(Code) | | If the document has been started (header serialized), this
flag is set to true so it's not started twice.
|
| BaseMarkupSerializer | | protected BaseMarkupSerializer(OutputFormat format)(Code) | | Protected constructor can only be used by derived class.
Must initialize the serializer before serializing any document,
see
BaseMarkupSerializer.init .
|
| characters | | public void characters(char[] chars, int start, int length) throws SAXException(Code) | | |
| characters | | protected void characters(String text) throws IOException(Code) | | Called to print the text contents in the prevailing element format.
Since this method is capable of printing text as CDATA, it is used
for that purpose as well. White space handling is determined by the
current element state. In addition, the output format can dictate
whether the text is printed as CDATA or unescaped.
Parameters:
text - The text to print
Parameters:
unescaped - True is should print unescaped
throws:
IOException - An I/O exception occured whileserializing |
| content | | protected ElementState content() throws IOException(Code) | | Must be called by a method about to print any type of content.
If the element was just opened, the opening tag is closed and
will be matched to a closing tag. Returns the current element
state with empty and afterElement set to false.
The current element state
throws:
IOException - An I/O exception occured whileserializing |
| endCDATA | | public void endCDATA()(Code) | | |
| endDTD | | public void endDTD()(Code) | | |
| endDocument | | public void endDocument() throws SAXException(Code) | | Called at the end of the document to wrap it up.
Will flush the output stream and throw an exception
if any I/O error occured while serializing.
throws:
SAXException - An I/O exception occured duringserializing |
| endNonEscaping | | public void endNonEscaping()(Code) | | |
| endPreserving | | public void endPreserving()(Code) | | |
| enterElementState | | protected ElementState enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)(Code) | | Enter a new element state for the specified element.
Tag name and space preserving is specified, element
state is initially empty.
Current element state, or null |
| getElementState | | protected ElementState getElementState()(Code) | | Return the state of the current element.
Current element state |
| getEntityRef | | abstract protected String getEntityRef(int ch)(Code) | | Returns the suitable entity reference for this character value,
or null if no such entity exists. Calling this method with '&'
will return "&".
Parameters:
ch - Character value Character entity name, or null |
| getPrefix | | protected String getPrefix(String namespaceURI)(Code) | | Returns the namespace prefix for the specified URI.
If the URI has been mapped to a prefix, returns the
prefix, otherwise returns null.
Parameters:
namespaceURI - The namespace URI The namespace prefix if known, or null |
| ignorableWhitespace | | public void ignorableWhitespace(char[] chars, int start, int length) throws SAXException(Code) | | |
| isDocumentState | | protected boolean isDocumentState()(Code) | | Returns true if in the state of the document.
Returns true before entering any element and after
leaving the root element.
True if in the state of the document |
| leaveElementState | | protected ElementState leaveElementState()(Code) | | Leave the current element state and return to the
state of the parent element. If this was the root
element, return to the state of the document.
Previous element state |
| printDoctypeURL | | protected void printDoctypeURL(String url) throws IOException(Code) | | Print a document type public or system identifier URL.
Encapsulates the URL in double quotes, escapes non-printing
characters and print it equivalent to
BaseMarkupSerializer.printText .
Parameters:
url - The document type url to print |
| printEscaped | | protected void printEscaped(String source) throws IOException(Code) | | Escapes a string so it may be printed as text content or attribute
value. Non printable characters are escaped using character references.
Where the format specifies a deault entity reference, that reference
is used (e.g. <).
Parameters:
source - The string to escape |
| printText | | final protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException(Code) | | Called to print additional text with whitespace handling.
If spaces are preserved, the text is printed as if by calling
BaseMarkupSerializer.printText(String) with a call to
BaseMarkupSerializer.breakLine for each new line. If spaces are not preserved, the text is
broken at space boundaries if longer than the line width;
Multiple spaces are printed as such, but spaces at beginning
of line are removed.
Parameters:
text - The text to print
Parameters:
preserveSpace - Space preserving flag
Parameters:
unescaped - Print unescaped |
| printText | | final protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException(Code) | | |
| reset | | public boolean reset()(Code) | | |
| serialize | | public void serialize(Element elem) throws IOException(Code) | | Serializes the DOM element using the previously specified
writer and output format. Throws an exception only if
an I/O exception occured while serializing.
Parameters:
elem - The element to serialize
throws:
IOException - An I/O exception occured whileserializing |
| serialize | | public void serialize(DocumentFragment frag) throws IOException(Code) | | Serializes the DOM document fragmnt using the previously specified
writer and output format. Throws an exception only if
an I/O exception occured while serializing.
Parameters:
elem - The element to serialize
throws:
IOException - An I/O exception occured whileserializing |
| serialize | | public void serialize(Document doc) throws IOException(Code) | | Serializes the DOM document using the previously specified
writer and output format. Throws an exception only if
an I/O exception occured while serializing.
Parameters:
doc - The document to serialize
throws:
IOException - An I/O exception occured whileserializing |
| serializeElement | | abstract protected void serializeElement(Element elem) throws IOException(Code) | | Called to serializee the DOM element. The element is serialized based on
the serializer's method (XML, HTML, XHTML).
Parameters:
elem - The element to serialize
throws:
IOException - An I/O exception occured whileserializing |
| serializePreRoot | | protected void serializePreRoot() throws IOException(Code) | | Comments and PIs cannot be serialized before the root element,
because the root element serializes the document type, which
generally comes first. Instead such PIs and comments are
accumulated inside a vector and serialized by calling this
method. Will be called when the root element is serialized
and when the document finished serializing.
throws:
IOException - An I/O exception occured whileserializing |
| setDocumentLocator | | public void setDocumentLocator(Locator locator)(Code) | | |
| setOutputCharStream | | public void setOutputCharStream(Writer writer)(Code) | | |
| startCDATA | | public void startCDATA()(Code) | | |
| startNonEscaping | | public void startNonEscaping()(Code) | | |
| startPreserving | | public void startPreserving()(Code) | | |
|
|