|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xml.serializer.SerializerBase | +--org.apache.xml.serializer.ToStream
This abstract class is a base class for other stream serializers (xml, html, text ...) that write output to a stream.
Fields inherited from class org.apache.xml.serializer.SerializerBase |
PKG_NAME,
PKG_PATH |
Constructor Summary | |
ToStream()
Default constructor |
Method Summary | |
boolean |
addAttributeAlways(java.lang.String uri,
java.lang.String localName,
java.lang.String rawName,
java.lang.String type,
java.lang.String value,
boolean xslAttribute)
Adds the given attribute to the set of attributes, even if there is no currently open element. |
void |
addCdataSectionElements(java.lang.String URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements by appending the given cdata section elements to the list. |
void |
attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
Report an attribute type declaration. |
void |
characters(char[] chars,
int start,
int length)
Receive notification of character data. |
void |
characters(java.lang.String s)
Receive notification of character data. |
void |
comment(char[] ch,
int start,
int length)
Receive notification of an XML comment anywhere in the document. |
void |
elementDecl(java.lang.String name,
java.lang.String model)
Report an element type declaration. |
void |
endCDATA()
Report the end of a CDATA section. |
void |
endDTD()
Report the end of DTD declarations. |
void |
endElement(java.lang.String name)
Receive notification of the end of an element. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String name)
Receive notification of the end of an element. |
void |
endNonEscaping()
Ends an un-escaping section. |
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI Namespace mapping. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report a parsed external entity declaration. |
void |
flushPending()
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section. |
int |
getIndentAmount()
Returns the m_indentAmount. |
java.util.Properties |
getOutputFormat()
Returns the output format 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[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content. |
void |
internalEntityDecl(java.lang.String name,
java.lang.String value)
Report an internal entity declaration. |
void |
notationDecl(java.lang.String name,
java.lang.String pubID,
java.lang.String sysID)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities. |
void |
processAttributes(java.io.Writer writer,
int nAttrs)
Process the attributes, which means to write out the currently collected attributes to the writer. |
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)
Serializes the DOM node. |
void |
setCdataSectionElements(java.util.Vector URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements. |
void |
setContentHandler(ContentHandler ch)
|
void |
setDTDEntityExpansion(boolean expand)
If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true; |
void |
setEncoding(java.lang.String encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute. |
boolean |
setEscaping(boolean escape)
|
void |
setIndentAmount(int m_indentAmount)
Sets the m_indentAmount. |
boolean |
setLineSepUse(boolean use_sytem_line_break)
Set if the operating systems end-of-line line separator should be used when serializing. |
void |
setNewLine(char[] eolChars)
Sets the end of line characters to be used during serialization |
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 |
setTransformer(Transformer transformer)
|
void |
setWriter(java.io.Writer writer)
Specifies a writer to which the document should be serialized. |
void |
skippedEntity(java.lang.String name)
Receive notification of a skipped entity. |
void |
startCDATA()
Report the start of a CDATA section. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any. |
void |
startElement(java.lang.String elementName)
|
void |
startElement(java.lang.String elementNamespaceURI,
java.lang.String elementLocalName,
java.lang.String elementName)
Receive notification of the beginning of an element, additional namespace or attribute information can occur before or after this call, that is associated with this element. |
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 name)
Report the beginning of an entity. |
void |
startNonEscaping()
Starts an un-escaping section. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. |
boolean |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri,
boolean shouldFlush)
Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String pubID,
java.lang.String sysID,
java.lang.String notationName)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities. |
void |
writeAttrString(java.io.Writer writer,
java.lang.String string,
java.lang.String encoding)
Returns the specified string after substituting specials, and UTF-16 surrogates for chracter references &#xnn . |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public ToStream()
Method Detail |
public void serialize(Node node) throws java.io.IOException
node
- Node to serialize.public java.io.OutputStream getOutputStream()
public void elementDecl(java.lang.String name, java.lang.String model) throws SAXException
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 whitespace is removed,and will include the enclosing parentheses.
name
- The element type name.model
- The content model as a normalized string.public void internalEntityDecl(java.lang.String name, java.lang.String value) throws SAXException
Only the effective (first) declaration for each entity will be reported.
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.value
- The replacement text of the entity.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 setOutputFormat(java.util.Properties format)
format
- The output format to usepublic java.util.Properties getOutputFormat()
public void setWriter(java.io.Writer writer)
writer
- The output writer streampublic boolean setLineSepUse(boolean use_sytem_line_break)
use_sytem_line_break
- True if an input NL is replaced with the
operating systems end-of-line separator.public void setOutputStream(java.io.OutputStream output)
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 streampublic boolean setEscaping(boolean escape)
SerializationHandler.setEscaping(boolean)
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
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", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.
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 default
("#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.public java.io.Writer getWriter()
public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
Only the effective (first) declaration for each entity will be reported.
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.publicId
- The declared public identifier of the entity, or
null if none was declared.systemId
- The declared system identifier of the entity.internalEntityDecl(java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void endNonEscaping() throws SAXException
startNonEscaping()
public void startNonEscaping() throws SAXException
The contents of the un-escaping section will be delivered through the regular characters event.
public void characters(char[] chars, int start, int length) throws SAXException
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.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
chars
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.ignorableWhitespace(char[], int, int)
,
Locator
public void characters(java.lang.String s) throws SAXException
s
- The string of characters to process.public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name, Attributes atts) throws SAXException
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.name
- The element type name.atts
- The attributes attached to the element, if any.ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
,
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
AttributeList
public void startElement(java.lang.String elementNamespaceURI, java.lang.String elementLocalName, java.lang.String elementName) throws SAXException
elementNamespaceURI
- The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.elementLocalName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.elementName
- The element type name.ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
,
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
AttributeList
public void startElement(java.lang.String elementName) throws SAXException
public void processAttributes(java.io.Writer writer, int nAttrs) throws java.io.IOException, SAXException
writer
- the writer to write processed attributes to.nAttrs
- the number of attributes in m_attributes
to be processedpublic void writeAttrString(java.io.Writer writer, java.lang.String string, java.lang.String encoding) throws java.io.IOException
&#xnn
.string
- String to convert to XML format.encoding
- CURRENTLY NOT IMPLEMENTED.public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name) throws SAXException
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.name
- The element type namepublic void endElement(java.lang.String name) throws SAXException
name
- The element type namepublic void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws SAXException
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
public boolean startPrefixMapping(java.lang.String prefix, java.lang.String uri, boolean shouldFlush) throws SAXException
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.shouldFlush
- true if any open tags need to be closed first, this
will impact which element the mapping applies to (open parent, or its up
comming child)ExtendedContentHandler.startPrefixMapping(java.lang.String, java.lang.String, boolean)
public void comment(char[] ch, int start, int length) throws SAXException
ch
- 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.public void endCDATA() throws SAXException
startCDATA()
public void endDTD() throws SAXException
startDTD(java.lang.String, java.lang.String, java.lang.String)
public void endPrefixMapping(java.lang.String prefix) throws SAXException
prefix
- The prefix that was being mapping.ContentHandler.endPrefixMapping(java.lang.String)
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.characters(char[], int, int)
public void skippedEntity(java.lang.String name) throws SAXException
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]".ContentHandler.skippedEntity(java.lang.String)
public void startCDATA() throws SAXException
endCDATA()
public void startEntity(java.lang.String name) throws SAXException
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.SerializerBase.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 startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
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.endDTD()
,
startEntity(java.lang.String)
public int getIndentAmount()
public void setIndentAmount(int m_indentAmount)
m_indentAmount
- The m_indentAmount to setpublic void setCdataSectionElements(java.util.Vector URI_and_localNames)
URI_and_localNames
- a vector of pairs of Strings (URI/local)public void flushPending() throws SAXException
public void setContentHandler(ContentHandler ch)
public boolean addAttributeAlways(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value, boolean xslAttribute)
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 attributexslAttribute
- true if this attribute is coming from an xsl:attribute element.public void setTransformer(Transformer transformer)
SerializationHandler.setTransformer(Transformer)
public boolean reset()
public void setEncoding(java.lang.String encoding)
encoding
- the character encodingpublic void notationDecl(java.lang.String name, java.lang.String pubID, java.lang.String sysID) throws SAXException
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
public void unparsedEntityDecl(java.lang.String name, java.lang.String pubID, java.lang.String sysID, java.lang.String notationName) throws SAXException
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void setDTDEntityExpansion(boolean expand)
public void setNewLine(char[] eolChars)
eolChars
- A character array corresponding to the characters to be used.public void addCdataSectionElements(java.lang.String URI_and_localNames)
URI_and_localNames
- a whitespace separated list of element names, each element
is a URI in curly braces (optional) and a local name. An example of such a parameter is:
"{http://company.com}price {myURI2}book chapter"
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |