org.apache.xerces.parsers
Class XML11DTDConfiguration

java.lang.Object
  org.apache.xerces.util.ParserConfigurationSettings
      org.apache.xerces.parsers.XML11DTDConfiguration

All Implemented Interfaces:

XML11Configurable, XMLComponentManager, XMLParserConfiguration, XMLPullParserConfiguration

public class XML11DTDConfiguration
extends ParserConfigurationSettings
implements XMLPullParserConfiguration, XML11Configurable

This class is the DTD-only parser configuration used to parse XML 1.0 and XML 1.1 documents.

This class recognizes the following features and properties:

• Features
  • http://xml.org/sax/features/validation
  • http://xml.org/sax/features/namespaces
  • http://xml.org/sax/features/external-general-entities
  • http://xml.org/sax/features/external-parameter-entities
  • http://apache.org/xml/features/continue-after-fatal-error
  • http://apache.org/xml/features/load-external-dtd
• Properties
  • http://xml.org/sax/properties/xml-string
  • http://apache.org/xml/properties/internal/symbol-table
  • http://apache.org/xml/properties/internal/error-handler
  • http://apache.org/xml/properties/internal/entity-resolver
  • http://apache.org/xml/properties/internal/error-reporter
  • http://apache.org/xml/properties/internal/entity-manager
  • http://apache.org/xml/properties/internal/document-scanner
  • http://apache.org/xml/properties/internal/dtd-scanner
  • http://apache.org/xml/properties/internal/grammar-pool
  • http://apache.org/xml/properties/internal/validator/dtd
  • http://apache.org/xml/properties/internal/datatype-validator-factory

Version:

$Id: XML11DTDConfiguration.java 447239 2006-09-18 05:08:26Z mrglavas $

Author:

Elena Litani, IBM, Neil Graham, IBM, Michael Glavassevich, IBM, John Kim, IBM

Constructor Summary

XML11DTDConfiguration()
Default constructor.

XML11DTDConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.

XML11DTDConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.

XML11DTDConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.

Method Summary

void	cleanup() If the application decides to terminate parsing before the xml document is fully parsed, the application should call this method to free any resource allocated during parsing.
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.
boolean	getFeature(java.lang.String featureId) Returns the state of a feature.
java.util.Locale	getLocale() Returns the locale.
boolean	parse(boolean complete) Parses the document in a pull parsing fashion.
void	parse(XMLInputSource source) Parses the specified input source.
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	setInputSource(XMLInputSource inputSource) Sets the input source for the document to parse.
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, 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, getProperty

Constructor Detail

XML11DTDConfiguration

public XML11DTDConfiguration()

Default constructor.

XML11DTDConfiguration

public XML11DTDConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters:

symbolTable - The symbol table to use.

XML11DTDConfiguration

public XML11DTDConfiguration(SymbolTable symbolTable,
                             XMLGrammarPool grammarPool)

Constructs a parser configuration using the specified symbol table and grammar pool.

REVISIT: Grammar pool will be updated when the new validation engine is implemented.

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

XML11DTDConfiguration

public XML11DTDConfiguration(SymbolTable symbolTable,
                             XMLGrammarPool grammarPool,
                             XMLComponentManager parentSettings)

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

REVISIT: Grammar pool will be updated when the new validation engine is implemented.

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

parentSettings - The parent settings.

Method Detail

setInputSource

public void setInputSource(XMLInputSource inputSource)
                    throws XMLConfigurationException,
                           java.io.IOException

Sets the input source for the document to parse.

Specified by:

setInputSource in interface XMLPullParserConfiguration

Parameters:

inputSource - The document's input source.

Throws:

XMLConfigurationException - Thrown if there is a configuration error when initializing the parser.

java.io.IOException - Thrown on I/O error.

See Also:

parse(boolean)

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.

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)

cleanup

public void cleanup()

If the application decides to terminate parsing before the xml document is fully parsed, the application should call this method to free any resource allocated during parsing. For example, close all opened streams.

Specified by:

cleanup in interface XMLPullParserConfiguration

parse

public void parse(XMLInputSource source)
           throws XNIException,
                  java.io.IOException

Parses the specified input source.

Specified by:

parse in interface XMLParserConfiguration

Parameters:

source - The input source.

Throws:

XNIException - Throws exception on XNI error.

java.io.IOException - Throws exception on i/o error.

parse

public boolean parse(boolean complete)
              throws XNIException,
                     java.io.IOException

Description copied from interface: XMLPullParserConfiguration

Parses the document in a pull parsing fashion.

Specified by:

parse in interface XMLPullParserConfiguration

Parameters:

complete - True if the pull parser should parse the remaining document completely.

Returns:

True if there is more document to parse.

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.

See Also:

XMLPullParserConfiguration.setInputSource(org.apache.xerces.xni.parser.XMLInputSource)

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws XMLConfigurationException

Returns the state of a feature.

Specified by:

getFeature in interface XMLComponentManager

Specified by:

getFeature in interface XMLParserConfiguration

Overrides:

getFeature in class ParserConfigurationSettings

Parameters:

featureId - The feature identifier.

Returns:

true if the feature is supported

Throws:

XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

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.

getLocale

public java.util.Locale getLocale()

Returns the locale.

Specified by:

getLocale in interface XMLParserConfiguration