org.apache.xerces.parsers
public abstract class BasicParserConfiguration extends ParserConfigurationSettings implements XMLParserConfiguration
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,v 1.24 2004/04/12 21:56:02 mrglavas Exp $
Field Summary | |
---|---|
protected static String | ENTITY_RESOLVER Property identifier: entity resolver. |
protected static String | ERROR_HANDLER Property identifier: error handler. |
protected static String | EXTERNAL_GENERAL_ENTITIES Feature identifier: external general entities. |
protected static String | EXTERNAL_PARAMETER_ENTITIES Feature identifier: external parameter entities. |
protected ArrayList | 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 String | NAMESPACES Feature identifier: namespaces. |
protected static String | SYMBOL_TABLE Property identifier: symbol table. |
protected static String | VALIDATION Feature identifier: validation. |
protected static String | XML_STRING Property identifier: xml string. |
Constructor Summary | |
---|---|
protected | BasicParserConfiguration() Default Constructor. |
protected | BasicParserConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
|
protected | BasicParserConfiguration(SymbolTable symbolTable, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table
and parent settings.
|
Method Summary | |
---|---|
protected void | addComponent(XMLComponent component)
Adds a component to the parser configuration. |
protected void | checkFeature(String featureId)
Check a feature. |
protected void | checkProperty(String propertyId)
Check a property. |
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.
|
Locale | getLocale() Returns the locale. |
abstract void | parse(XMLInputSource inputSource)
Parse an XML document.
|
protected void | reset()
reset all components before parsing and namespace context |
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(String featureId, boolean state)
Set the state of a feature.
|
void | setLocale(Locale locale)
Set the locale to use for messages.
|
void | setProperty(String propertyId, Object value)
setProperty
|
Parameters: symbolTable The symbol table to use.
Parameters: symbolTable The symbol table to use. parentSettings The parent settings.
Parameters: component The component to add.
Parameters: featureId The unique identifier (URI) of the feature.
Throws: XMLConfigurationException Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
Parameters: propertyId The unique identifier (URI) of the property being set.
Throws: org.apache.xerces.xni.parser.XMLConfigurationException If the requested feature is not known or supported.
Returns: The current entity resolver, or null if none has been registered.
See Also: BasicParserConfiguration
Returns: The current error handler, or null if none has been registered.
See Also: BasicParserConfiguration
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 The input source for the top-level of the XML document.
Throws: 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.
Parameters: documentHandler The document handler.
Parameters: handler The DTD content model handler.
Parameters: dtdHandler The DTD handler.
Parameters: resolver The new entity resolver. Passing a null value will uninstall the currently installed resolver.
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 The error handler.
Throws: java.lang.NullPointerException If the handler argument is null.
See Also: BasicParserConfiguration
Parameters: featureId The unique identifier (URI) of the feature. state The requested state of the feature (true or false).
Throws: org.apache.xerces.xni.parser.XMLConfigurationException If the requested feature is not known.
Parameters: locale The locale object to use for localization of messages.
Throws: XNIException Thrown if the parser does not support the specified locale.
Parameters: propertyId value