|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--weblogic.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 #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 serialize(org.w3c.dom.Element)
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
,
DOMSerializer
Field Summary | |
protected java.lang.String |
_docTypePublicId
The system identifier of the document type, if known. |
protected java.lang.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 java.util.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. |
Constructor Summary | |
protected |
BaseMarkupSerializer(OutputFormat format)
Protected constructor can only be used by derived class. |
Method Summary | |
org.xml.sax.ContentHandler |
asContentHandler()
|
org.xml.sax.DocumentHandler |
asDocumentHandler()
|
DOMSerializer |
asDOMSerializer()
|
void |
attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
|
void |
characters(char[] chars,
int start,
int length)
|
protected void |
characters(java.lang.String text)
Called to print the text contents in the prevailing element format. |
void |
comment(char[] chars,
int start,
int length)
|
void |
comment(java.lang.String text)
|
protected weblogic.apache.xml.serialize.ElementState |
content()
Must be called by a method about to print any type of content. |
void |
elementDecl(java.lang.String name,
java.lang.String model)
|
void |
endCDATA()
|
void |
endDocument()
Called at the end of the document to wrap it up. |
void |
endDTD()
|
void |
endEntity(java.lang.String name)
|
void |
endNonEscaping()
|
void |
endPrefixMapping(java.lang.String prefix)
|
void |
endPreserving()
|
protected weblogic.apache.xml.serialize.ElementState |
enterElementState(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
boolean preserveSpace)
Enter a new element state for the specified element. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
|
protected weblogic.apache.xml.serialize.ElementState |
getElementState()
Return the state of the current element. |
protected abstract java.lang.String |
getEntityRef(int ch)
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)
Returns the namespace prefix for the specified URI. |
void |
ignorableWhitespace(char[] chars,
int start,
int length)
|
void |
internalEntityDecl(java.lang.String name,
java.lang.String value)
|
protected boolean |
isDocumentState()
Returns true if in the state of the document. |
protected weblogic.apache.xml.serialize.ElementState |
leaveElementState()
Leave the current element state and return to the state of the parent element. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
|
protected void |
prepare()
|
protected void |
printDoctypeURL(java.lang.String url)
Print a document type public or system identifier URL. |
protected void |
printEscaped(int ch)
|
protected void |
printEscaped(java.lang.String source)
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)
Called to print additional text with whitespace handling. |
protected void |
printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
|
void |
processingInstruction(java.lang.String target,
java.lang.String code)
|
boolean |
reset()
|
void |
serialize(org.w3c.dom.Document doc)
Serializes the DOM document using the previously specified writer and output format. |
void |
serialize(org.w3c.dom.DocumentFragment frag)
Serializes the DOM document fragmnt using the previously specified writer and output format. |
void |
serialize(org.w3c.dom.Element elem)
Serializes the DOM element using the previously specified writer and output format. |
protected abstract void |
serializeElement(org.w3c.dom.Element elem)
Called to serializee the DOM element. |
protected void |
serializeNode(org.w3c.dom.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. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
|
void |
setOutputByteStream(java.io.OutputStream output)
|
void |
setOutputCharStream(java.io.Writer writer)
|
void |
setOutputFormat(OutputFormat format)
|
void |
skippedEntity(java.lang.String name)
|
void |
startCDATA()
|
void |
startDocument()
|
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
|
void |
startEntity(java.lang.String name)
|
void |
startNonEscaping()
|
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
|
void |
startPreserving()
|
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
|
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
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
Constructor Detail |
protected BaseMarkupSerializer(OutputFormat format)
#init
.Method Detail |
public org.xml.sax.DocumentHandler asDocumentHandler() throws java.io.IOException
public org.xml.sax.ContentHandler asContentHandler() throws java.io.IOException
public DOMSerializer asDOMSerializer() throws java.io.IOException
public void setOutputByteStream(java.io.OutputStream output)
public void setOutputCharStream(java.io.Writer writer)
public void setOutputFormat(OutputFormat format)
public boolean reset()
protected void prepare() throws java.io.IOException
public void serialize(org.w3c.dom.Element elem) throws java.io.IOException
elem
- The element to serializepublic void serialize(org.w3c.dom.DocumentFragment frag) throws java.io.IOException
elem
- The element to serializepublic void serialize(org.w3c.dom.Document doc) throws java.io.IOException
doc
- The document to serializepublic void startDocument() throws org.xml.sax.SAXException
public void characters(char[] chars, int start, int length)
public void ignorableWhitespace(char[] chars, int start, int length)
public void processingInstruction(java.lang.String target, java.lang.String code)
public void comment(char[] chars, int start, int length)
public void comment(java.lang.String text)
public void startCDATA()
public void endCDATA()
public void startNonEscaping()
public void endNonEscaping()
public void startPreserving()
public void endPreserving()
public void endDocument() throws org.xml.sax.SAXException
public void startEntity(java.lang.String name)
public void endEntity(java.lang.String name)
public void setDocumentLocator(org.xml.sax.Locator locator)
public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
public void endDTD()
public void elementDecl(java.lang.String name, java.lang.String model)
public void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value)
public void internalEntityDecl(java.lang.String name, java.lang.String value)
public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
protected void serializeNode(org.w3c.dom.Node node)
serializeElement(org.w3c.dom.Element)
.
node
- The node to serializeserializeElement(org.w3c.dom.Element)
protected weblogic.apache.xml.serialize.ElementState content()
protected void characters(java.lang.String text)
text
- The text to printunescaped
- True is should print unescapedprotected abstract java.lang.String getEntityRef(int ch)
ch
- Character valueprotected abstract void serializeElement(org.w3c.dom.Element elem)
elem
- The element to serializeprotected void serializePreRoot()
protected final void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
#printText(String)
with a call to #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.
text
- The text to printpreserveSpace
- Space preserving flagunescaped
- Print unescapedprotected final void printText(java.lang.String text, boolean preserveSpace, boolean unescaped)
protected void printDoctypeURL(java.lang.String url)
printText(char[], int, int, boolean, boolean)
.
url
- The document type url to printprotected void printEscaped(int ch)
protected void printEscaped(java.lang.String source)
source
- The string to escapeprotected weblogic.apache.xml.serialize.ElementState getElementState()
protected weblogic.apache.xml.serialize.ElementState enterElementState(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, boolean preserveSpace)
protected weblogic.apache.xml.serialize.ElementState leaveElementState()
protected boolean isDocumentState()
protected java.lang.String getPrefix(java.lang.String namespaceURI)
namespaceURI
- The namespace URI
|
Documentation is available at http://e-docs.bea.com/wls/docs61 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |