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

public Class NonValidatingConfiguration

extends BasicParserConfiguration
implements XMLPullParserConfiguration
Class Inheritance
All Implemented Interfaces
org.apache.xerces.xni.parser.XMLPullParserConfiguration, org.apache.xerces.xni.parser.XMLParserConfiguration, org.apache.xerces.xni.parser.XMLComponentManager
Imports
java.io.IOException, java.util.Locale, org.apache.xerces.impl.Constants, .XMLDTDScannerImpl, .XMLDocumentScannerImpl, .XMLEntityManager, .XMLErrorReporter, .XMLNSDocumentScannerImpl, org.apache.xerces.impl.dv.DTDDVFactory, org.apache.xerces.impl.msg.XMLMessageFormatter, org.apache.xerces.impl.validation.ValidationManager, org.apache.xerces.util.SymbolTable, org.apache.xerces.xni.XMLLocator, .XNIException, org.apache.xerces.xni.grammars.XMLGrammarPool, org.apache.xerces.xni.parser.XMLComponent, .XMLComponentManager, .XMLConfigurationException, .XMLDTDScanner, .XMLDocumentScanner, .XMLInputSource, .XMLPullParserConfiguration
This is the non validating parser configuration. It extends the basic configuration with the set of following parser components: Document scanner, DTD scanner, namespace binder, document handler.

Xerces parser that uses this configuration is not conformant non-validating XML processor, since conformant non-validating processor is required to process "all the declarations they read in the internal DTD subset ... must use the information in those declarations to normalize attribute values, include the replacement text of internal entities, and supply default attribute values".

Author
Elena Litani, IBM
Version
$Id: NonValidatingConfiguration.java 713638 2008-11-13 04:42:18Z mrglavas $

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_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 boolean
fConfigUpdated

fConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.

protected DTDDVFactory
fDatatypeValidatorFactory

Datatype validator factory.

protected XMLDTDScanner
fDTDScanner

DTD scanner.

protected XMLEntityManager
fEntityManager

Entity manager.

protected XMLErrorReporter
fErrorReporter

Error reporter.

protected XMLGrammarPool
fGrammarPool

Grammar pool.

protected XMLInputSource
fInputSource

Input Source

protected XMLLocator
fLocator

Locator

private XMLNSDocumentScannerImpl
fNamespaceScanner

Document scanner that does namespace binding.

private XMLDocumentScannerImpl
fNonNSScanner

Default Xerces implementation of scanner

protected boolean
fParseInProgress

True if a parse is in progress.

protected XMLDocumentScanner
fScanner

Document scanner.

protected ValidationManager
fValidationManager

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
NORMALIZE_DATA

Feature identifier: expose schema normalized value

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.

protected static final String
SCHEMA_ELEMENT_DEFAULT

Feature identifier: send element default value via characters()

protected static final String
SCHEMA_VALIDATOR

Property identifier: XML Schema validator.

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
XMLGRAMMAR_POOL

Property identifier: grammar pool.

Inherited from org.apache.xerces.parsers.BasicParserConfiguration:
ENTITY_RESOLVERERROR_HANDLEREXTERNAL_GENERAL_ENTITIESEXTERNAL_PARAMETER_ENTITIESfComponentsfDocumentHandlerfDTDContentModelHandlerfDTDHandlerfLastComponentfLocalefSymbolTableNAMESPACESSYMBOL_TABLEVALIDATIONXML_STRING

Constructor Summary

AccessConstructor and Description
public
NonValidatingConfiguration()

Default constructor.

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

Constructs a parser configuration using the specified symbol table.

