org.apache.xerces.parsers

Class DTDConfiguration

public class DTDConfiguration extends BasicParserConfiguration implements XMLPullParserConfiguration

This is the DTD-only parser configuration. It extends the basic configuration with a standard set of parser components appropriate to DTD-centric validation. Since the Xerces2 reference implementation document and DTD scanner implementations are capable of acting as pull parsers, this configuration implements the XMLPullParserConfiguration interface.

In addition to the features and properties recognized by the base parser configuration, this class recognizes these additional features and properties:

Version: $Id: DTDConfiguration.java,v 1.18 2004/02/24 23:15:57 mrglavas Exp $

Author: Arnaud Le Hors, IBM Andy Clark, IBM Neil Graham, IBM

Field Summary
protected static StringALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.
protected static StringCONTINUE_AFTER_FATAL_ERROR
Feature identifier: continue after fatal error.
protected static StringDATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.
protected static StringDOCUMENT_SCANNER
Property identifier document scanner:
protected static StringDTD_PROCESSOR
Property identifier: DTD loader.
protected static StringDTD_SCANNER
Property identifier: DTD scanner.
protected static StringDTD_VALIDATOR
Property identifier: DTD validator.
protected static StringENTITY_MANAGER
Property identifier: entity manager.
protected static StringERROR_REPORTER
Property identifier: error reporter.
protected DTDDVFactoryfDatatypeValidatorFactory
Datatype validator factory.
protected XMLDTDProcessorfDTDProcessor
DTD Processor .
protected XMLDTDScannerfDTDScanner
DTD scanner.
protected XMLDTDValidatorfDTDValidator
DTD Validator.
protected XMLEntityManagerfEntityManager
Entity manager.
protected XMLErrorReporterfErrorReporter
Error reporter.
protected XMLGrammarPoolfGrammarPool
Grammar pool.
protected XMLInputSourcefInputSource
Input Source
protected XMLLocatorfLocator
Locator
protected XMLNamespaceBinderfNamespaceBinder
Namespace binder.
protected booleanfParseInProgress
True if a parse is in progress.
protected XMLDocumentScannerfScanner
Document scanner.
protected ValidationManagerfValidationManager
protected static StringJAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language / DOM schema-type.
protected static StringJAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source/ DOM schema-location.
protected static StringLOAD_EXTERNAL_DTD
Feature identifier: load external DTD.
protected static StringNAMESPACE_BINDER
Property identifier: namespace binder.
protected static StringNOTIFY_BUILTIN_REFS
Feature identifier: notify built-in refereces.
protected static StringNOTIFY_CHAR_REFS
Feature identifier: notify character refereces.
protected static booleanPRINT_EXCEPTION_STACK_TRACE
Set to true and recompile to print exception stack trace.
protected static StringVALIDATION_MANAGER
protected static StringWARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attribute definition.
protected static StringWARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate entity definition.
protected static StringWARN_ON_UNDECLARED_ELEMDEF
Feature identifier: warn on undeclared element definition.
protected static StringXMLGRAMMAR_POOL
Property identifier: grammar pool.
Constructor Summary
DTDConfiguration()
Default constructor.
DTDConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
DTDConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.
DTDConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.
Method Summary
protected voidcheckFeature(String featureId)
Check a feature.
protected voidcheckProperty(String propertyId)
Check a property.
voidcleanup()
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.
protected voidconfigureDTDPipeline()
protected voidconfigurePipeline()
Configures the pipeline.
protected DTDDVFactorycreateDatatypeValidatorFactory()
Create a datatype validator factory.
protected XMLDocumentScannercreateDocumentScanner()
Create a document scanner.
protected XMLDTDProcessorcreateDTDProcessor()
Create a DTD loader .
protected XMLDTDScannercreateDTDScanner()
Create a DTD scanner.
protected XMLDTDValidatorcreateDTDValidator()
Create a DTD validator.
protected XMLEntityManagercreateEntityManager()
Creates an entity manager.
protected XMLErrorReportercreateErrorReporter()
Creates an error reporter.
protected XMLNamespaceBindercreateNamespaceBinder()
Create a namespace binder.
protected ValidationManagercreateValidationManager()
booleanparse(boolean complete)
Parses the document in a pull parsing fashion.
voidparse(XMLInputSource source)
Parses the specified input source.
protected voidreset()
Reset all components before parsing.
voidsetInputSource(XMLInputSource inputSource)
Sets the input source for the document to parse.
voidsetLocale(Locale locale)
Set the locale to use for messages.

Field Detail

ALLOW_JAVA_ENCODINGS

protected static final String ALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.

CONTINUE_AFTER_FATAL_ERROR

protected static final String CONTINUE_AFTER_FATAL_ERROR
Feature identifier: continue after fatal error.

DATATYPE_VALIDATOR_FACTORY

protected static final String DATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.

DOCUMENT_SCANNER

protected static final String DOCUMENT_SCANNER
Property identifier document scanner:

DTD_PROCESSOR

protected static final String DTD_PROCESSOR
Property identifier: DTD loader.

DTD_SCANNER

protected static final String DTD_SCANNER
Property identifier: DTD scanner.

DTD_VALIDATOR

