Package org.opencms.util

Class CmsXmlSaxWriter

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.opencms.util.CmsXmlSaxWriter

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler

public class CmsXmlSaxWriter
extends DefaultHandler
implements LexicalHandler

Simple SAX event handler that generates a XML (or HTML) file from the events caught.

This can be used for writing large XML files where keeping a DOM structure in memory might cause out-of-memory issues, like e.g. when writing the OpenCms export files.

It can also be used if a ContentHandler is needed that should generate a XML / HTML file from a series of SAX events.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsXmlSaxWriter()	Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the OpenCms default encoding.
CmsXmlSaxWriter(Writer writer)	Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the given encoding.
CmsXmlSaxWriter(Writer writer, String encoding)	A SAX event handler that generates XML / HTML Strings from the events caught and writes them to the given Writer.
CmsXmlSaxWriter(String encoding)	Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the given encoding.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] buf, int offset, int len)
void	comment(char[] ch, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String namespaceURI, String localName, String qualifiedName)
void	endEntity(String name)
String	getEncoding()	Returns the encoding this XML Sax writer was initialized with.
Writer	getWriter()	Returns the Writer where the XML is written to.
boolean	isEscapeUnknownChars()	Returns true if charactes that are not part of the selected encoding are to be replaced with the HTML { entity representation in the generated output (not in CDATA elements).
boolean	isEscapeXml()	Returns true if XML entities are to be encoded in the generated output (not in CDATA elements).
void	setEncoding(String value)	Sets the encoding to use for the generated output.
void	setEscapeUnknownChars(boolean value)	If set to true, then charactes that are not part of the selected encoding are to be replaced with the XML { entity representation in the generated output (not in CDATA elements).
void	setEscapeXml(boolean value)	If set to true, then XML entities are to be encoded in the generated output (not in CDATA elements).
void	startCDATA()
void	startDocument()
void	startDTD(String name, String publicId, String systemId)
void	startElement(String namespaceURI, String localName, String qualifiedName, Attributes attributes)
void	startEntity(String name)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

CmsXmlSaxWriter

public CmsXmlSaxWriter()

Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the OpenCms default encoding.

CmsXmlSaxWriter

public CmsXmlSaxWriter(String encoding)

Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the given encoding.

Parameters:

encoding - the encoding for the XML file

CmsXmlSaxWriter

public CmsXmlSaxWriter(Writer writer)

Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the given encoding.

Parameters:

writer - the Writer to write to output to

CmsXmlSaxWriter

public CmsXmlSaxWriter(Writer writer,
 String encoding)

A SAX event handler that generates XML / HTML Strings from the events caught and writes them to the given Writer.

Parameters:

writer - the Writer to write to output to

encoding - the encoding for the XML file

Method Details

characters

public void characters(char[] buf,
 int offset,
 int len)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

See Also:

• ContentHandler.characters(char[], int, int)

comment

public void comment(char[] ch,
 int start,
 int length)

Specified by:

comment in interface LexicalHandler

See Also:

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

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

See Also:

• LexicalHandler.endCDATA()

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

See Also:

• ContentHandler.endDocument()

endDTD

public void endDTD()

Specified by:

endDTD in interface LexicalHandler

See Also:

• LexicalHandler.endDTD()

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

See Also:

• ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

endEntity

public void endEntity(String name)

Specified by:

endEntity in interface LexicalHandler

See Also:

• LexicalHandler.endEntity(java.lang.String)

getEncoding

public String getEncoding()

Returns the encoding this XML Sax writer was initialized with.

Returns:

the encoding this XML Sax writer was initialized with

getWriter

public Writer getWriter()

Returns the Writer where the XML is written to.

Returns:

the Writer where the XML is written to

isEscapeUnknownChars

public boolean isEscapeUnknownChars()

Returns true if charactes that are not part of the selected encoding are to be replaced with the HTML { entity representation in the generated output (not in CDATA elements).

Returns:

true if charactes that are not part of the selected encoding are to be replaced with the HTML entity representation

isEscapeXml

public boolean isEscapeXml()

Returns true if XML entities are to be encoded in the generated output (not in CDATA elements).

Returns:

true if XML entities are to be encoded in the generated output (not in CDATA elements)

setEncoding

public void setEncoding(String value)

Sets the encoding to use for the generated output.

Parameters:

value - the encoding to use for the generated output

setEscapeUnknownChars

public void setEscapeUnknownChars(boolean value)

If set to true, then charactes that are not part of the selected encoding are to be replaced with the XML { entity representation in the generated output (not in CDATA elements).

Parameters:

value - indicates to escape unknown characters with XML entities or not

setEscapeXml

public void setEscapeXml(boolean value)

If set to true, then XML entities are to be encoded in the generated output (not in CDATA elements).

Parameters:

value - indicates to to escape characters with XML entities or not

startCDATA

public void startCDATA()

Specified by:

startCDATA in interface LexicalHandler

See Also:

• LexicalHandler.startCDATA()

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

See Also:

• ContentHandler.startDocument()

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

See Also:

• LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)

startElement

public void startElement(String namespaceURI,
 String localName,
 String qualifiedName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

See Also:

• ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

startEntity

public void startEntity(String name)

Specified by:

startEntity in interface LexicalHandler

See Also:

• LexicalHandler.startEntity(java.lang.String)