org.docx4j.org.apache.xml.serializer

Class ToXMLSAXHandler

java.lang.Object

org.docx4j.org.apache.xml.serializer.SerializerBase

org.docx4j.org.apache.xml.serializer.ToSAXHandler

org.docx4j.org.apache.xml.serializer.ToXMLSAXHandler

All Implemented Interfaces:

org.apache.xml.serializer.DOMSerializer, org.apache.xml.serializer.ExtendedContentHandler, org.apache.xml.serializer.ExtendedLexicalHandler, org.apache.xml.serializer.SerializationHandler, org.apache.xml.serializer.Serializer, ContentHandler, DTDHandler, ErrorHandler, DeclHandler, LexicalHandler

public final class ToXMLSAXHandler
extends ToSAXHandler

This class receives notification of SAX-like events, and with gathered information over these calls it will invoke the equivalent SAX methods on a handler, the ultimate xsl:output method is known to be "xml". This class is not a public API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_CONTINUE To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
static String	CDATA_DELIMITER_CLOSE The constant "]]>"
static String	CDATA_DELIMITER_OPEN
static String	DEFAULT_SAX_SERIALIZER
static String	EMPTYSTRING
static String	ENTITY_AMP
static String	ENTITY_CRLF
static String	ENTITY_GT
static String	ENTITY_LT
static String	ENTITY_QUOT
protected static org.slf4j.Logger	log
protected boolean	m_escapeSetting Keeps track of whether output escaping is currently enabled
static String	XML_PREFIX
static String	XMLNS_PREFIX
static String	XMLNS_URI
static String	XMLVERSION10
static String	XMLVERSION11 Define the XML version.

Fields inherited from class org.docx4j.org.apache.xml.serializer.ToSAXHandler

m_lexHandler, m_saxHandler, m_state

Fields inherited from class org.docx4j.org.apache.xml.serializer.SerializerBase

m_attrBuff, m_attributes, m_CdataElems, m_cdataTagOpen, m_charsBuff, m_doctypePublic, m_doctypeSystem, m_doIndent, m_elemContext, m_indentAmount, m_inEntityRef, m_inExternalDTD, m_mediatype, m_needToCallStartDocument, m_prefixMap, m_shouldNotWriteXMLHeader, m_sourceLocator, m_standaloneWasSpecified, m_StringOfCDATASections, m_tracer, m_version, m_writer, PKG_NAME, PKG_PATH

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS

Constructor Summary

Constructors