public
NonValidatingConfiguration(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
NonValidatingConfiguration(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 void
checkFeature(String
The unique identifier (URI) of the feature.
featureId)

Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkFeature.

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

Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkProperty.

Check a property.
public void
cleanup()

Implements org.apache.xerces.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
configurePipeline()

Configures the pipeline.

protected DTDDVFactory
createDatatypeValidatorFactory()

Create a datatype validator factory.

protected XMLDocumentScanner
createDocumentScanner()

Create a document scanner.

protected XMLDTDScanner
createDTDScanner()

Create a DTD scanner.

protected XMLEntityManager
createEntityManager()

Creates an entity manager.

protected XMLErrorReporter
createErrorReporter()

Creates an error reporter.

protected ValidationManager
createValidationManager()

public boolean
getFeature(String
The feature identifier.
featureId)

Overrides org.apache.xerces.util.ParserConfigurationSettings.getFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.getFeature.

Returns the state of a feature.
public Object
getProperty(String
The property identifier.
propertyId)

Overrides org.apache.xerces.util.ParserConfigurationSettings.getProperty.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getProperty, org.apache.xerces.xni.parser.XMLComponentManager.getProperty.

Returns the value of a property.
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 org.apache.xerces.xni.parser.XMLPullParserConfiguration.parse.

Parses the document in a pull parsing fashion.
public void
parse(XMLInputSource
The input source.
source)

Implements abstract org.apache.xerces.parsers.BasicParserConfiguration.parse.

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

Parses the specified input source.
protected void
reset()

Overrides org.apache.xerces.parsers.BasicParserConfiguration.reset.

Reset all components before parsing.
public void
setFeature(String
The feature identifier.
featureId, boolean
The state of the feature.
state)

Overrides org.apache.xerces.parsers.BasicParserConfiguration.setFeature.

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

Sets the state of a feature.
public void
setInputSource(XMLInputSource
The document's input source.
inputSource)

Implements org.apache.xerces.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 org.apache.xerces.parsers.BasicParserConfiguration.setLocale.

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

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

Sets the value of a property.
Inherited from org.apache.xerces.parsers.BasicParserConfiguration:
addComponentgetDocumentHandlergetDTDContentModelHandlergetDTDHandlergetEntityResolvergetErrorHandlergetLocalesetDocumentHandlersetDTDContentModelHandlersetDTDHandlersetEntityResolversetErrorHandler

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_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.

fConfigUpdatedback to summary
protected boolean fConfigUpdated

fConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.

fDatatypeValidatorFactoryback to summary
protected DTDDVFactory fDatatypeValidatorFactory

Datatype validator factory.

fDTDScannerback to summary
protected XMLDTDScanner fDTDScanner

DTD scanner.

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

fNamespaceScannerback to summary
private XMLNSDocumentScannerImpl fNamespaceScanner

Document scanner that does namespace binding.

fNonNSScannerback to summary
private XMLDocumentScannerImpl fNonNSScanner

Default Xerces implementation of scanner

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
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.

NORMALIZE_DATAback to summary
protected static final String NORMALIZE_DATA

Feature identifier: expose schema normalized value

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.

SCHEMA_ELEMENT_DEFAULTback to summary
protected static final String SCHEMA_ELEMENT_DEFAULT

Feature identifier: send element default value via characters()

SCHEMA_VALIDATORback to summary
protected static final String SCHEMA_VALIDATOR

Property identifier: XML Schema validator.

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.

XMLGRAMMAR_POOLback to summary
protected static final String XMLGRAMMAR_POOL

Property identifier: grammar pool.

Constructor Detail

NonValidatingConfigurationback to summary
public NonValidatingConfiguration()

Default constructor.

NonValidatingConfigurationback to summary
public NonValidatingConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters
symbolTable:SymbolTable

The symbol table to use.

NonValidatingConfigurationback to summary
public NonValidatingConfiguration(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.

NonValidatingConfigurationback to summary
public NonValidatingConfiguration(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 void checkFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.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 void checkProperty(String propertyId) throws XMLConfigurationException

Overrides org.apache.xerces.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.

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 org.apache.xerces.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.

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.

createDTDScannerback to summary
protected XMLDTDScanner createDTDScanner()

Create a DTD scanner.

createEntityManagerback to summary
protected XMLEntityManager createEntityManager()

Creates an entity manager.

createErrorReporterback to summary
protected XMLErrorReporter createErrorReporter()

Creates an error reporter.

createValidationManagerback to summary
protected ValidationManager createValidationManager()
getFeatureback to summary
public boolean getFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.getFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.getFeature.

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

Returns the state of a feature.

Parameters
featureId:String

The feature identifier.

Returns:boolean

Doc from org.apache.xerces.util.ParserConfigurationSettings.getFeature.

true if the feature is supported

Exceptions
XMLConfigurationException:
Thrown if there is a configuration error.
getPropertyback to summary
public Object getProperty(String propertyId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.getProperty.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getProperty, org.apache.xerces.xni.parser.XMLComponentManager.getProperty.

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

Returns the value of a property.

Parameters
propertyId:String

The property identifier.

Returns:Object

Doc from org.apache.xerces.util.ParserConfigurationSettings.getProperty.

the value of the property

Exceptions
XMLConfigurationException:
Thrown if there is a configuration error.
parseback to summary
public boolean parse(boolean complete) throws XNIException, IOException

Implements org.apache.xerces.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 org.apache.xerces.parsers.BasicParserConfiguration.parse.

Implements org.apache.xerces.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 org.apache.xerces.parsers.BasicParserConfiguration.reset.

Reset all components before parsing.

Exceptions
XNIException:
Thrown if an error occurs during initialization.
setFeatureback to summary
public void setFeature(String featureId, boolean state) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.BasicParserConfiguration.setFeature.

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

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

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

Parameters
featureId:String

The feature identifier.

state:boolean

The state of the feature.

Exceptions
XMLConfigurationException:
Thrown if there is a configuration error.
setInputSourceback to summary
public void setInputSource(XMLInputSource inputSource) throws XMLConfigurationException, IOException

Implements org.apache.xerces.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 org.apache.xerces.parsers.BasicParserConfiguration.setLocale.

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.parsers.BasicParserConfiguration.setProperty.

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

Doc from org.apache.xerces.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.