org.opencms.util

类 CmsXmlSaxWriter

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.opencms.util.CmsXmlSaxWriter

所有已实现的接口:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

public class CmsXmlSaxWriter
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.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.

从以下版本开始:

6.0.0

构造器概要

构造器

构造器和说明
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(java.lang.String encoding) Creates a SAX event handler that generates XML / HTML Strings from the events caught using a new StringWriter and the given encoding.
CmsXmlSaxWriter(java.io.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(java.io.Writer writer, java.lang.String encoding) A SAX event handler that generates XML / HTML Strings from the events caught and writes them to the given Writer.

方法概要

方法

限定符和类型	方法和说明
void	characters(char[] buf, int offset, int len)
void	comment(char[] ch, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qualifiedName)
void	endEntity(java.lang.String name)
java.lang.String	getEncoding() Returns the encoding this XML Sax writer was initialized with.
java.io.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(java.lang.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(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qualifiedName, org.xml.sax.Attributes attributes)
void	startEntity(java.lang.String name)

从类继承的方法 org.xml.sax.helpers.DefaultHandler

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

从类继承的方法 java.lang.Object

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

构造器详细资料

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(java.lang.String encoding)

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

参数:

encoding - the encoding for the XML file

CmsXmlSaxWriter

public CmsXmlSaxWriter(java.io.Writer writer)

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

参数:

writer - the Writer to write to output to

CmsXmlSaxWriter

public CmsXmlSaxWriter(java.io.Writer writer,
               java.lang.String encoding)

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

参数:

writer - the Writer to write to output to

encoding - the encoding for the XML file

方法详细资料

characters

public void characters(char[] buf,
              int offset,
              int len)
                throws org.xml.sax.SAXException

指定者:

characters 在接口中 org.xml.sax.ContentHandler

覆盖:

characters 在类中 org.xml.sax.helpers.DefaultHandler

抛出:

org.xml.sax.SAXException

另请参阅:

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

comment

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

指定者:

comment 在接口中 org.xml.sax.ext.LexicalHandler

另请参阅:

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

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException

指定者:

endCDATA 在接口中 org.xml.sax.ext.LexicalHandler

抛出:

org.xml.sax.SAXException

另请参阅:

LexicalHandler.endCDATA()

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

指定者:

endDocument 在接口中 org.xml.sax.ContentHandler

覆盖:

endDocument 在类中 org.xml.sax.helpers.DefaultHandler

抛出:

org.xml.sax.SAXException

另请参阅:

ContentHandler.endDocument()

endDTD

public void endDTD()

指定者:

endDTD 在接口中 org.xml.sax.ext.LexicalHandler

另请参阅:

LexicalHandler.endDTD()

endElement

public void endElement(java.lang.String namespaceURI,
              java.lang.String localName,
              java.lang.String qualifiedName)
                throws org.xml.sax.SAXException

指定者:

endElement 在接口中 org.xml.sax.ContentHandler

覆盖:

endElement 在类中 org.xml.sax.helpers.DefaultHandler

抛出:

org.xml.sax.SAXException

另请参阅:

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

endEntity

public void endEntity(java.lang.String name)

指定者:

endEntity 在接口中 org.xml.sax.ext.LexicalHandler

另请参阅:

LexicalHandler.endEntity(java.lang.String)

getEncoding

public java.lang.String getEncoding()

Returns the encoding this XML Sax writer was initialized with.

返回:

the encoding this XML Sax writer was initialized with

getWriter

public java.io.Writer getWriter()

Returns the Writer where the XML is written to.

返回:

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).

返回:

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).

返回:

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

setEncoding

public void setEncoding(java.lang.String value)

Sets the encoding to use for the generated output.

参数:

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).

参数:

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).

参数:

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

startCDATA

public void startCDATA()

指定者:

startCDATA 在接口中 org.xml.sax.ext.LexicalHandler

另请参阅:

LexicalHandler.startCDATA()

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

指定者:

startDocument 在接口中 org.xml.sax.ContentHandler

覆盖:

startDocument 在类中 org.xml.sax.helpers.DefaultHandler

抛出:

org.xml.sax.SAXException

另请参阅:

ContentHandler.startDocument()

startDTD

public void startDTD(java.lang.String name,
            java.lang.String publicId,
            java.lang.String systemId)
              throws org.xml.sax.SAXException

指定者:

startDTD 在接口中 org.xml.sax.ext.LexicalHandler

抛出:

org.xml.sax.SAXException

另请参阅:

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

startElement

public void startElement(java.lang.String namespaceURI,
                java.lang.String localName,
                java.lang.String qualifiedName,
                org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

指定者:

startElement 在接口中 org.xml.sax.ContentHandler

覆盖:

startElement 在类中 org.xml.sax.helpers.DefaultHandler

抛出:

org.xml.sax.SAXException

另请参阅:

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

startEntity

public void startEntity(java.lang.String name)

指定者:

startEntity 在接口中 org.xml.sax.ext.LexicalHandler

另请参阅:

LexicalHandler.startEntity(java.lang.String)