Constructor and Description
ToXMLSAXHandler()
ToXMLSAXHandler(ContentHandler handler, LexicalHandler lex, String encoding)
ToXMLSAXHandler(ContentHandler handler, String encoding)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) Adds the given attribute to the set of attributes, and also makes sure that the needed prefix/uri mapping is declared, but only if there is a currently open element.
void	attributeDecl(String arg0, String arg1, String arg2, String arg3, String arg4)
void	characters(char[] ch, int off, int len)
void	characters(String chars) Receive notification of character data.
void	closeCDATA() Closes ane open cdata tag, and unlike the this.endCDATA() method (from the LexicalHandler) interface, this "internal" method will send the endCDATA() call to the wrapped handler.
protected void	closeStartTag() This method is called when all the data needed for a call to the SAX handler's startElement() method has been gathered.
void	comment(char[] arg0, int arg1, int arg2)
void	elementDecl(String arg0, String arg1)
void	endCDATA()
void	endDocument() Receives notification of the end of the document.
void	endDTD()
void	endElement(String elemName)
void	endElement(String namespaceURI, String localName, String qName)
void	endPrefixMapping(String prefix)
void	externalEntityDecl(String arg0, String arg1, String arg2)
Properties	getOutputFormat()
OutputStream	getOutputStream()
Writer	getWriter()
void	ignorableWhitespace(char[] arg0, int arg1, int arg2)
void	indent(int n) Do nothing for SAX.
void	internalEntityDecl(String arg0, String arg1)
void	namespaceAfterStartElement(String prefix, String uri) Send a namespace declaration in the output document.
protected boolean	popNamespace(String prefix) Undeclare the namespace that is currently pointed to by a given prefix.
void	processingInstruction(String target, String data) Do nothing as this is an abstract class.
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)
void	setDocumentLocator(Locator arg0) Receive an object for locating the origin of SAX document events.
boolean	setEscaping(boolean escape)
void	setOutputFormat(Properties format)
void	setOutputStream(OutputStream output)
void	setWriter(Writer writer)
void	skippedEntity(String arg0)
void	startCDATA()
void	startElement(String elementName) An element starts, but attributes are not fully known yet.
void	startElement(String elementNamespaceURI, String elementLocalName, String elementName) Start an element in the output document.
void	startElement(String namespaceURI, String localName, 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(String arg0)
void	startPrefixMapping(String prefix, String uri)
boolean	startPrefixMapping(String prefix, String uri, boolean shouldFlush) Remember the prefix/uri mapping at the current nested element depth.

Methods inherited from class org.docx4j.org.apache.xml.serializer.ToSAXHandler

addUniqueAttribute, characters, comment, error, fatalError, flushPending, setCdataSectionElements, setContentHandler, setLexHandler, setShouldOutputNSAttr, setTransformState, startDocumentInternal, startDTD, warning

Methods inherited from class org.docx4j.org.apache.xml.serializer.SerializerBase

addAttribute, addAttribute, addAttributeAlways, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, close, documentIsEmpty, endEntity, entityReference, fireCDATAEvent, fireCharEvent, fireCommentEvent, fireEndDoc, fireEndElem, fireEndEntity, fireEntityReference, fireEscapingEvent, fireStartDoc, fireStartElem, fireStartEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getLocalName, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getPrefixPart, getStandalone, getTransformer, getVersion, initCDATA, isCdataSection, notationDecl, patchName, setDoctype, setDoctypePublic, setDoctypeSystem, setDTDEntityExpansion, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setStandaloneInternal, setTransformer, setVersion, startDocument, unparsedEntityDecl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.slf4j.Logger log

m_escapeSetting

protected boolean m_escapeSetting

Keeps track of whether output escaping is currently enabled

CDATA_CONTINUE

public static final String CDATA_CONTINUE

To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >

See Also:

Constant Field Values

CDATA_DELIMITER_CLOSE

public static final String CDATA_DELIMITER_CLOSE

The constant "]]>"

See Also:

Constant Field Values

CDATA_DELIMITER_OPEN

public static final String CDATA_DELIMITER_OPEN

See Also:

Constant Field Values

EMPTYSTRING

public static final String EMPTYSTRING

See Also:

Constant Field Values

ENTITY_AMP

public static final String ENTITY_AMP

See Also:

Constant Field Values

ENTITY_CRLF

public static final String ENTITY_CRLF

See Also:

Constant Field Values

ENTITY_GT

public static final String ENTITY_GT

See Also:

Constant Field Values

ENTITY_LT

public static final String ENTITY_LT

See Also:

Constant Field Values

ENTITY_QUOT

public static final String ENTITY_QUOT

See Also:

Constant Field Values

XML_PREFIX

public static final String XML_PREFIX

See Also:

Constant Field Values

XMLNS_PREFIX

public static final String XMLNS_PREFIX

See Also:

Constant Field Values

XMLNS_URI

public static final String XMLNS_URI

See Also:

Constant Field Values

DEFAULT_SAX_SERIALIZER

public static final String DEFAULT_SAX_SERIALIZER

XMLVERSION11

public static final String XMLVERSION11

Define the XML version.

See Also:

Constant Field Values

XMLVERSION10

public static final String XMLVERSION10

See Also:

Constant Field Values

Constructor Detail

ToXMLSAXHandler

public ToXMLSAXHandler()

ToXMLSAXHandler

public ToXMLSAXHandler(ContentHandler handler,
                       String encoding)

ToXMLSAXHandler

public ToXMLSAXHandler(ContentHandler handler,
                       LexicalHandler lex,
                       String encoding)

Method Detail

getOutputFormat

public Properties getOutputFormat()

See Also:

Serializer#getOutputFormat()

getOutputStream

public OutputStream getOutputStream()

See Also:

Serializer#getOutputStream()

getWriter

public Writer getWriter()

See Also:

Serializer#getWriter()

indent

public void indent(int n)
            throws SAXException

Do nothing for SAX.

Throws:

SAXException

serialize

public void serialize(Node node)
               throws IOException

Throws:

IOException

See Also:

DOMSerializer#serialize(Node)

setEscaping

public boolean setEscaping(boolean escape)
                    throws SAXException

Throws:

SAXException

See Also:

SerializationHandler#setEscaping(boolean)

setOutputFormat

public void setOutputFormat(Properties format)

See Also:

Serializer#setOutputFormat(Properties)

setOutputStream

public void setOutputStream(OutputStream output)

See Also:

Serializer#setOutputStream(OutputStream)

setWriter

public void setWriter(Writer writer)

See Also:

Serializer#setWriter(Writer)

attributeDecl

public void attributeDecl(String arg0,
                          String arg1,
                          String arg2,
                          String arg3,
                          String arg4)
                   throws SAXException

Throws:

SAXException

See Also:

DeclHandler.attributeDecl(String, String, String, String, String)

elementDecl

public void elementDecl(String arg0,
                        String arg1)
                 throws SAXException

Throws:

SAXException

See Also:

DeclHandler.elementDecl(String, String)

externalEntityDecl

public void externalEntityDecl(String arg0,
                               String arg1,
                               String arg2)
                        throws SAXException

Throws:

SAXException

See Also:

DeclHandler.externalEntityDecl(String, String, String)

internalEntityDecl

public void internalEntityDecl(String arg0,
                               String arg1)
                        throws SAXException

Throws:

SAXException

See Also:

DeclHandler.internalEntityDecl(String, String)

endDocument

public void endDocument()
                 throws SAXException

Receives notification of the end of the document.

Throws:

SAXException

See Also:

ContentHandler.endDocument()

closeStartTag

protected void closeStartTag()
                      throws SAXException

This method is called when all the data needed for a call to the SAX handler's startElement() method has been gathered.

Overrides:

closeStartTag in class ToSAXHandler

Throws:

SAXException

closeCDATA

public void closeCDATA()
                throws SAXException

Closes ane open cdata tag, and unlike the this.endCDATA() method (from the LexicalHandler) interface, this "internal" method will send the endCDATA() call to the wrapped handler.

Overrides:

closeCDATA in class ToSAXHandler

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String qName)
                throws SAXException

