org.compass.core.util.config
Class SAXConfigurationHandler

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by org.compass.core.util.config.SAXConfigurationHandler
All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler
Direct Known Subclasses:
NamespacedSAXConfigurationHandler

public class SAXConfigurationHandler
extends DefaultHandler
implements ErrorHandler

A SAXConfigurationHandler helps build Configurations out of sax events.


Constructor Summary
SAXConfigurationHandler()
           
 
Method Summary
 void characters(char[] ch, int start, int end)
          Handling hook for character data.
 void clear()
          Clears all data from this configuration handler.
protected  XmlConfigurationHelper createConfiguration(String localName, String location)
          Create a new DefaultConfiguration with the specified local name and location.
 void endElement(String namespaceURI, String localName, String rawName)
          Handling hook for finishing parsing of an element.
 void error(SAXParseException exception)
          This just throws an exception on a parse error.
 void fatalError(SAXParseException exception)
          This just throws an exception on a parse error.
 ConfigurationHelper getConfiguration()
          Get the configuration object that was built.
protected  String getLocationString()
          Returns a string showing the current system ID, line number and column number.
 void setDocumentLocator(Locator locator)
          Set the document Locator to use.
 void startElement(String namespaceURI, String localName, String rawName, Attributes attributes)
          Handling hook for starting parsing of an element.
 void warning(SAXParseException exception)
          This just throws an exception on a parse error.
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAXConfigurationHandler

public SAXConfigurationHandler()
Method Detail

getConfiguration

public ConfigurationHelper getConfiguration()
Get the configuration object that was built.


clear

public void clear()
Clears all data from this configuration handler.


setDocumentLocator

public void setDocumentLocator(Locator locator)
Set the document Locator to use.

Specified by:
setDocumentLocator in interface ContentHandler
Overrides:
setDocumentLocator in class DefaultHandler

characters

public void characters(char[] ch,
                       int start,
                       int end)
                throws SAXException
Handling hook for character data.

Specified by:
characters in interface ContentHandler
Overrides:
characters in class DefaultHandler
Throws:
SAXException

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String rawName)
                throws SAXException
Handling hook for finishing parsing of an element.

Specified by:
endElement in interface ContentHandler
Overrides:
endElement in class DefaultHandler
Throws:
SAXException

createConfiguration

protected XmlConfigurationHelper createConfiguration(String localName,
                                                     String location)
Create a new DefaultConfiguration with the specified local name and location.


startElement

public void startElement(String namespaceURI,
                         String localName,
                         String rawName,
                         Attributes attributes)
                  throws SAXException
Handling hook for starting parsing of an element.

Specified by:
startElement in interface ContentHandler
Overrides:
startElement in class DefaultHandler
Throws:
SAXException

error

public void error(SAXParseException exception)
           throws SAXException
This just throws an exception on a parse error.

Specified by:
error in interface ErrorHandler
Overrides:
error in class DefaultHandler
Throws:
SAXException

warning

public void warning(SAXParseException exception)
             throws SAXException
This just throws an exception on a parse error.

Specified by:
warning in interface ErrorHandler
Overrides:
warning in class DefaultHandler
Throws:
SAXException

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException
This just throws an exception on a parse error.

Specified by:
fatalError in interface ErrorHandler
Overrides:
fatalError in class DefaultHandler
Throws:
SAXException

getLocationString

protected String getLocationString()
Returns a string showing the current system ID, line number and column number.



Copyright (c) 2004-2008 The Compass Project.