|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xml.serializer.SerializerBase
org.apache.xml.serializer.ToStream
org.apache.xml.serializer.ToTextStream
Field Summary |
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler |
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS |
Fields inherited from interface org.apache.xml.serializer.SerializerConstants |
BEGCDATA, CDATA_CONTINUE, CDATA_DELIMITER_CLOSE, CDATA_DELIMITER_OPEN, CNTCDATA, DEFAULT_SAX_SERIALIZER, EMPTYSTRING, ENDCDATA, ENTITY_AMP, ENTITY_CRLF, ENTITY_GT, ENTITY_LT, ENTITY_QUOT, XML_PREFIX, XMLNS_PREFIX, XMLNS_URI |
Constructor Summary | |
ToTextStream()
Default constructor. |
Method Summary | |
void |
addAttribute(String name,
String value)
From XSLTC |
void |
addAttribute(String uri,
String localName,
String rawName,
String type,
String value)
Adds the given attribute to the set of collected attributes , but only if there is a currently open element. |
void |
addUniqueAttribute(String qName,
String value,
int flags)
Add a unique attribute |
void |
cdata(char[] ch,
int start,
int length)
Receive notification of cdata. |
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data. |
void |
characters(String characters)
From XSLTC |
void |
charactersRaw(char[] ch,
int start,
int length)
If available, when the disable-output-escaping attribute is used, output raw text without escaping. |
void |
comment(char[] ch,
int start,
int length)
Report an XML comment anywhere in the document. |
void |
comment(String data)
Called when a Comment is to be constructed. |
void |
endCDATA()
Report the end of a CDATA section. |
void |
endDocument()
Receive notification of the end of a document. |
void |
endElement(String elemName)
Receive notification of the end of an element. |
void |
endElement(String namespaceURI,
String localName,
String name)
Receive notification of the end of an element. |
void |
entityReference(String name)
Receive notivication of a entityReference. |
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. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content. |
void |
namespaceAfterStartElement(String prefix,
String uri)
This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement(). |
void |
processingInstruction(String target,
String data)
Receive notification of a processing instruction. |
void |
startElement(String elementNamespaceURI,
String elementLocalName,
String elementName)
From XSLTC |
void |
startElement(String namespaceURI,
String localName,
String name,
Attributes atts)
Receive notification of the beginning of an element. |
void |
startPrefixMapping(String prefix,
String uri)
Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. |
boolean |
startPrefixMapping(String prefix,
String uri,
boolean shouldFlush)
Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. |
Methods inherited from class org.apache.xml.serializer.ToStream |
addAttributeAlways, attributeDecl, elementDecl, endDTD, endNonEscaping, endPrefixMapping, externalEntityDecl, getIndentAmount, getOutputFormat, getOutputStream, getWriter, internalEntityDecl, processAttributes, reset, serialize, setCdataSectionElements, setContentHandler, setEscaping, setIndentAmount, setLineSepUse, setOutputFormat, setOutputStream, setTransformer, setWriter, skippedEntity, startCDATA, startDTD, startElement, startEntity, startNonEscaping, writeAttrString |
Methods inherited from class org.apache.xml.serializer.SerializerBase |
addAttributes, asContentHandler, asDOMSerializer, characters, close, endEntity, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getPrefix, getStandalone, getTransformer, getVersion, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setEncoding, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setSourceLocator, setStandalone, setVersion, startDocument, warning |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ToTextStream()
Method Detail |
public void endDocument() throws SAXException
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
SAXException
- Any SAX exception, possibly
wrapping another exception.
SAXException
ContentHandler.startDocument()
public void startElement(String namespaceURI, String localName, String name, Attributes atts) throws SAXException
The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.
If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.
startElement
in interface ContentHandler
startElement
in class ToStream
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 qualified name (with prefix), or the
empty string if qualified names are not available.atts
- The attributes attached to the element, if any.
SAXException
- Any SAX exception, possibly
wrapping another exception.
SAXException
endElement(java.lang.String, java.lang.String, java.lang.String)
,
AttributeList
public void endElement(String namespaceURI, String localName, String name) throws SAXException
The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).
If the element name has a namespace prefix, the prefix will still be attached to the name.
endElement
in interface ContentHandler
endElement
in class ToStream
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 qualified name (with prefix), or the
empty string if qualified names are not available.
SAXException
- Any SAX exception, possibly
wrapping another exception.
SAXException
public void characters(char[] ch, 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).
characters
in interface ContentHandler
characters
in class ToStream
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ignorableWhitespace(char[], int, int)
,
Locator
public void charactersRaw(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.
SAXException
- Any SAX exception, possibly
wrapping another exception.public void cdata(char[] ch, 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).
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.ignorableWhitespace(char[], int, int)
,
Locator
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Validating Parsers must use this method to report each chunk of ignorable whitespace (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 class ToStream
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.
SAXException
- Any SAX exception, possibly
wrapping another exception.
SAXException
characters(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
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 should 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.
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied.
SAXException
- Any SAX exception, possibly
wrapping another exception.
SAXException
public void comment(String data) throws SAXException
comment
in interface ExtendedLexicalHandler
comment
in class SerializerBase
data
- The comment data.
SAXException
- Any SAX exception, possibly
wrapping another exception.ExtendedLexicalHandler.comment(String)
public void comment(char[] ch, int start, int length) throws SAXException
comment
in interface LexicalHandler
comment
in class ToStream
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.
SAXException
- The application may raise an exception.public void entityReference(String name) throws SAXException
entityReference
in interface ExtendedContentHandler
entityReference
in class SerializerBase
name
- non-null reference to the name of the entity.
SAXException
public void addAttribute(String uri, String localName, String rawName, String type, String value)
SerializerBase
addAttribute
in interface ExtendedContentHandler
addAttribute
in class SerializerBase
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 attributeExtendedContentHandler.addAttribute(String, String, String, String, String)
public void endCDATA() throws SAXException
ToStream
endCDATA
in interface LexicalHandler
endCDATA
in class ToStream
SAXException
- The application may raise an exception.LexicalHandler.endCDATA()
public void endElement(String elemName) throws SAXException
ToStream
endElement
in interface ExtendedContentHandler
endElement
in class ToStream
elemName
- The element type name
SAXException
- Any SAX exception, possibly
wrapping another exception.ExtendedContentHandler.endElement(String)
public void startElement(String elementNamespaceURI, String elementLocalName, String elementName) throws SAXException
startElement
in interface ExtendedContentHandler
startElement
in class ToStream
SAXException
- Any SAX exception, possibly
wrapping another exception.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 characters(String characters) throws SAXException
characters
in interface ExtendedContentHandler
characters
in class ToStream
characters
- The string of characters to process.
SAXException
public void addAttribute(String name, String value)
addAttribute
in interface ExtendedContentHandler
addAttribute
in class SerializerBase
name
- the attribute's qualified namevalue
- the value of the attributepublic void addUniqueAttribute(String qName, String value, int flags) throws SAXException
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flag
SAXException
public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush) throws SAXException
ToStream
startPrefixMapping
in interface ExtendedContentHandler
startPrefixMapping
in class ToStream
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)
SAXException
- The client may throw
an exception during processing.ExtendedContentHandler.startPrefixMapping(java.lang.String, java.lang.String, boolean)
public void startPrefixMapping(String prefix, String uri) throws SAXException
ToStream
startPrefixMapping
in interface ContentHandler
startPrefixMapping
in class ToStream
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.
SAXException
- The client may throw
an exception during processing.ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
public void namespaceAfterStartElement(String prefix, String uri) throws SAXException
SerializerBase
namespaceAfterStartElement
in interface ExtendedContentHandler
namespaceAfterStartElement
in class SerializerBase
prefix
- the URI of the namespaceuri
- the prefix associated with the given URI.
SAXException
ExtendedContentHandler.namespaceAfterStartElement(String, String)
public void flushPending() throws SAXException
ToStream
flushPending
in interface SerializationHandler
flushPending
in class ToStream
SAXException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |