Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.parsers

public Class DTDConfiguration

extends BasicParserConfiguration
implements XMLPullParserConfiguration
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration, com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration, com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager
Known Direct Subclasses
com.sun.org.apache.xerces.internal.parsers.StandardParserConfiguration
Imports
java.io.IOException, java.util.Locale, com.sun.org.apache.xerces.internal.impl.Constants, .XMLDTDScannerImpl, .XMLDocumentScannerImpl, .XMLEntityManager, .XMLErrorReporter, .XMLNamespaceBinder, com.sun.org.apache.xerces.internal.impl.dtd.XMLDTDProcessor, .XMLDTDValidator, com.sun.org.apache.xerces.internal.impl.dv.DTDDVFactory, com.sun.org.apache.xerces.internal.impl.msg.XMLMessageFormatter, com.sun.org.apache.xerces.internal.impl.validation.ValidationManager, com.sun.org.apache.xerces.internal.util.FeatureState, .PropertyState, .SymbolTable, com.sun.org.apache.xerces.internal.utils.XMLSecurityPropertyManager, com.sun.org.apache.xerces.internal.xni.XMLLocator, .XNIException, com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool, com.sun.org.apache.xerces.internal.xni.parser.XMLComponent, .XMLComponentManager, .XMLConfigurationException, .XMLDTDScanner, .XMLDocumentScanner, .XMLInputSource, .XMLPullParserConfiguration, javax.xml.XMLConstants, javax.xml.catalog.CatalogFeatures, jdk.xml.internal.JdkConstants, .JdkXmlUtils
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:

Authors
Arnaud Le Hors, IBM, Andy Clark, IBM, Neil Graham, IBM

Field Summary

Modifier and TypeField and Description
protected static final String
ALLOW_JAVA_ENCODINGS

Feature identifier: allow Java encodings.

protected static final String
CONTINUE_AFTER_FATAL_ERROR

Feature identifier: continue after fatal error.

protected static final String
DATATYPE_VALIDATOR_FACTORY

Property identifier: datatype validator factory.

protected static final String
DOCUMENT_SCANNER

Property identifier document scanner:

protected static final String
DTD_PROCESSOR

Property identifier: DTD loader.

protected static final String
DTD_SCANNER

Property identifier: DTD scanner.

protected static final String
DTD_VALIDATOR

Property identifier: DTD validator.

protected static final String
ENTITY_MANAGER

Property identifier: entity manager.

protected static final String
ERROR_REPORTER

Property identifier: error reporter.

protected DTDDVFactory
fDatatypeValidatorFactory

Datatype validator factory.

protected XMLDTDProcessor
fDTDProcessor

DTD Processor .

protected XMLDTDScanner
fDTDScanner

DTD scanner.

protected XMLDTDValidator
fDTDValidator

DTD Validator.

protected XMLEntityManager
fEntityManager

Entity manager.

protected XMLErrorReporter
fErrorReporter

Error reporter.

protected XMLGrammarPool
fGrammarPool

Grammar pool.

protected XMLInputSource
fInputSource

Input Source

protected XMLLocator
fLocator

Locator

protected XMLNamespaceBinder
fNamespaceBinder

Namespace binder.

protected boolean
fParseInProgress

True if a parse is in progress.

protected XMLDocumentScanner
fScanner

Document scanner.

protected ValidationManager
fValidationManager

protected static final String
JAXP_SCHEMA_LANGUAGE

Property identifier: JAXP schema language / DOM schema-type.

protected static final String
JAXP_SCHEMA_SOURCE

Property identifier: JAXP schema source/ DOM schema-location.

protected static final String
LOAD_EXTERNAL_DTD

Feature identifier: load external DTD.

protected static final String
LOCALE

Property identifier: locale.

protected static final String
NAMESPACE_BINDER

Property identifier: namespace binder.

protected static final String
NOTIFY_BUILTIN_REFS

Feature identifier: notify built-in refereces.

protected static final String
NOTIFY_CHAR_REFS

Feature identifier: notify character refereces.

private static final String
SECURITY_MANAGER

Property identifier: Security manager.

protected static final String
VALIDATION_MANAGER

protected static final String
WARN_ON_DUPLICATE_ATTDEF

Feature identifier: warn on duplicate attribute definition.

protected static final String
WARN_ON_DUPLICATE_ENTITYDEF

Feature identifier: warn on duplicate entity definition.

protected static final String
WARN_ON_UNDECLARED_ELEMDEF

Feature identifier: warn on undeclared element definition.

protected static final String
XML_SECURITY_PROPERTY_MANAGER

Property identifier: Security property manager.

protected static final String
XMLGRAMMAR_POOL

Property identifier: grammar pool.

Inherited from com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration:
ENTITY_RESOLVERERROR_HANDLEREXTERNAL_GENERAL_ENTITIESEXTERNAL_PARAMETER_ENTITIESfComponentsfDocumentHandlerfDTDContentModelHandlerfDTDHandlerfLastComponentfLocalefSymbolTableNAMESPACESSYMBOL_TABLEVALIDATIONXML_STRING

Constructor Summary

AccessConstructor and Description
public
DTDConfiguration()

Default constructor.

public
DTDConfiguration(SymbolTable
The symbol table to use.
symbolTable)

Constructs a parser configuration using the specified symbol table.

public
DTDConfiguration(SymbolTable
The symbol table to use.
symbolTable, XMLGrammarPool
The grammar pool to use.
grammarPool)

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

public
DTDConfiguration(SymbolTable
The symbol table to use.
symbolTable, XMLGrammarPool
The grammar pool to use.
grammarPool, XMLComponentManager
The parent settings.
parentSettings)

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

Method Summary

Modifier and TypeMethod and Description
protected FeatureState
checkFeature(String
The unique identifier (URI) of the feature.
featureId)

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.checkFeature.

Check a feature.

protected PropertyState
checkProperty(String
The unique identifier (URI) of the property being set.
propertyId)

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.checkProperty.

Check a property.

public void
cleanup()

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.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.

protected void
configureDTDPipeline()

protected void
configurePipeline()

Configures the pipeline.

protected DTDDVFactory
createDatatypeValidatorFactory()

Create a datatype validator factory.

protected XMLDocumentScanner
createDocumentScanner()

Create a document scanner.

protected XMLDTDProcessor
createDTDProcessor()

Create a DTD loader .

protected XMLDTDScanner
createDTDScanner()

Create a DTD scanner.

protected XMLDTDValidator
createDTDValidator()

Create a DTD validator.

protected XMLEntityManager
createEntityManager()

Creates an entity manager.

protected XMLErrorReporter
createErrorReporter()

Creates an error reporter.

protected XMLNamespaceBinder
createNamespaceBinder()

Create a namespace binder.

protected ValidationManager
createValidationManager()

public PropertyState
getPropertyState(String propertyId)

Overrides com.sun.org.apache.xerces.internal.util.ParserConfigurationSettings.getPropertyState.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getPropertyState.

public boolean

Returns:

True if there is more document to parse.
parse(boolean
True if the pull parser should parse the remaining document completely.
complete)

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.parse.

Parses the document in a pull parsing fashion.

public void
parse(XMLInputSource
The input source.
source)

Implements abstract com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.parse.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.parse.

Parses the specified input source.

protected void
reset()

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.reset.

Reset all components before parsing.

public void
setInputSource(XMLInputSource
The document's input source.
inputSource)

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.setInputSource.

Sets the input source for the document to parse.

public void
setLocale(Locale
The locale object to use for localization of messages.
locale)

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.setLocale.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.setLocale.

Set the locale to use for messages.

public void
setProperty(String
The property identifier.
propertyId, Object
The value of the property.
value)

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.setProperty.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.setProperty.

Sets the value of a property.

Inherited from com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration:
addComponentgetDocumentHandlergetDTDContentModelHandlergetDTDHandlergetEntityResolvergetErrorHandlergetLocalesetDocumentHandlersetDTDContentModelHandlersetDTDHandlersetEntityResolversetErrorHandlersetFeature

Field Detail

ALLOW_JAVA_ENCODINGSback to summary
protected static final String ALLOW_JAVA_ENCODINGS

Feature identifier: allow Java encodings.

CONTINUE_AFTER_FATAL_ERRORback to summary
protected static final String CONTINUE_AFTER_FATAL_ERROR

Feature identifier: continue after fatal error.

DATATYPE_VALIDATOR_FACTORYback to summary
protected static final String DATATYPE_VALIDATOR_FACTORY

Property identifier: datatype validator factory.

DOCUMENT_SCANNERback to summary
protected static final String DOCUMENT_SCANNER

Property identifier document scanner:

DTD_PROCESSORback to summary
protected static final String DTD_PROCESSOR

Property identifier: DTD loader.

DTD_SCANNERback to summary
protected static final String DTD_SCANNER

Property identifier: DTD scanner.

DTD_VALIDATORback to summary
protected static final String DTD_VALIDATOR

Property identifier: DTD validator.

ENTITY_MANAGERback to summary
protected static final String ENTITY_MANAGER

Property identifier: entity manager.

ERROR_REPORTERback to summary
protected static final String ERROR_REPORTER

Property identifier: error reporter.

fDatatypeValidatorFactoryback to summary
protected DTDDVFactory fDatatypeValidatorFactory

Datatype validator factory.

fDTDProcessorback to summary
protected XMLDTDProcessor fDTDProcessor

DTD Processor .

fDTDScannerback to summary
protected XMLDTDScanner fDTDScanner

DTD scanner.

fDTDValidatorback to summary
protected XMLDTDValidator fDTDValidator

DTD Validator.

fEntityManagerback to summary
protected XMLEntityManager fEntityManager

Entity manager.

fErrorReporterback to summary
protected XMLErrorReporter fErrorReporter

Error reporter.

fGrammarPoolback to summary
protected XMLGrammarPool fGrammarPool

Grammar pool.

fInputSourceback to summary
protected XMLInputSource fInputSource

Input Source

fLocatorback to summary
protected XMLLocator fLocator

Locator

fNamespaceBinderback to summary
protected XMLNamespaceBinder fNamespaceBinder

Namespace binder.

fParseInProgressback to summary
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).

fScannerback to summary
protected XMLDocumentScanner fScanner

Document scanner.

fValidationManagerback to summary
protected ValidationManager fValidationManager
JAXP_SCHEMA_LANGUAGEback to summary
protected static final String JAXP_SCHEMA_LANGUAGE

Property identifier: JAXP schema language / DOM schema-type.

JAXP_SCHEMA_SOURCEback to summary
protected static final String JAXP_SCHEMA_SOURCE

Property identifier: JAXP schema source/ DOM schema-location.

LOAD_EXTERNAL_DTDback to summary
protected static final String LOAD_EXTERNAL_DTD

Feature identifier: load external DTD.

LOCALEback to summary
protected static final String LOCALE

Property identifier: locale.

NAMESPACE_BINDERback to summary
protected static final String NAMESPACE_BINDER

Property identifier: namespace binder.

NOTIFY_BUILTIN_REFSback to summary
protected static final String NOTIFY_BUILTIN_REFS

Feature identifier: notify built-in refereces.

NOTIFY_CHAR_REFSback to summary
protected static final String NOTIFY_CHAR_REFS

Feature identifier: notify character refereces.

SECURITY_MANAGERback to summary
private static final String SECURITY_MANAGER

Property identifier: Security manager.

VALIDATION_MANAGERback to summary
protected static final String VALIDATION_MANAGER
WARN_ON_DUPLICATE_ATTDEFback to summary
protected static final String WARN_ON_DUPLICATE_ATTDEF

Feature identifier: warn on duplicate attribute definition.

WARN_ON_DUPLICATE_ENTITYDEFback to summary
protected static final String WARN_ON_DUPLICATE_ENTITYDEF

Feature identifier: warn on duplicate entity definition.

WARN_ON_UNDECLARED_ELEMDEFback to summary
protected static final String WARN_ON_UNDECLARED_ELEMDEF

Feature identifier: warn on undeclared element definition.

XML_SECURITY_PROPERTY_MANAGERback to summary
protected static final String XML_SECURITY_PROPERTY_MANAGER

