|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--org.apache.xml.serialize.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| Field Summary | |
protected java.lang.String |
_docTypePublicId
Deprecated. The system identifier of the document type, if known. |
protected java.lang.String |
_docTypeSystemId
Deprecated. The system identifier of the document type, if known. |
protected EncodingInfo |
_encodingInfo
Deprecated. |
protected OutputFormat |
_format
Deprecated. The output format associated with this serializer. |
protected boolean |
_indenting
Deprecated. True if indenting printer. |
protected java.util.Hashtable |
_prefixes
Deprecated. Association between namespace URIs (keys) and prefixes (values). |
protected Printer |
_printer
Deprecated. The printer used for printing text parts. |
protected boolean |
_started
Deprecated. If the document has been started (header serialized), this flag is set to true so it's not started twice. |
protected org.w3c.dom.Node |
fCurrentNode
Deprecated. Current node that is being processed |
protected org.apache.xerces.dom.DOMErrorImpl |
fDOMError
Deprecated. |
protected org.w3c.dom.DOMErrorHandler |
fDOMErrorHandler
Deprecated. |
protected org.w3c.dom.ls.LSSerializerFilter |
fDOMFilter
Deprecated. |
protected short |
features
Deprecated. |
protected java.lang.StringBuffer |
fStrBuffer
Deprecated. Temporary buffer to store character data |
| Constructor Summary | |
protected |
BaseMarkupSerializer(OutputFormat format)
Deprecated. Protected constructor can only be used by derived class. |
| Method Summary | |
org.xml.sax.ContentHandler |
asContentHandler()
Deprecated. Return a ContentHandler interface into this serializer. |
org.xml.sax.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. |
void |
characters(char[] chars,
int start,
int length)
Deprecated. |
protected void |
characters(java.lang.String text)
Deprecated. Called to print the text contents in the prevailing element format. |
protected void |
checkUnboundNamespacePrefixedNode(org.w3c.dom.Node node)
Deprecated. DOM level 3: Check a node to determine if it contains unbound namespace prefixes. |
void |
comment(char[] chars,
int start,
int length)
Deprecated. |
void |
comment(java.lang.String text)
Deprecated. |
protected ElementState |
content()
Deprecated. Must be called by a method about to print any type of content. |
void |
elementDecl(java.lang.String name,
java.lang.String model)
Deprecated. |
void |
endCDATA()
Deprecated. |
void |
endDocument()
Deprecated. Called at the end of the document to wrap it up. |
void |
endDTD()
Deprecated. |
void |
endEntity(java.lang.String name)
Deprecated. |
void |
endNonEscaping()
Deprecated. |
void |
endPrefixMapping(java.lang.String prefix)
Deprecated. |
void |
endPreserving()
Deprecated. |
protected ElementState |
enterElementState(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
boolean preserveSpace)
Deprecated. Enter a new element state for the specified element. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. |
protected void |
fatalError(java.lang.String message)
Deprecated. |
protected ElementState |
getElementState()
Deprecated. Return the state of the current element. |
protected abstract java.lang.String |
getEntityRef(int ch)
Deprecated. Returns the suitable entity reference for this character value, or null if no such entity exists. |
protected java.lang.String |
getPrefix(java.lang.String namespaceURI)
Deprecated. Returns the namespace prefix for the specified URI. |
void |
ignorableWhitespace(char[] chars,
int start,
int length)
Deprecated. |
void |
internalEntityDecl(java.lang.String name,
java.lang.String value)
Deprecated. |
protected boolean |
isDocumentState()
Deprecated. Returns true if in the state of the document. |
protected ElementState |
leaveElementState()
Deprecated. Leave the current element state and return to the state of the parent element. |
protected org.w3c.dom.DOMError |
modifyDOMError(java.lang.String message,
short severity,
java.lang.String type,
org.w3c.dom.Node node)
Deprecated. The method modifies global DOM error object |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. |
protected void |
prepare()
Deprecated. |
protected void |
printCDATAText(java.lang.String text)
Deprecated. |
protected void |
printDoctypeURL(java.lang.String url)
Deprecated. Print a document type public or system identifier URL. |
protected void |
printEscaped(int ch)
Deprecated. |
protected void |
printEscaped(java.lang.String source)
Deprecated. Escapes a string so it may be printed as text content or attribute value. |
protected void |
printText(char[] chars,
int start,
int length,
boolean preserveSpace,
boolean unescaped)
Deprecated. Called to print additional text with whitespace handling. |
protected void |
printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
Deprecated. |
void |
processingInstruction(java.lang.String target,
java.lang.String code)
Deprecated. |
void |
processingInstructionIO(java.lang.String target,
java.lang.String code)
Deprecated. |
boolean |
reset()
Deprecated. |
void |
serialize(org.w3c.dom.Document doc)
Deprecated. Serializes the DOM document using the previously specified writer and output format. |
void |
serialize(org.w3c.dom.DocumentFragment frag)
Deprecated. Serializes the DOM document fragmnt using the previously specified writer and output format. |
void |
serialize(org.w3c.dom.Element elem)
Deprecated. Serializes the DOM element using the previously specified writer and output format. |
protected abstract void |
serializeElement(org.w3c.dom.Element elem)
Deprecated. Called to serializee the DOM element. |
protected void |
serializeNode(org.w3c.dom.Node node)
Deprecated. Serialize the DOM node. |
protected void |
serializePreRoot()
Deprecated. Comments and PIs cannot be serialized before the root element, because the root element serializes the document type, which generally comes first. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Deprecated. |
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. |
void |
startCDATA()
Deprecated. |
void |
startDocument()
Deprecated. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Deprecated. |
void |
startEntity(java.lang.String name)
Deprecated. |
void |
startNonEscaping()
Deprecated. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Deprecated. |
void |
startPreserving()
Deprecated. |
protected void |
surrogates(int high,
int low,
boolean inContent)
Deprecated. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
Deprecated. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, 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 |
| Field Detail |
protected short features
protected org.w3c.dom.DOMErrorHandler fDOMErrorHandler
protected final org.apache.xerces.dom.DOMErrorImpl fDOMError
protected org.w3c.dom.ls.LSSerializerFilter fDOMFilter
protected EncodingInfo _encodingInfo
protected boolean _started
protected java.util.Hashtable _prefixes
protected java.lang.String _docTypePublicId
protected java.lang.String _docTypeSystemId
protected OutputFormat _format
protected Printer _printer
protected boolean _indenting
protected final java.lang.StringBuffer fStrBuffer
protected org.w3c.dom.Node fCurrentNode
| Constructor Detail |
protected BaseMarkupSerializer(OutputFormat format)
setOutputCharStream(java.io.Writer) or setOutputByteStream(java.io.OutputStream)
first| Method Detail |
public org.xml.sax.DocumentHandler asDocumentHandler()
throws java.io.IOException
SerializerDocumentHandler interface into this serializer.
If the serializer does not support the DocumentHandler
interface, it should return null.asDocumentHandler in interface Serializer
public org.xml.sax.ContentHandler asContentHandler()
throws java.io.IOException
SerializerContentHandler interface into this serializer.
If the serializer does not support the ContentHandler
interface, it should return null.asContentHandler in interface Serializer
public DOMSerializer asDOMSerializer()
throws java.io.IOException
SerializerDOMSerializer interface into this serializer.
If the serializer does not support the DOMSerializer
interface, it should return null.asDOMSerializer in interface Serializerpublic void setOutputByteStream(java.io.OutputStream output)
SerializersetOutputByteStream in interface Serializerpublic void setOutputCharStream(java.io.Writer writer)
SerializersetOutputCharStream in interface Serializerpublic void setOutputFormat(OutputFormat format)
SerializersetOutputFormat in interface Serializerorg.apache.xml.serialize.Serializerformat - The output format to usepublic boolean reset()
protected void prepare()
throws java.io.IOException
public void serialize(org.w3c.dom.Element elem)
throws java.io.IOException
serialize in interface DOMSerializerelem - The element to serializejava.io.IOException - An I/O exception occured while
serializing
public void serialize(org.w3c.dom.DocumentFragment frag)
throws java.io.IOException
serialize in interface DOMSerializerfrag - The document fragment to serializejava.io.IOException - An I/O exception occured while
serializing
public void serialize(org.w3c.dom.Document doc)
throws java.io.IOException
serialize in interface DOMSerializerdoc - The document to serializejava.io.IOException - An I/O exception occured while
serializing
public void startDocument()
throws org.xml.sax.SAXException
startDocument in interface org.xml.sax.ContentHandler
public void characters(char[] chars,
int start,
int length)
throws org.xml.sax.SAXException
characters in interface org.xml.sax.ContentHandler
public void ignorableWhitespace(char[] chars,
int start,
int length)
throws org.xml.sax.SAXException
ignorableWhitespace in interface org.xml.sax.ContentHandler
public final void processingInstruction(java.lang.String target,
java.lang.String code)
throws org.xml.sax.SAXException
processingInstruction in interface org.xml.sax.ContentHandler
public void processingInstructionIO(java.lang.String target,
java.lang.String code)
throws java.io.IOException
public void comment(char[] chars,
int start,
int length)
throws org.xml.sax.SAXException
comment in interface org.xml.sax.ext.LexicalHandler
public void comment(java.lang.String text)
throws java.io.IOException
public void startCDATA()
startCDATA in interface org.xml.sax.ext.LexicalHandlerpublic void endCDATA()
endCDATA in interface org.xml.sax.ext.LexicalHandlerpublic void startNonEscaping()
public void endNonEscaping()
public void startPreserving()
public void endPreserving()
public void endDocument()
throws org.xml.sax.SAXException
endDocument in interface org.xml.sax.ContentHandlerorg.xml.sax.SAXException - An I/O exception occured during
serializingpublic void startEntity(java.lang.String name)
startEntity in interface org.xml.sax.ext.LexicalHandlerpublic void endEntity(java.lang.String name)
endEntity in interface org.xml.sax.ext.LexicalHandlerpublic void setDocumentLocator(org.xml.sax.Locator locator)
setDocumentLocator in interface org.xml.sax.ContentHandler
public void skippedEntity(java.lang.String name)
throws org.xml.sax.SAXException
skippedEntity in interface org.xml.sax.ContentHandler
public void startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
throws org.xml.sax.SAXException
startPrefixMapping in interface org.xml.sax.ContentHandler
public void endPrefixMapping(java.lang.String prefix)
throws org.xml.sax.SAXException
endPrefixMapping in interface org.xml.sax.ContentHandler
public final void startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
throws org.xml.sax.SAXException
startDTD in interface org.xml.sax.ext.LexicalHandlerpublic void endDTD()
endDTD in interface org.xml.sax.ext.LexicalHandler
public void elementDecl(java.lang.String name,
java.lang.String model)
throws org.xml.sax.SAXException
elementDecl in interface org.xml.sax.ext.DeclHandler
public void attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
throws org.xml.sax.SAXException
attributeDecl in interface org.xml.sax.ext.DeclHandler
public void internalEntityDecl(java.lang.String name,
java.lang.String value)
throws org.xml.sax.SAXException
internalEntityDecl in interface org.xml.sax.ext.DeclHandler
public void externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
throws org.xml.sax.SAXException
externalEntityDecl in interface org.xml.sax.ext.DeclHandler
public void unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
throws org.xml.sax.SAXException
unparsedEntityDecl in interface org.xml.sax.DTDHandler
public void notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
throws org.xml.sax.SAXException
notationDecl in interface org.xml.sax.DTDHandler
protected void serializeNode(org.w3c.dom.Node node)
throws java.io.IOException
serializeElement(org.w3c.dom.Element).node - The node to serializejava.io.IOException - An I/O exception occured while
serializingserializeElement(org.w3c.dom.Element)
protected ElementState content()
throws java.io.IOException
java.io.IOException - An I/O exception occurred while
serializing
protected void characters(java.lang.String text)
throws java.io.IOException
text - The text to printjava.io.IOException - An I/O exception occured while
serializingprotected abstract java.lang.String getEntityRef(int ch)
ch - Character value
protected abstract void serializeElement(org.w3c.dom.Element elem)
throws java.io.IOException
elem - The element to serializejava.io.IOException - An I/O exception occured while
serializing
protected void serializePreRoot()
throws java.io.IOException
java.io.IOException - An I/O exception occured while
serializing
protected void printCDATAText(java.lang.String text)
throws java.io.IOException
protected void surrogates(int high,
int low,
boolean inContent)
throws java.io.IOException
protected void printText(char[] chars,
int start,
int length,
boolean preserveSpace,
boolean unescaped)
throws java.io.IOException
printText(String,boolean,boolean) with a call to Printer.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.chars - The text to printstart - The start offsetlength - The number of characterspreserveSpace - Space preserving flagunescaped - Print unescaped
protected void printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
throws java.io.IOException
protected void printDoctypeURL(java.lang.String url)
throws java.io.IOException
printText(char[], int, int, boolean, boolean).url - The document type url to print
protected void printEscaped(int ch)
throws java.io.IOException
protected void printEscaped(java.lang.String source)
throws java.io.IOException
source - The string to escapeprotected ElementState getElementState()
protected ElementState enterElementState(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
boolean preserveSpace)
protected ElementState leaveElementState()
protected boolean isDocumentState()
protected java.lang.String getPrefix(java.lang.String namespaceURI)
namespaceURI - The namespace URI
protected org.w3c.dom.DOMError modifyDOMError(java.lang.String message,
short severity,
java.lang.String type,
org.w3c.dom.Node node)
message - severity - type -
protected void fatalError(java.lang.String message)
throws java.io.IOException
protected void checkUnboundNamespacePrefixedNode(org.w3c.dom.Node node)
throws java.io.IOException
node - The node to check for unbound namespace prefices
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||