protected static final String DTD_VALIDATOR
Property identifier: DTD validator.

ENTITY_MANAGER

protected static final String ENTITY_MANAGER
Property identifier: entity manager.

ERROR_REPORTER

protected static final String ERROR_REPORTER
Property identifier: error reporter.

fDatatypeValidatorFactory

protected DTDDVFactory fDatatypeValidatorFactory
Datatype validator factory.

fDTDProcessor

protected XMLDTDProcessor fDTDProcessor
DTD Processor .

fDTDScanner

protected XMLDTDScanner fDTDScanner
DTD scanner.

fDTDValidator

protected XMLDTDValidator fDTDValidator
DTD Validator.

fEntityManager

protected XMLEntityManager fEntityManager
Entity manager.

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter.

fGrammarPool

protected XMLGrammarPool fGrammarPool
Grammar pool.

fInputSource

protected XMLInputSource fInputSource
Input Source

fLocator

protected XMLLocator fLocator
Locator

fNamespaceBinder

protected XMLNamespaceBinder fNamespaceBinder
Namespace binder.

fParseInProgress

protected boolean fParseInProgress
True if a parse is in progress. This state is needed because some features/properties cannot be set while parsing (e.g. validation and namespaces).

fScanner

protected XMLDocumentScanner fScanner
Document scanner.

fValidationManager

protected ValidationManager fValidationManager

JAXP_SCHEMA_LANGUAGE

protected static final String JAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language / DOM schema-type.

JAXP_SCHEMA_SOURCE

protected static final String JAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source/ DOM schema-location.

LOAD_EXTERNAL_DTD

protected static final String LOAD_EXTERNAL_DTD
Feature identifier: load external DTD.

NAMESPACE_BINDER

protected static final String NAMESPACE_BINDER
Property identifier: namespace binder.

NOTIFY_BUILTIN_REFS

protected static final String NOTIFY_BUILTIN_REFS
Feature identifier: notify built-in refereces.

NOTIFY_CHAR_REFS

protected static final String NOTIFY_CHAR_REFS
Feature identifier: notify character refereces.

PRINT_EXCEPTION_STACK_TRACE

protected static final boolean PRINT_EXCEPTION_STACK_TRACE
Set to true and recompile to print exception stack trace.

VALIDATION_MANAGER

protected static final String VALIDATION_MANAGER

WARN_ON_DUPLICATE_ATTDEF

protected static final String WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attribute definition.

WARN_ON_DUPLICATE_ENTITYDEF

protected static final String WARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate entity definition.

WARN_ON_UNDECLARED_ELEMDEF

protected static final String WARN_ON_UNDECLARED_ELEMDEF
Feature identifier: warn on undeclared element definition.

XMLGRAMMAR_POOL

protected static final String XMLGRAMMAR_POOL
Property identifier: grammar pool.

Constructor Detail

DTDConfiguration

public DTDConfiguration()
Default constructor.

DTDConfiguration

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

Parameters: symbolTable The symbol table to use.

DTDConfiguration

public DTDConfiguration(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.

DTDConfiguration

public DTDConfiguration(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

checkFeature

protected void checkFeature(String featureId)
Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

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.

checkProperty

protected void checkProperty(String propertyId)
Check a property. If the property is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

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

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

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.

configureDTDPipeline

protected void configureDTDPipeline()

configurePipeline

protected void configurePipeline()
Configures the pipeline.

createDatatypeValidatorFactory

protected DTDDVFactory createDatatypeValidatorFactory()
Create a datatype validator factory.

createDocumentScanner

protected XMLDocumentScanner createDocumentScanner()
Create a document scanner.

createDTDProcessor

protected XMLDTDProcessor createDTDProcessor()
Create a DTD loader .

createDTDScanner

protected XMLDTDScanner createDTDScanner()
Create a DTD scanner.

createDTDValidator

protected XMLDTDValidator createDTDValidator()
Create a DTD validator.

createEntityManager

protected XMLEntityManager createEntityManager()
Creates an entity manager.

createErrorReporter

protected XMLErrorReporter createErrorReporter()
Creates an error reporter.

createNamespaceBinder

protected XMLNamespaceBinder createNamespaceBinder()
Create a namespace binder.

createValidationManager

protected ValidationManager createValidationManager()

parse

public boolean parse(boolean complete)
Parses the document in a pull parsing fashion.

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. IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.

See Also: DTDConfiguration

parse

public void parse(XMLInputSource source)
Parses the specified input source.

Parameters: source The input source.

Throws: XNIException Throws exception on XNI error. java.io.IOException Throws exception on i/o error.

reset

protected void reset()
Reset all components before parsing.

Throws: XNIException Thrown if an error occurs during initialization.

setInputSource

public void setInputSource(XMLInputSource inputSource)
Sets the input source for the document to parse.

Parameters: inputSource The document's input source.

Throws: XMLConfigurationException Thrown if there is a configuration error when initializing the parser. IOException Thrown on I/O error.

See Also: DTDConfiguration

setLocale

public void setLocale(Locale locale)
Set the locale to use for messages.

Parameters: locale The locale object to use for localization of messages.

Throws: XNIException Thrown if the parser does not support the specified locale.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.