org.jfree.xml

Class FrontendDefaultHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.jfree.xml.FrontendDefaultHandler

All Implemented Interfaces:

Serializable, Cloneable, Configuration, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

Parser, RootXmlReadHandler

public abstract class FrontendDefaultHandler
extends org.xml.sax.helpers.DefaultHandler
implements Configuration

The frontenddefault handler connects the SAX-backend with the handler implementations. It must be the base class for all parser implementations used by the ParserFrontEnd.

Author:

Thomas Morgner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENTBASE_KEY A key for the content base.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FrontendDefaultHandler() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Returns a clone of this instance.
Iterator	findPropertyKeys(String prefix) Returns all keys with the given prefix.
CommentHandler	getCommentHandler() Returns the comment handler that is used to collect comments.
Enumeration	getConfigProperties() Returns the configuration properties.
String	getConfigProperty(String key) Returns the configuration property with the specified key.
String	getConfigProperty(String key, String defaultValue) Returns the configuration property with the specified key (or the specified default value if there is no such property).
URL	getContentBase() Gets the ContentBase used to resolve relative URLs.
Locator	getLocator() Returns the current locator.
abstract Object	getResult() Returns the parse result.
abstract FrontendDefaultHandler	newInstance() Returns a new instance of the parser.
void	setConfigProperty(String key, String value) Sets a parser configuration value.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.

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

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

CONTENTBASE_KEY

public static final String CONTENTBASE_KEY

A key for the content base.

See Also:

Constant Field Values

Constructor Detail

FrontendDefaultHandler

protected FrontendDefaultHandler()

Default constructor.

Method Detail

getCommentHandler

public CommentHandler getCommentHandler()

Returns the comment handler that is used to collect comments.

Returns:

the comment handler.

setDocumentLocator

public void setDocumentLocator(Locator locator)

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

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.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

Parameters:

locator - the locator.

getLocator

public Locator getLocator()

Returns the current locator.

Returns:

the locator.

getConfigProperty

public String getConfigProperty(String key)

Returns the configuration property with the specified key.

Specified by:

getConfigProperty in interface Configuration

Parameters:

key - the property key.

Returns:

the property value.

getConfigProperty

public String getConfigProperty(String key,
                       String defaultValue)

Returns the configuration property with the specified key (or the specified default value if there is no such property).

If the property is not defined in this configuration, the code will lookup the property in the parent configuration.

Specified by:

getConfigProperty in interface Configuration

Parameters:

key - the property key.

defaultValue - the default value.

Returns:

the property value.

setConfigProperty

public void setConfigProperty(String key,
                     String value)

Sets a parser configuration value.

Parameters:

key - the key.

value - the value.

getConfigProperties

public Enumeration getConfigProperties()

Returns the configuration properties.

Specified by:

getConfigProperties in interface Configuration

Returns:

An enumeration of the configuration properties.

newInstance

public abstract FrontendDefaultHandler newInstance()

Returns a new instance of the parser.

Returns:

a new instance of the parser.

findPropertyKeys

public Iterator findPropertyKeys(String prefix)

Returns all keys with the given prefix.

Specified by:

findPropertyKeys in interface Configuration

Parameters:

prefix - the prefix

Returns:

the iterator containing all keys with that prefix

getResult

public abstract Object getResult()
                          throws SAXException

Returns the parse result. This method is called at the end of the parsing process and expects the generated object.

Returns:

the object.

Throws:

SAXException - if something went wrong.

getContentBase

public URL getContentBase()

Gets the ContentBase used to resolve relative URLs.

Returns:

the current contentbase, or null if no contentBase is set.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this instance.

Specified by:

clone in interface Configuration

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning.