org.zkoss.idom.input

Class SAXHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.zkoss.idom.input.SAXHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler

public class SAXHandler
extends DefaultHandler
implements LexicalHandler, DeclHandler

The SAX Handler. It implements ContentHandler, LexicalHandler and DeclHandler. It is the caller's job to set up this handler properly if required.

This class doesn't depend on SAXBuilder, so it can be used in any other place, e.g., javax.xml.transform.sax.SAXResult.

Author:

tomyeh

See Also:

SAXBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Namespace>	_declNamespaces The namespaces in between startPrefixMapping and endPrefixMapping.
protected Document	_doc The Document being created.
protected IDOMFactory	_factory The iDOM factory.
protected boolean	_inCData Indicator of whether we are in a CDATA.
protected boolean	_inDTD Indicator of whether we are in a DTD.
protected Locator	_loc Locator.
protected Stack<Group>	_stack The Group stack.

Constructor Summary

Constructors

Constructor and Description
SAXHandler() Constructor.
SAXHandler(IDOMFactory factory) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addToCurrentGroup(Item vtx) Adds the item to the current group; also attach the locator.
protected void	attachLocator(Item vtx) Attaches the locator to the item.
void	attributeDecl(String eName, String aName, String type, String valueDefault, String value)
void	characters(char[] ch, int start, int length)
void	comment(char[] ch, int start, int length)
protected InputSource	defaultResolveEntity(String publicId, String systemId) The default entity resolver.
void	elementDecl(String name, String model)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String nsURI, String lname, String tname)
void	endEntity(String name)
void	endPrefixMapping(String prefix)
void	error(SAXParseException ex)
void	externalEntityDecl(String name, String pubId, String sysId)
void	fatalError(SAXParseException ex)
Document	getDocument() Gets the document being created.
EntityResolver	getEntityResolver() Gets the org.xml.sax.EntityResolver.
ErrorHandler	getErrorHandler() Gets the org.xml.sax.ErrorHandler.
IDOMFactory	getIDOMFactory() Gets the iDOM factory.
protected Group	getTopGroup() Returns the top group, or null if not available.
void	ignorableWhitespace(char[] ch, int start, int length)
void	internalEntityDecl(String name, String value)
boolean	isCoalescing() Indicates whether or not the factory is configured to produce parsers which converts CDATA to Text and appends it to the adjacent (if any) Text node.
boolean	isExpandEntityReferences() Tests whether to expand entity reference nodes.
boolean	isIgnoringComments() Indicates whether or not the factory is configured to produce parsers which ignores comments.
boolean	isIgnoringElementContentWhitespace() Tests whether to ignore whitespaces in element content.
void	notationDecl(String name, String publicID, String systemID)
protected void	popGroup() Pops out the current group, and the one under it becomes the new current group.
void	processingInstruction(String target, String data)
protected void	pushGroup(Group group) Adds a new group to the current group as a child, and pushes the new group to be the new current group.
InputSource	resolveEntity(String publicId, String systemId)
void	setCoalescing(boolean coalescing) Specifies that the parser produced by this code will convert CDATA to Text and append it to the adjacent (if any) text.
void	setDocumentLocator(Locator locator)
void	setEntityResolver(EntityResolver er) Specifies the org.xml.sax.EntityResolver to be used to resolve entities present in the XML document to be parsed.
void	setErrorHandler(ErrorHandler eh) Specifies the org.xml.sax.ErrorHandler to be used to report errors present in the XML document to be parsed.
void	setExpandEntityReferences(boolean expand) Sets whether to expand entities during parsing.
void	setIDOMFactory(IDOMFactory factory) Sets the iDOM factory.
void	setIgnoringComments(boolean ignoreComments) Specifies that the parser produced by this code will ignore comments.
void	setIgnoringElementContentWhitespace(boolean ignore) Sets whether the parser should eliminate whitespace in element content.
void	startCDATA()
void	startDocument()
void	startDTD(String name, String pubId, String sysId)
void	startElement(String nsURI, String lname, String tname, Attributes attrs)
void	startEntity(String name)
void	startPrefixMapping(String prefix, String uri)
void	unparsedEntityDecl(String name, String pubId, String sysId, String notationName)
void	warning(SAXParseException ex)

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

skippedEntity

Methods inherited from class java.lang.Object

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

Field Detail

_factory

protected IDOMFactory _factory

The iDOM factory.

_doc

protected Document _doc

The Document being created.

_loc

protected Locator _loc

Locator.

_inDTD

protected boolean _inDTD

Indicator of whether we are in a DTD.

_inCData

protected boolean _inCData

Indicator of whether we are in a CDATA.

_stack

protected Stack<Group> _stack

The Group stack. The top one is the current group being processed.

_declNamespaces

protected List<Namespace> _declNamespaces

The namespaces in between startPrefixMapping and endPrefixMapping.

Constructor Detail

SAXHandler

public SAXHandler(IDOMFactory factory)

Constructor.

Parameters:

factory - the iDOM factory; null for DefaultIDOMFactory.

SAXHandler

public SAXHandler()

Constructor.

Method Detail

isIgnoringElementContentWhitespace