Property identifier: Security property manager.

XMLGRAMMAR_POOLback to summary
protected static final String XMLGRAMMAR_POOL

Property identifier: grammar pool.

Constructor Detail

DTDConfigurationback to summary
public DTDConfiguration()

Default constructor.

DTDConfigurationback to summary
public DTDConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters
symbolTable:SymbolTable

The symbol table to use.

DTDConfigurationback to summary
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:SymbolTable

The symbol table to use.

grammarPool:XMLGrammarPool

The grammar pool to use.

DTDConfigurationback to summary
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:SymbolTable

The symbol table to use.

grammarPool:XMLGrammarPool

The grammar pool to use.

parentSettings:XMLComponentManager

The parent settings.

Method Detail

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

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.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 PropertyState checkProperty(String propertyId) throws XMLConfigurationException

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.checkProperty.

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

Parameters
propertyId:String

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

Returns:PropertyState

Doc from com.sun.org.apache.xerces.internal.util.ParserConfigurationSettings.checkProperty.

the PropertyState

Exceptions
XMLConfigurationException:
Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
cleanupback to summary
public void cleanup()

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.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.

configureDTDPipelineback to summary
protected void configureDTDPipeline()
configurePipelineback to summary
protected void configurePipeline()

Configures the pipeline.

createDatatypeValidatorFactoryback to summary
protected DTDDVFactory createDatatypeValidatorFactory()

Create a datatype validator factory.

createDocumentScannerback to summary
protected XMLDocumentScanner createDocumentScanner()

Create a document scanner.

createDTDProcessorback to summary
protected XMLDTDProcessor createDTDProcessor()

Create a DTD loader .

createDTDScannerback to summary
protected XMLDTDScanner createDTDScanner()

Create a DTD scanner.

createDTDValidatorback to summary
protected XMLDTDValidator createDTDValidator()

Create a DTD validator.

createEntityManagerback to summary
protected XMLEntityManager createEntityManager()

Creates an entity manager.

createErrorReporterback to summary
protected XMLErrorReporter createErrorReporter()

Creates an error reporter.

createNamespaceBinderback to summary
protected XMLNamespaceBinder createNamespaceBinder()

Create a namespace binder.

createValidationManagerback to summary
protected ValidationManager createValidationManager()
getPropertyStateback to summary
public PropertyState getPropertyState(String propertyId) throws XMLConfigurationException

Overrides com.sun.org.apache.xerces.internal.util.ParserConfigurationSettings.getPropertyState.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getPropertyState.

parseback to summary
public boolean parse(boolean complete) throws XNIException, IOException

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.parse.

Parses the document in a pull parsing fashion.

Parameters
complete:boolean

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

Returns:boolean

True if there is more document to parse.

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.
See Also
setInputSource
parseback to summary
public void parse(XMLInputSource source) throws XNIException, IOException

Implements abstract com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.parse.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.parse.

Parses the specified input source.

Parameters
source:XMLInputSource

The input source.

Exceptions
XNIException:
Throws exception on XNI error.
IOException:
Throws exception on i/o error.
resetback to summary
protected void reset() throws XNIException

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.reset.

Reset all components before parsing.

Exceptions
XNIException:
Thrown if an error occurs during initialization.
setInputSourceback to summary
public void setInputSource(XMLInputSource inputSource) throws XMLConfigurationException, IOException

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLPullParserConfiguration.setInputSource.

Sets the input source for the document to parse.

Parameters
inputSource:XMLInputSource

The document's input source.

Exceptions
XMLConfigurationException:
Thrown if there is a configuration error when initializing the parser.
IOException:
Thrown on I/O error.
See Also
parse(boolean)
setLocaleback to summary
public void setLocale(Locale locale) throws XNIException

Overrides com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.setLocale.

Implements com.sun.org.apache.xerces.internal.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 com.sun.org.apache.xerces.internal.parsers.BasicParserConfiguration.setProperty.

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.setProperty.

Doc from com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration.setProperty.

Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.

Parameters
propertyId:String

The property identifier.

value:Object

The value of the property.

Exceptions
XMLConfigurationException:
Thrown if there is a configuration error.