org.xmlBlaster.util
Class SaxHandlerBase

java.lang.Object
  org.xmlBlaster.util.SaxHandlerBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AttributeSaxFactory, ConfigurationParser, MsgKeySaxFactory, NodeParser, PluginConfigSaxFactory, PluginHolderSaxFactory, QueryKeySaxFactory, RunLevelActionSaxFactory, SecurityQos, SecurityQos, SecurityQos, SecurityQos, XmlParserBase, XmlQoSBase, XmlScriptInterpreter

public class SaxHandlerBase
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

Default xmlBlaster handling of Sax2 callbacks and errors.

You may use this as a base class for your SAX2 handling.

Field Summary

protected java.lang.StringBuffer	character
protected Global	glob
protected org.xml.sax.Locator	locator
private static java.util.logging.Logger	log
private java.lang.String	ME
private boolean	useLexicalHandler
protected java.lang.String	xmlLiteral The original XML string in ASCII representation, for example: <qos></qos>"
protected java.lang.String	xmlSource The xml file read for logging only

Constructor Summary

SaxHandlerBase()
Constructs an new object.

SaxHandlerBase(Global glob)

Method Summary

void	characters(char[] ch, int start, int length) Characters.
void	comment(char[] ch, int start, int length) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endDocument() End document.
void	endDTD() Report the end of DTD declarations.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endEntity(java.lang.String name) Report the end of an entity.
void	endPrefixMapping(java.lang.String prefix)
void	error(org.xml.sax.SAXParseException ex) Error.
void	fatalError(org.xml.sax.SAXParseException ex) Fatal error.
private java.lang.String	getLocationString(org.xml.sax.SAXParseException ex) Returns a string of the location.
boolean	getUseLexicalHandler()
void	ignorableWhitespace(char[] ch, int start, int length) Ignorable whitespace.
protected void	init(org.xml.sax.InputSource inputSource)
protected void	init(java.lang.String xmlLiteral)
protected void	init(java.lang.String xmlSource, org.xml.sax.InputSource inputSource)
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
private void	parse(org.xml.sax.InputSource xmlData) Does the actual parsing
private void	parse(java.lang.String xmlData)
void	processingInstruction(java.lang.String target, java.lang.String data) Processing instruction.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	setUseLexicalHandler(boolean useLexicalHandler) activates/deactivates the lexical handler.
void	skippedEntity(java.lang.String name)
void	startCDATA() Report the start of a CDATA section.
void	startDocument() Start document.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Report the start of DTD declarations, if any.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Receive notification of the beginning of an element.
void	startEntity(java.lang.String name) Report the beginning of some internal and external XML entities.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
java.lang.String	toString()
java.lang.String	toXml()
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
void	warning(org.xml.sax.SAXParseException ex) Warning.

Methods inherited from class java.lang.Object

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

Field Detail

ME

private java.lang.String ME

glob

protected final Global glob

log

private static java.util.logging.Logger log

locator

protected org.xml.sax.Locator locator

character

protected java.lang.StringBuffer character

xmlSource

protected java.lang.String xmlSource

The xml file read for logging only

xmlLiteral

protected java.lang.String xmlLiteral

The original XML string in ASCII representation, for example: <qos></qos>"

useLexicalHandler

private boolean useLexicalHandler

Constructor Detail

SaxHandlerBase

public SaxHandlerBase()

Constructs an new object. You need to call the init() method to parse the XML string.

SaxHandlerBase

public SaxHandlerBase(Global glob)

Method Detail

init

protected void init(org.xml.sax.InputSource inputSource)
             throws XmlBlasterException

Throws:

XmlBlasterException

init

protected void init(java.lang.String xmlSource,
                    org.xml.sax.InputSource inputSource)
             throws XmlBlasterException

Throws:

XmlBlasterException

init

protected void init(java.lang.String xmlLiteral)
             throws XmlBlasterException

Throws:

XmlBlasterException

setUseLexicalHandler

public void setUseLexicalHandler(boolean useLexicalHandler)

activates/deactivates the lexical handler. This can be used to get also the CDATA events

getUseLexicalHandler

public boolean getUseLexicalHandler()

parse

private void parse(java.lang.String xmlData)
            throws XmlBlasterException

Throws:

XmlBlasterException

parse

private void parse(org.xml.sax.InputSource xmlData)
            throws XmlBlasterException

Does the actual parsing

Parameters:

xmlData - Quality of service in XML notation

Throws:

XmlBlasterException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

returns the literal xml string

toXml

public java.lang.String toXml()

Returns:

returns the literal xml string

characters

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

Characters. The text between two tags, in the following example 'Hello': Hello

Specified by:

characters in interface org.xml.sax.ContentHandler

endDocument

public void endDocument()

End document.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

endElement

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

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

ignorableWhitespace

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

Ignorable whitespace.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)

Processing instruction.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String name)

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

startDocument

public void startDocument()

Start document.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

startElement

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

Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

Example:

With a namespace: <database:adapter xmlns:database='http://www.xmlBlaster.org/jdbc'/>

uri=http://www.xmlBlaster.org/jdbc localName=adapter name=database:adapter

Without a namespace: <adapter/>

uri= localName=adapter name=adapter

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

warning

public void warning(org.xml.sax.SAXParseException ex)

Warning.

Specified by:

warning in interface org.xml.sax.ErrorHandler

error

public void error(org.xml.sax.SAXParseException ex)

Error.

Specified by:

error in interface org.xml.sax.ErrorHandler

fatalError

public void fatalError(org.xml.sax.SAXParseException ex)
                throws org.xml.sax.SAXException

Fatal error.

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)

getLocationString

private java.lang.String getLocationString(org.xml.sax.SAXParseException ex)

Returns a string of the location.

comment

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

Report an XML comment anywhere in the document. (interface LexicalHandler)

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

endCDATA

public void endCDATA()

Report the end of a CDATA section. (interface LexicalHandler)

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

endDTD

public void endDTD()

Report the end of DTD declarations. (interface LexicalHandler)

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

endEntity

public void endEntity(java.lang.String name)

Report the end of an entity. (interface LexicalHandler)

Specified by:

endEntity in interface org.xml.sax.ext.LexicalHandler

startCDATA

public void startCDATA()

Report the start of a CDATA section. (interface LexicalHandler)

Specified by:

startCDATA in interface org.xml.sax.ext.LexicalHandler

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)

Report the start of DTD declarations, if any. (interface LexicalHandler)

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

startEntity

public void startEntity(java.lang.String name)

Report the beginning of some internal and external XML entities. (interface LexicalHandler)

Specified by:

startEntity in interface org.xml.sax.ext.LexicalHandler