public final boolean isIgnoringElementContentWhitespace()

Tests whether to ignore whitespaces in element content.

setIgnoringElementContentWhitespace

public final void setIgnoringElementContentWhitespace(boolean ignore)

Sets whether the parser should eliminate whitespace in element content. They are known as "ignorable whitespace". Only whitespace which is contained within element content that has an element only content model will be eliminated (see XML Rec 2.10).

For this setting to take effect requires that validation be turned on.

Default: false.

Parameters:

ignore - Whether to ignore whitespaces in element content.

isExpandEntityReferences

public final boolean isExpandEntityReferences()

Tests whether to expand entity reference nodes.

setExpandEntityReferences

public final void setExpandEntityReferences(boolean expand)

Sets whether to expand entities during parsing. A true means to expand entities as normal content. A false means to leave entities unexpanded as EntityReference objects.

Default: true.

Parameters:

expand - whether entity expansion should occur.

isCoalescing

public final boolean isCoalescing()

Indicates whether or not the factory is configured to produce parsers which converts CDATA to Text and appends it to the adjacent (if any) Text node.

Default: false.

Returns:

true if the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node; false otherwise.

setCoalescing

public final void setCoalescing(boolean coalescing)

Specifies that the parser produced by this code will convert CDATA to Text and append it to the adjacent (if any) text.

Default: false.

isIgnoringComments

public final boolean isIgnoringComments()

Indicates whether or not the factory is configured to produce parsers which ignores comments.

Default: false.

Returns:

true if the factory is configured to produce parsers which ignores comments; false otherwise.

setIgnoringComments

public final void setIgnoringComments(boolean ignoreComments)

Specifies that the parser produced by this code will ignore comments.

Default: false.

setErrorHandler

public final void setErrorHandler(ErrorHandler eh)

Specifies the org.xml.sax.ErrorHandler to be used to report errors present in the XML document to be parsed.

Default: null -- to use the default implementation and behavior.

getErrorHandler

public final ErrorHandler getErrorHandler()

Gets the org.xml.sax.ErrorHandler.

Returns:

the error handler; null to use the default implementation

setEntityResolver

public final void setEntityResolver(EntityResolver er)

Specifies the org.xml.sax.EntityResolver to be used to resolve entities present in the XML document to be parsed.

Default: null -- to use the default implementation and behavior.

getEntityResolver

public final EntityResolver getEntityResolver()

Gets the org.xml.sax.EntityResolver.

Returns:

the entity resolver; null to use the default implementation

getDocument

public final Document getDocument()

Gets the document being created. Called to retrieve the iDOM tree after parsed.

getIDOMFactory

public final IDOMFactory getIDOMFactory()

Gets the iDOM factory. Null for DefaultIDOMFactory.THE.

setIDOMFactory

public final void setIDOMFactory(IDOMFactory factory)

Sets the iDOM factory. Null for DefaultIDOMFactory.THE.

attachLocator

protected final void attachLocator(Item vtx)

Attaches the locator to the item.

getTopGroup

protected final Group getTopGroup()

Returns the top group, or null if not available.

addToCurrentGroup

protected final void addToCurrentGroup(Item vtx)

Adds the item to the current group; also attach the locator.

pushGroup

protected final void pushGroup(Group group)

Adds a new group to the current group as a child, and pushes the new group to be the new current group.

popGroup

protected final void popGroup()

Pops out the current group, and the one under it becomes the new current group.

externalEntityDecl

public void externalEntityDecl(String name,
                               String pubId,
                               String sysId)
                        throws SAXException

Specified by:

externalEntityDecl in interface DeclHandler

Throws:

SAXException

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
                        throws SAXException

Specified by:

internalEntityDecl in interface DeclHandler

Throws:

SAXException

attributeDecl

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String valueDefault,
                          String value)
                   throws SAXException

Specified by:

attributeDecl in interface DeclHandler

Throws:

SAXException

elementDecl

public void elementDecl(String name,
                        String model)
                 throws SAXException

Specified by:

elementDecl in interface DeclHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
                     String pubId,
                     String sysId)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

comment

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

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

processingInstruction

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

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

startPrefixMapping

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

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String nsURI,
                         String lname,
                         String tname,
                         Attributes attrs)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String nsURI,
                       String lname,
                       String tname)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

notationDecl

public void notationDecl(String name,
                         String publicID,
                         String systemID)
                  throws SAXException

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class DefaultHandler

Throws:

SAXException

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String pubId,
                               String sysId,
                               String notationName)
                        throws SAXException

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class DefaultHandler

Throws:

SAXException

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Throws:

SAXException

defaultResolveEntity

protected InputSource defaultResolveEntity(String publicId,
                                           String systemId)
                                    throws SAXException

The default entity resolver. It is used if setEntityResolver(org.xml.sax.EntityResolver) is not called. This implementation searches the class path under /metainfo/xml.

For example, http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd is asked. It searches from classpath for /metainfo/xml/java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd and /metainfo/xml/portlet-app_1_0.xsd

Throws:

SAXException

warning

public void warning(SAXParseException ex)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException ex)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException ex)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException