Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.xml.serializer.SerializerBase
org.apache.xml.serializer.ToSAXHandler
org.apache.xml.serializer.ToHTMLSAXHandler
public class ToHTMLSAXHandler
extends ToSAXHandler
Nested Class 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 , XMLNS_PREFIX , XMLNS_URI , XML_PREFIX |
Constructor Summary | |
| |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Properties |
|
OutputStream |
|
Writer |
|
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
void | |
void |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
Methods inherited from class org.apache.xml.serializer.ToSAXHandler | |
addUniqueAttribute , characters , characters , comment , error , fatalError , flushPending , processingInstruction , reset , setCdataSectionElements , setContentHandler , setLexHandler , setShouldOutputNSAttr , setTransformState , startDTD , startElement , startElement , startElement , warning |
public ToHTMLSAXHandler(ContentHandler handler, String encoding)
A constructor
- Parameters:
handler
- the wrapped SAX content handlerencoding
- the encoding of the output HTML document
public ToHTMLSAXHandler(ContentHandler handler, LexicalHandler lex, String encoding)
A constructor.
- Parameters:
handler
- the wrapped SAX content handlerlex
- the wrapped lexical handlerencoding
- the encoding of the output HTML document
public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException
Does nothing.
- Specified by:
- attributeDecl in interface DeclHandler
- Parameters:
eName
- this parameter is ignoredaName
- this parameter is ignoredtype
- this parameter is ignoredvalueDefault
- this parameter is ignoredvalue
- this parameter is ignored
public void characters(String chars) throws SAXException
Receive notification of character data.
- Specified by:
- characters in interface ExtendedContentHandler
- Overrides:
- characters in interface ToSAXHandler
- Parameters:
chars
- The string of characters to process.
- Throws:
SAXException
-
public void characters(char[] ch, int off, int len) throws SAXException
Receive notification of character data. 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).
- Parameters:
ch
- The characters from the XML document.off
- The start position in the array.len
- The number of characters to read from the array.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
- See Also:
ignorableWhitespace(char[],int,int)
,Locator
,org.xml.sax.ContentHandler.characters(char[], int, int)
public void close()
Do nothing.
- Specified by:
- close in interface SerializationHandler
- Overrides:
- close in interface SerializerBase
- See Also:
SerializationHandler.close()
public void comment(char[] ch, int start, int length) throws SAXException
Receive notification of a comment anywhere in the document. This callback will be used for comments inside or outside the document element.
- Parameters:
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.
- Throws:
SAXException
- The application may raise an exception.
- See Also:
org.xml.sax.ext.LexicalHandler.comment(char[], int, int)
public void elementDecl(String name, String model) throws SAXException
Does nothing.
- Specified by:
- elementDecl in interface DeclHandler
public void endCDATA() throws SAXException
Does nothing.
- Specified by:
- endCDATA in interface LexicalHandler
- See Also:
LexicalHandler.endCDATA()
public void endDTD() throws SAXException
Does nothing.
- Specified by:
- endDTD in interface LexicalHandler
- See Also:
LexicalHandler.endDTD()
public void endDocument() throws SAXException
Receive notification of the end of a document. 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.
- Specified by:
- endDocument in interface ContentHandler
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
public void endElement(String elementName) throws SAXException
Receive notification of the end of an element.
- Specified by:
- endElement in interface ExtendedContentHandler
- Parameters:
elementName
- The element type name
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.
public void endElement(String uri, String localName, String qName) throws SAXException
Receive notification of the end of an element. 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.
- Specified by:
- endElement in interface ContentHandler
- Parameters:
localName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.
public void endPrefixMapping(String prefix) throws SAXException
Does nothing.
- Specified by:
- endPrefixMapping in interface ContentHandler
public void externalEntityDecl(String arg0, String arg1, String arg2) throws SAXException
- Specified by:
- externalEntityDecl in interface DeclHandler
public void flushPending() throws SAXException
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.
- Specified by:
- flushPending in interface SerializationHandler
- Overrides:
- flushPending in interface ToSAXHandler
public Properties getOutputFormat()
Returns null.
- Specified by:
- getOutputFormat in interface Serializer
- Returns:
- null
- See Also:
Serializer.getOutputFormat()
public OutputStream getOutputStream()
Reurns null
- Specified by:
- getOutputStream in interface Serializer
- Returns:
- null
- See Also:
Serializer.getOutputStream()
public Writer getWriter()
Returns null
- Specified by:
- getWriter in interface Serializer
- Returns:
- null
- See Also:
Serializer.getWriter()
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Does nothing.
- See Also:
org.xml.sax.ContentHandler.ignorableWhitespace(char[], int, int)
public void internalEntityDecl(String name, String value) throws SAXException
Does nothing.
- Specified by:
- internalEntityDecl in interface DeclHandler
public void namespaceAfterStartElement(String prefix, String uri) throws SAXException
This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement(). startPrefixMapping(prefix,uri) would be used before the startElement() call.
- Specified by:
- namespaceAfterStartElement in interface ExtendedContentHandler
- Overrides:
- namespaceAfterStartElement in interface SerializerBase
- Parameters:
prefix
- the prefix associated with the given URI.uri
- the URI of the namespace
public void processingInstruction(String arg0, String arg1) throws SAXException
Receive notification of a processing instruction. 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.
- Specified by:
- processingInstruction in interface ContentHandler
- Overrides:
- processingInstruction in interface ToSAXHandler
- Parameters:
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
public 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).
- Specified by:
- reset in interface Serializer
- Overrides:
- reset in interface ToSAXHandler
- Returns:
- true if the class was successfuly reset.
- See Also:
Serializer.reset()
public void serialize(Node node) throws IOException
Does nothing.
- Specified by:
- serialize in interface SerializationHandler
- serialize in interface DOMSerializer
- See Also:
DOMSerializer.serialize(Node)
public void setDocumentLocator(Locator arg0)
Does nothing.
- Specified by:
- setDocumentLocator in interface ContentHandler
- Overrides:
- setDocumentLocator in interface SerializerBase
public boolean setEscaping(boolean escape) throws SAXException
Turns special character escaping on/off.
- Specified by:
- setEscaping in interface SerializationHandler
- Parameters:
public void setIndent(boolean indent)
Does nothing
- Specified by:
- setIndent in interface XSLOutputAttributes
- Overrides:
- setIndent in interface SerializerBase
- Parameters:
indent
- the number of spaces to indent per indentation level (ignored)
- See Also:
org.apache.xml.serializer.SerializationHandler.setIndent(boolean)
public void setOutputFormat(Properties format)
Does nothing.
- Specified by:
- setOutputFormat in interface Serializer
- Parameters:
format
- this parameter is not used
public void setOutputStream(OutputStream output)
Does nothing.
- Specified by:
- setOutputStream in interface Serializer
- Parameters:
output
- this parameter is ignored
public void setWriter(Writer writer)
Does nothing.
- Specified by:
- setWriter in interface Serializer
- Parameters:
writer
- this parameter is ignored.
- See Also:
Serializer.setWriter(Writer)
public void skippedEntity(String arg0) throws SAXException
Does nothing.
- Specified by:
- skippedEntity in interface ContentHandler
- See Also:
ContentHandler.skippedEntity(String)
public void startCDATA() throws SAXException
Does nothing.
- Specified by:
- startCDATA in interface LexicalHandler
- See Also:
LexicalHandler.startCDATA()
public void startElement(String elementName) throws SAXException
An element starts, but attributes are not fully known yet.
- Specified by:
- startElement in interface ExtendedContentHandler
- Overrides:
- startElement in interface ToSAXHandler
- Parameters:
elementName
- the element name, with prefix, if any
public void startElement(String elementNamespaceURI, String elementLocalName, String elementName) throws SAXException
An element starts, but attributes are not fully known yet.
- Specified by:
- startElement in interface ExtendedContentHandler
- Overrides:
- startElement in interface ToSAXHandler
- Parameters:
elementNamespaceURI
- the URI of the namespace of the element (optional)elementLocalName
- the element name, but without prefix (optional)elementName
- the element name, with prefix, if any (required)
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException
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.
- Specified by:
- startElement in interface ContentHandler
- Overrides:
- startElement in interface ToSAXHandler
- Parameters:
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.qName
- The elements name.atts
- The attributes attached to the element, if any.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
public void startEntity(String arg0) throws SAXException
Does nothing.
- Specified by:
- startEntity in interface LexicalHandler
- See Also:
LexicalHandler.startEntity(String)
public void startPrefixMapping(String prefix, String uri) throws SAXException
Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. This call will close any open tags so that the prefix mapping will not apply to the current element, but the up comming child.
- Specified by:
- startPrefixMapping in interface ContentHandler
- Parameters:
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.
- Throws:
SAXException
- The client may throw an exception during processing.
public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush) throws SAXException
Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. Need to close any open start tag to make sure than any name space attributes due to this event are associated wih the up comming element, not the current one.
- Specified by:
- startPrefixMapping in interface ExtendedContentHandler
- Parameters:
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)
- Returns:
- returns true if the call made a change to the current namespace information, false if it did not change anything, e.g. if the prefix/namespace mapping was already in scope from before.
- Throws:
SAXException
- The client may throw an exception during processing.