Throws:

SAXException

See Also:

ContentHandler.endElement(String, String, String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Throws:

SAXException

See Also:

ContentHandler.endPrefixMapping(String)

ignorableWhitespace

public void ignorableWhitespace(char[] arg0,
                                int arg1,
                                int arg2)
                         throws SAXException

Throws:

SAXException

See Also:

ContentHandler.ignorableWhitespace(char[], int, int)

setDocumentLocator

public void setDocumentLocator(Locator arg0)

Description copied from class: SerializerBase

Receive an object for locating the origin of SAX document events.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class SerializerBase

Parameters:

arg0 - An object that can return the location of any SAX document event. Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

See Also:

ContentHandler.setDocumentLocator(Locator)

skippedEntity

public void skippedEntity(String arg0)
                   throws SAXException

Throws:

SAXException

See Also:

ContentHandler.skippedEntity(String)

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Parameters:

prefix - The prefix that maps to the URI

uri - The URI for the namespace

Throws:

SAXException

See Also:

ContentHandler.startPrefixMapping(String, String)

startPrefixMapping

public boolean startPrefixMapping(String prefix,
                                  String uri,
                                  boolean shouldFlush)
                           throws SAXException

Remember the prefix/uri mapping at the current nested element depth.

Parameters:

prefix - The prefix that maps to the URI

uri - The URI for the namespace

shouldFlush - a flag indicating if the mapping applies to the current element or an up coming child (not used).

Throws:

SAXException

See Also:

ContentHandler.startPrefixMapping(String, String)

comment

public void comment(char[] arg0,
                    int arg1,
                    int arg2)
             throws SAXException

Throws:

SAXException

See Also:

LexicalHandler.comment(char[], int, int)

endCDATA

public void endCDATA()
              throws SAXException

Throws:

SAXException

See Also:

LexicalHandler.endCDATA()

endDTD

public void endDTD()
            throws SAXException

Throws:

SAXException

See Also:

LexicalHandler.endDTD()

startEntity

public void startEntity(String arg0)
                 throws SAXException

Throws:

SAXException

See Also:

LexicalHandler.startEntity(String)

characters

public void characters(String chars)
                throws SAXException

Description copied from class: ToSAXHandler

Receive notification of character data.

Specified by:

characters in interface org.apache.xml.serializer.ExtendedContentHandler

Overrides:

characters in class ToSAXHandler

Parameters:

chars - The string of characters to process.

Throws:

SAXException

See Also:

ExtendedContentHandler#characters(String)

startElement

public void startElement(String elementNamespaceURI,
                         String elementLocalName,
                         String elementName)
                  throws SAXException

Start an element in the output document. This might be an XML element (data type) or a CDATA section.

Specified by:

startElement in interface org.apache.xml.serializer.ExtendedContentHandler

Overrides:

startElement in class 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)

