Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.xerces.parsers
Class BasicParserConfiguration

java.lang.Object
  extended by org.apache.xerces.util.ParserConfigurationSettings
      extended by org.apache.xerces.parsers.BasicParserConfiguration
All Implemented Interfaces:
XMLComponentManager, XMLParserConfiguration
Direct Known Subclasses:
DTDConfiguration, NonValidatingConfiguration, SchemaParsingConfig
public abstract class BasicParserConfiguration
extends ParserConfigurationSettings
implements XMLParserConfiguration

A very basic parser configuration. This configuration class can be used as a base class for custom parser configurations. The basic parser configuration creates the symbol table (if not specified at construction time) and manages all of the recognized features and properties.

The basic parser configuration does not mandate any particular pipeline configuration or the use of specific components except for the symbol table. If even this is too much for a basic parser configuration, the programmer can create a new configuration class that implements the XMLParserConfiguration interface.

Subclasses of the basic parser configuration can add their own recognized features and properties by calling the addRecognizedFeature and addRecognizedProperty methods, respectively.

The basic parser configuration assumes that the configuration will be made up of various parser components that implement the XMLComponent interface. If subclasses of this configuration create their own components for use in the parser configuration, then each component should be added to the list of components by calling the addComponent method. The basic parser configuration will make sure to call the reset method of each registered component before parsing an instance document.

This class recognizes the following features and properties:

Version:
$Id: BasicParserConfiguration.java 447239 2006-09-18 05:08:26Z mrglavas $
Author:
Arnaud Le Hors, IBM, Andy Clark, IBM

Method Summary
 XMLDocumentHandler getDocumentHandler()
          Returns the registered document handler.
 XMLDTDContentModelHandler getDTDContentModelHandler()
          Returns the registered DTD content model handler.
 XMLDTDHandler getDTDHandler()
          Returns the registered DTD handler.
 XMLEntityResolver getEntityResolver()
          Return the current entity resolver.
 XMLErrorHandler getErrorHandler()
          Return the current error handler.
 java.util.Locale getLocale()
          Returns the locale.
abstract  void parse(XMLInputSource inputSource)
          Parse an XML document.
 void setDocumentHandler(XMLDocumentHandler documentHandler)
          Sets the document handler on the last component in the pipeline to receive information about the document.
 void setDTDContentModelHandler(XMLDTDContentModelHandler handler)
          Sets the DTD content model handler.
 void setDTDHandler(XMLDTDHandler dtdHandler)
          Sets the DTD handler.
 void setEntityResolver(XMLEntityResolver resolver)
          Sets the resolver used to resolve external entities.
 void setErrorHandler(XMLErrorHandler errorHandler)
          Allow an application to register an error event handler.
 void setFeature(java.lang.String featureId, boolean state)
          Set the state of a feature.
 void setLocale(java.util.Locale locale)
          Set the locale to use for messages.
 void setProperty(java.lang.String propertyId, java.lang.Object value)
          setProperty
 
Methods inherited from class org.apache.xerces.util.ParserConfigurationSettings
addRecognizedFeatures, addRecognizedProperties, getFeature, getProperty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.xerces.xni.parser.XMLParserConfiguration
addRecognizedFeatures, addRecognizedProperties, getFeature, getProperty
 

Method Detail

parse

public abstract void parse(XMLInputSource inputSource)
                    throws XNIException,
                           java.io.IOException
Parse an XML document.

The parser can use this method to instruct this configuration to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Parsers may not invoke this method while a parse is in progress. Once a parse is complete, the parser may then parse another XML document.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

Specified by:
parse in interface XMLParserConfiguration
Parameters:
inputSource - The input source for the top-level of the XML document.
Throws:
XNIException - Any XNI exception, possibly wrapping another exception.
java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler on the last component in the pipeline to receive information about the document.

Specified by:
setDocumentHandler in interface XMLParserConfiguration
Parameters:
documentHandler - The document handler.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()
Returns the registered document handler.

Specified by:
getDocumentHandler in interface XMLParserConfiguration

setDTDHandler

public void setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.

Specified by:
setDTDHandler in interface XMLParserConfiguration
Parameters:
dtdHandler - The DTD handler.

getDTDHandler

public XMLDTDHandler getDTDHandler()
Returns the registered DTD handler.

Specified by:
getDTDHandler in interface XMLParserConfiguration

setDTDContentModelHandler

public void setDTDContentModelHandler(XMLDTDContentModelHandler handler)
Sets the DTD content model handler.

Specified by:
setDTDContentModelHandler in interface XMLParserConfiguration
Parameters:
handler - The DTD content model handler.

getDTDContentModelHandler

public XMLDTDContentModelHandler getDTDContentModelHandler()
Returns the registered DTD content model handler.

Specified by:
getDTDContentModelHandler in interface XMLParserConfiguration

setEntityResolver

public void setEntityResolver(XMLEntityResolver resolver)
Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.

Specified by:
setEntityResolver in interface XMLParserConfiguration
Parameters:
resolver - The new entity resolver. Passing a null value will uninstall the currently installed resolver.

getEntityResolver

public XMLEntityResolver getEntityResolver()
Return the current entity resolver.

Specified by:
getEntityResolver in interface XMLParserConfiguration
Returns:
The current entity resolver, or null if none has been registered.
See Also:
setEntityResolver(org.apache.xerces.xni.parser.XMLEntityResolver)

setErrorHandler

public void setErrorHandler(XMLErrorHandler errorHandler)
Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Specified by:
setErrorHandler in interface XMLParserConfiguration
Parameters:
errorHandler - The error handler.
Throws:
java.lang.NullPointerException - If the handler argument is null.
See Also:
getErrorHandler()

getErrorHandler

public XMLErrorHandler getErrorHandler()
Return the current error handler.

Specified by:
getErrorHandler in interface XMLParserConfiguration
Returns:
The current error handler, or null if none has been registered.
See Also:
setErrorHandler(org.apache.xerces.xni.parser.XMLErrorHandler)

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)
                throws XMLConfigurationException
Set the state of a feature. Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.

Specified by:
setFeature in interface XMLParserConfiguration
Overrides:
setFeature in class ParserConfigurationSettings
Parameters:
featureId - The unique identifier (URI) of the feature.
state - The requested state of the feature (true or false).
Throws:
XMLConfigurationException - If the requested feature is not known.

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLConfigurationException
setProperty

Specified by:
setProperty in interface XMLParserConfiguration
Overrides:
setProperty in class ParserConfigurationSettings
Parameters:
propertyId -
value -
Throws:
XMLConfigurationException - Thrown if there is a configuration error.

setLocale

public void setLocale(java.util.Locale locale)
               throws XNIException
Set the locale to use for messages.

Specified by:
setLocale in interface XMLParserConfiguration
Parameters:
locale - The locale object to use for localization of messages.
Throws:
XNIException - Thrown if the parser does not support the specified locale.

getLocale

public java.util.Locale getLocale()
Returns the locale.

Specified by:
getLocale in interface XMLParserConfiguration
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD