Top Description Fields Constructors Methods
org.apache.xerces.parsers

public abstract Class BasicParserConfiguration

extends ParserConfigurationSettings
implements XMLParserConfiguration
Class Inheritance
All Implemented Interfaces
org.apache.xerces.xni.parser.XMLParserConfiguration, org.apache.xerces.xni.parser.XMLComponentManager
Known Direct Subclasses
org.apache.xerces.parsers.DTDConfiguration, org.apache.xerces.parsers.NonValidatingConfiguration, org.apache.xerces.impl.xs.opti.SchemaParsingConfig
Imports
java.io.IOException, java.util.ArrayList, .HashMap, .Locale, org.apache.xerces.impl.Constants, org.apache.xerces.util.ParserConfigurationSettings, .SymbolTable, org.apache.xerces.xni.XMLDTDContentModelHandler, .XMLDTDHandler, .XMLDocumentHandler, .XNIException, org.apache.xerces.xni.parser.XMLComponent, .XMLComponentManager, .XMLConfigurationException, .XMLDocumentSource, .XMLEntityResolver, .XMLErrorHandler, .XMLInputSource, .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:

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

Field Summary

Modifier and TypeField and Description
protected static final String
ENTITY_RESOLVER

Property identifier: entity resolver.

protected static final String
ERROR_HANDLER

Property identifier: error handler.

protected static final String
EXTERNAL_GENERAL_ENTITIES

Feature identifier: external general entities.

protected static final String
EXTERNAL_PARAMETER_ENTITIES

Feature identifier: external parameter entities.

protected ArrayList<E>
fComponents

Components.

protected XMLDocumentHandler
fDocumentHandler

The document handler.

protected XMLDTDContentModelHandler
fDTDContentModelHandler

The DTD content model handler.

protected XMLDTDHandler
fDTDHandler

The DTD handler.

protected XMLDocumentSource
fLastComponent

Last component in the document pipeline

protected Locale
fLocale

Locale.

protected SymbolTable
fSymbolTable

Symbol table.

protected static final String
NAMESPACES

Feature identifier: namespaces.

protected static final String
SYMBOL_TABLE

Property identifier: symbol table.

protected static final String
VALIDATION

Feature identifier: validation.

protected static final String
XML_STRING

Property identifier: xml string.

Inherited from org.apache.xerces.util.ParserConfigurationSettings:
fFeaturesfParentSettingsfPropertiesfRecognizedFeaturesfRecognizedPropertiesPARSER_SETTINGS

Constructor Summary

AccessConstructor and Description
protected
BasicParserConfiguration()

Default Constructor.

protected
BasicParserConfiguration(SymbolTable
The symbol table to use.
symbolTable)

Constructs a parser configuration using the specified symbol table.

protected
BasicParserConfiguration(SymbolTable
The symbol table to use.
symbolTable, XMLComponentManager
The parent settings.
parentSettings)

Constructs a parser configuration using the specified symbol table and parent settings.

Method Summary

Modifier and TypeMethod and Description
protected void
addComponent(XMLComponent
The component to add.
component)

Adds a component to the parser configuration.

protected void
checkFeature(String
The unique identifier (URI) of the feature.
featureId)

Overrides org.apache.xerces.util.ParserConfigurationSettings.checkFeature.

Check a feature.
protected void
checkProperty(String
The unique identifier (URI) of the property being set.
propertyId)

Overrides org.apache.xerces.util.ParserConfigurationSettings.checkProperty.

Check a property.
public XMLDocumentHandler
getDocumentHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDocumentHandler.

Returns the registered document handler.
public XMLDTDContentModelHandler
getDTDContentModelHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDTDContentModelHandler.

Returns the registered DTD content model handler.
public XMLDTDHandler
getDTDHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDTDHandler.

Returns the registered DTD handler.
public XMLEntityResolver

Returns:

The current entity resolver, or null if none has been registered.
getEntityResolver()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getEntityResolver.

Return the current entity resolver.
public XMLErrorHandler

Returns:

The current error handler, or null if none has been registered.
getErrorHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getErrorHandler.

Return the current error handler.
public Locale
getLocale()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getLocale.

Returns the locale.
public abstract void
parse(XMLInputSource
The input source for the top-level of the XML document.
inputSource)

Redeclares org.apache.xerces.xni.parser.XMLParserConfiguration.parse.

Parse an XML document.
protected void
reset()

reset all components before parsing and namespace context

public void
setDocumentHandler(XMLDocumentHandler
The document handler.
documentHandler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDocumentHandler.

Sets the document handler on the last component in the pipeline to receive information about the document.
public void
setDTDContentModelHandler(XMLDTDContentModelHandler
The DTD content model handler.
handler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDTDContentModelHandler.

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

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDTDHandler.

Sets the DTD handler.
public void
setEntityResolver(XMLEntityResolver
The new entity resolver. Passing a null value will uninstall the currently installed resolver.
resolver)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setEntityResolver.

Sets the resolver used to resolve external entities.
public void
setErrorHandler(XMLErrorHandler
The error handler.
errorHandler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setErrorHandler.

Allow an application to register an error event handler.
public void
setFeature(String
The unique identifier (URI) of the feature.
featureId, boolean
The requested state of the feature (true or false).
state)

Overrides org.apache.xerces.util.ParserConfigurationSettings.setFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setFeature.

Set the state of a feature.
public void
setLocale(Locale
The locale object to use for localization of messages.
locale)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setLocale.

Set the locale to use for messages.
public void
setProperty(String propertyId, Object value)

Overrides org.apache.xerces.util.ParserConfigurationSettings.setProperty.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setProperty.

setProperty
Inherited from org.apache.xerces.util.ParserConfigurationSettings:
addRecognizedFeaturesaddRecognizedPropertiesgetFeaturegetProperty

Field Detail

ENTITY_RESOLVERback to summary
protected static final String ENTITY_RESOLVER

Property identifier: entity resolver.

ERROR_HANDLERback to summary
protected static final String ERROR_HANDLER

Property identifier: error handler.

EXTERNAL_GENERAL_ENTITIESback to summary
protected static final String EXTERNAL_GENERAL_ENTITIES

Feature identifier: external general entities.

EXTERNAL_PARAMETER_ENTITIESback to summary
protected static final String EXTERNAL_PARAMETER_ENTITIES

Feature identifier: external parameter entities.

fComponentsback to summary
protected ArrayList<E> fComponents

Components.

fDocumentHandlerback to summary
protected XMLDocumentHandler fDocumentHandler

The document handler.

fDTDContentModelHandlerback to summary
protected XMLDTDContentModelHandler fDTDContentModelHandler

The DTD content model handler.

fDTDHandlerback to summary
protected XMLDTDHandler fDTDHandler

The DTD handler.

fLastComponentback to summary
protected XMLDocumentSource fLastComponent

Last component in the document pipeline

fLocaleback to summary
protected Locale fLocale

Locale.

fSymbolTableback to summary
protected SymbolTable fSymbolTable

Symbol table.

NAMESPACESback to summary
protected static final String NAMESPACES

Feature identifier: namespaces.

SYMBOL_TABLEback to summary
protected static final String SYMBOL_TABLE

Property identifier: symbol table.

VALIDATIONback to summary
protected static final String VALIDATION

Feature identifier: validation.

XML_STRINGback to summary
protected static final String XML_STRING

Property identifier: xml string.

Constructor Detail

BasicParserConfigurationback to summary
protected BasicParserConfiguration()

Default Constructor.

BasicParserConfigurationback to summary
protected BasicParserConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters
symbolTable:SymbolTable

The symbol table to use.

BasicParserConfigurationback to summary
protected BasicParserConfiguration(SymbolTable symbolTable, XMLComponentManager parentSettings)

Constructs a parser configuration using the specified symbol table and parent settings.

Parameters
symbolTable:SymbolTable

The symbol table to use.

parentSettings:XMLComponentManager

The parent settings.

Method Detail

addComponentback to summary
protected void addComponent(XMLComponent component)

Adds a component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.

Parameters
component:XMLComponent

The component to add.

checkFeatureback to summary
protected void checkFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.checkFeature.

Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters
featureId:String

The unique identifier (URI) of the feature.

Exceptions
XMLConfigurationException:
Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
checkPropertyback to summary
protected void checkProperty(String propertyId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.checkProperty.

Check a property. If the property is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters
propertyId:String

The unique identifier (URI) of the property being set.

Exceptions
XMLConfigurationException:
If the requested feature is not known or supported.
getDocumentHandlerback to summary
public XMLDocumentHandler getDocumentHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDocumentHandler.

Returns the registered document handler.

getDTDContentModelHandlerback to summary
public XMLDTDContentModelHandler getDTDContentModelHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDTDContentModelHandler.

Returns the registered DTD content model handler.

getDTDHandlerback to summary
public XMLDTDHandler getDTDHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getDTDHandler.

Returns the registered DTD handler.

getEntityResolverback to summary
public XMLEntityResolver getEntityResolver()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getEntityResolver.

Return the current entity resolver.

Returns:XMLEntityResolver

The current entity resolver, or null if none has been registered.

See Also
setEntityResolver
getErrorHandlerback to summary
public XMLErrorHandler getErrorHandler()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getErrorHandler.

Return the current error handler.

Returns:XMLErrorHandler

The current error handler, or null if none has been registered.

See Also
setErrorHandler
getLocaleback to summary
public Locale getLocale()

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getLocale.

Returns the locale.

parseback to summary
public abstract void parse(XMLInputSource inputSource) throws XNIException, IOException

Redeclares org.apache.xerces.xni.parser.XMLParserConfiguration.parse.

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.

Parameters
inputSource:XMLInputSource

The input source for the top-level of the XML document.

Exceptions
XNIException:
Any XNI exception, possibly wrapping another exception.
IOException:
An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.
resetback to summary
protected void reset() throws XNIException

reset all components before parsing and namespace context

setDocumentHandlerback to summary
public void setDocumentHandler(XMLDocumentHandler documentHandler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDocumentHandler.

Sets the document handler on the last component in the pipeline to receive information about the document.

Parameters
documentHandler:XMLDocumentHandler

The document handler.

setDTDContentModelHandlerback to summary
public void setDTDContentModelHandler(XMLDTDContentModelHandler handler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDTDContentModelHandler.

Sets the DTD content model handler.

Parameters
handler:XMLDTDContentModelHandler

The DTD content model handler.

setDTDHandlerback to summary
public void setDTDHandler(XMLDTDHandler dtdHandler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setDTDHandler.

Sets the DTD handler.

Parameters
dtdHandler:XMLDTDHandler

The DTD handler.

setEntityResolverback to summary
public void setEntityResolver(XMLEntityResolver resolver)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setEntityResolver.

Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.

Parameters
resolver:XMLEntityResolver

The new entity resolver. Passing a null value will uninstall the currently installed resolver.

setErrorHandlerback to summary
public void setErrorHandler(XMLErrorHandler errorHandler)

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setErrorHandler.

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.

Parameters
errorHandler:XMLErrorHandler

The error handler.

Exceptions
NullPointerException:
If the handler argument is null.
See Also
getErrorHandler
setFeatureback to summary
public void setFeature(String featureId, boolean state) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.setFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setFeature.

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.

Parameters
featureId:String

The unique identifier (URI) of the feature.

state:boolean

The requested state of the feature (true or false).

Exceptions
XMLConfigurationException:
If the requested feature is not known.
setLocaleback to summary
public void setLocale(Locale locale) throws XNIException

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setLocale.

Set the locale to use for messages.

Parameters
locale:Locale

The locale object to use for localization of messages.

Exceptions
XNIException:
Thrown if the parser does not support the specified locale.
setPropertyback to summary
public void setProperty(String propertyId, Object value) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.setProperty.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setProperty.

setProperty

Exceptions
XMLConfigurationException:

Doc from org.apache.xerces.xni.parser.XMLParserConfiguration.setProperty.

Thrown if there is a configuration error.