Throws:

SAXException

See Also:

ExtendedContentHandler#startElement(String, String, String)

startElement

public void startElement(String elementName)
                  throws SAXException

Description copied from class: ToSAXHandler

An element starts, but attributes are not fully known yet.

Specified by:

startElement in interface org.apache.xml.serializer.ExtendedContentHandler

Overrides:

startElement in class ToSAXHandler

Parameters:

elementName - the element name, with prefix (if any).

Throws:

SAXException

See Also:

ExtendedContentHandler#startElement(String)

characters

public void characters(char[] ch,
                       int off,
                       int len)
                throws SAXException

Throws:

SAXException

endElement

public void endElement(String elemName)
                throws SAXException

Throws:

SAXException

See Also:

ExtendedContentHandler#endElement(String)

namespaceAfterStartElement

public void namespaceAfterStartElement(String prefix,
                                       String uri)
                                throws SAXException

Send a namespace declaration in the output document. The namespace declaration will not be include if the namespace is already in scope with the same prefix.

Specified by:

namespaceAfterStartElement in interface org.apache.xml.serializer.ExtendedContentHandler

Overrides:

namespaceAfterStartElement in class SerializerBase

Parameters:

prefix - the URI of the namespace

uri - the prefix associated with the given URI.

Throws:

SAXException

See Also:

ExtendedContentHandler#namespaceAfterStartElement(String, String)

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Description copied from class: ToSAXHandler

Do nothing as this is an abstract class. All subclasses will need to define their behavior if it is different.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class ToSAXHandler

Throws:

SAXException

See Also:

Send a processing instruction to the output document

popNamespace

protected boolean popNamespace(String prefix)

Undeclare the namespace that is currently pointed to by a given prefix. Inform SAX handler if prefix was previously mapped.

startCDATA

public void startCDATA()
                throws SAXException

Throws:

SAXException

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String name,
                         Attributes atts)
                  throws SAXException

Description copied from class: ToSAXHandler

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 class ToSAXHandler

Throws:

SAXException

See Also:

ContentHandler.startElement(String, String, String, Attributes)

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String rawName,
                         String type,
                         String value,
                         boolean XSLAttribute)
                  throws SAXException

Adds the given attribute to the set of attributes, and also makes sure that the needed prefix/uri mapping is declared, but only if there is a currently open element.

Specified by:

addAttribute in interface org.apache.xml.serializer.ExtendedContentHandler

Overrides:

addAttribute in class SerializerBase

Parameters:

uri - the URI of the attribute

localName - the local name of the attribute

rawName - the qualified name of the attribute

type - the type of the attribute (probably CDATA)

value - the value of the attribute

XSLAttribute - true if this attribute is coming from an xsl:attribute element

Throws:

SAXException

See Also:

ExtendedContentHandler#addAttribute(String, String, String, String, String)

reset

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 org.apache.xml.serializer.Serializer

Overrides:

reset in class ToSAXHandler

Returns:

true if the class was successfuly reset.

See Also:

Serializer#reset()