org.apache.xerces.parsers

Class XML11Configuration

Implemented Interfaces:
XML11Configurable, org.apache.xerces.xni.parser.XMLComponentManager, org.apache.xerces.xni.parser.XMLPullParserConfiguration
Known Direct Subclasses:
XIncludeAwareParserConfiguration, XIncludeParserConfiguration, XPointerParserConfiguration

public class XML11Configuration
extends ParserConfigurationSettings
implements org.apache.xerces.xni.parser.XMLPullParserConfiguration, XML11Configurable

This class is the configuration used to parse XML 1.0 and XML 1.1 documents.
Version:
$Id: XML11Configuration.java 371617 2006-01-23 18:41:49Z mrglavas $
Authors:
Elena Litani, IBM
Neil Graham, IBM
Michael Glavassevich, IBM

Field Summary

protected static String
ALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.
protected static String
CONTINUE_AFTER_FATAL_ERROR
Feature identifier: continue after fatal error.
protected static String
DATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.
protected static String
DOCUMENT_SCANNER
Property identifier document scanner:
protected static String
DTD_PROCESSOR
Property identifier: DTD loader.
protected static String
DTD_SCANNER
Property identifier: DTD scanner.
protected static String
DTD_VALIDATOR
Property identifier: DTD validator.
protected static String
ENTITY_MANAGER
Property identifier: entity manager.
protected static String
ENTITY_RESOLVER
Property identifier: entity resolver.
protected static String
ERROR_HANDLER
Property identifier: error handler.
protected static String
ERROR_REPORTER
Property identifier: error reporter.
protected static String
EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities.
protected static String
EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities.
protected static String
GENERATE_SYNTHETIC_ANNOTATIONS
Feature: generate synthetic annotations
protected static String
HONOUR_ALL_SCHEMALOCATIONS
Feature identifier: honour all schemaLocations
protected static String
IDENTITY_CONSTRAINT_CHECKING
Feature identifier: whether to ignore identity constraint errors
protected static String
ID_IDREF_CHECKING
Feature identifier: whether to ignore ID/IDREF errors
protected static String
IGNORE_XSI_TYPE
Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered
protected static String
JAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language / DOM schema-type.
protected static String
JAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source/ DOM schema-location.
protected static String
LOAD_EXTERNAL_DTD
Feature identifier: load external DTD.
protected static String
NAMESPACES
Feature identifier: namespaces.
protected static String
NAMESPACE_BINDER
Property identifier: namespace binder.
protected static String
NORMALIZE_DATA
Feature identifier: expose schema normalized value
protected static String
NOTIFY_BUILTIN_REFS
Feature identifier: notify built-in refereces.
protected static String
NOTIFY_CHAR_REFS
Feature identifier: notify character refereces.
protected static boolean
PRINT_EXCEPTION_STACK_TRACE
Set to true and recompile to print exception stack trace.
protected static String
ROOT_TYPE_DEF
Property identifier: root type definition.
protected static String
SCHEMA_AUGMENT_PSVI
Feature identifier: augment PSVI
protected static String
SCHEMA_ELEMENT_DEFAULT
Feature identifier: send element default value via characters()
protected static String
SCHEMA_LOCATION
Property identifier: schema location.
protected static String
SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.
protected static String
SCHEMA_VALIDATOR
Property identifier: XML Schema validator.
protected static String
SYMBOL_TABLE
Property identifier: symbol table.
protected static String
UNPARSED_ENTITY_CHECKING
Feature identifier: whether to ignore unparsed entity errors
protected static String
USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only
protected static String
VALIDATE_ANNOTATIONS
Feature identifier: validate annotations
protected static String
VALIDATION
Feature identifier: validation.
protected static String
VALIDATION_MANAGER
protected static String
WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attribute definition.
protected static String
WARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate entity definition.
protected static String
WARN_ON_UNDECLARED_ELEMDEF
Feature identifier: warn on undeclared element definition.
protected static String
XML11_DATATYPE_VALIDATOR_FACTORY
protected static String
XMLGRAMMAR_POOL
Property identifier: grammar pool.
protected static String
XMLSCHEMA_FULL_CHECKING
feature identifier: XML Schema validation -- full checking
protected static String
XMLSCHEMA_VALIDATION
feature identifier: XML Schema validation
protected static String
XML_STRING
Property identifier: xml string.
protected ArrayList
fCommonComponents
Common components: XMLEntityManager, XMLErrorReporter, XMLSchemaValidator
protected ArrayList
fComponents
XML 1.0 Components.
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 org.apache.xerces.xni.parser.XMLDTDScanner
fCurrentDTDScanner
Current DTD scanner.
protected DTDDVFactory
fCurrentDVFactory
Current Datatype validator factory.
protected org.apache.xerces.xni.parser.XMLDocumentScanner
fCurrentScanner
Current scanner
protected org.apache.xerces.xni.XMLDTDContentModelHandler
fDTDContentModelHandler
The DTD content model handler.
protected org.apache.xerces.xni.XMLDTDHandler
fDTDHandler
The DTD handler.
protected XMLDTDProcessor
fDTDProcessor
The XML 1.0 DTD Processor .
protected org.apache.xerces.xni.parser.XMLDTDScanner
fDTDScanner
The XML 1.0 DTD scanner.
protected XMLDTDValidator
fDTDValidator
The XML 1.0 DTD Validator: binds namespaces
protected DTDDVFactory
fDatatypeValidatorFactory
The XML 1.0 Datatype validator factory.
protected org.apache.xerces.xni.XMLDocumentHandler
fDocumentHandler
The document handler.
protected XMLEntityManager
fEntityManager
Entity manager.
protected XMLErrorReporter
fErrorReporter
Error reporter.
protected org.apache.xerces.xni.grammars.XMLGrammarPool
fGrammarPool
Grammar pool.
protected org.apache.xerces.xni.parser.XMLInputSource
fInputSource
protected org.apache.xerces.xni.parser.XMLDocumentSource
fLastComponent
Last component in the document pipeline
protected Locale
fLocale
protected org.apache.xerces.xni.XMLLocator
fLocator
protected XMLNSDocumentScannerImpl
fNamespaceScanner
The XML 1.0 Document scanner that does namespace binding.
protected XMLDTDValidator
fNonNSDTDValidator
The XML 1.0 DTD Validator that does not bind namespaces
protected XMLDocumentScannerImpl
fNonNSScanner
The XML 1.0 Non-namespace implementation of scanner
protected boolean
fParseInProgress
True if a parse is in progress.
protected XMLSchemaValidator
fSchemaValidator
XML Schema Validator.
protected SymbolTable
fSymbolTable
protected ValidationManager
fValidationManager
protected XMLVersionDetector
fVersionDetector
protected ArrayList
fXML11Components
XML 1.1.
protected XML11DTDProcessor
fXML11DTDProcessor
The XML 1.1 DTD processor.
protected XML11DTDScannerImpl
fXML11DTDScanner
The XML 1.1 DTD scanner.
protected XML11DTDValidator
fXML11DTDValidator
The XML 1.1 DTD validator that does not do namespace binding.
protected DTDDVFactory
fXML11DatatypeFactory
The XML 1.1 datatype factory.
protected XML11DocumentScannerImpl
fXML11DocScanner
The XML 1.1 document scanner that does not do namespace binding.
protected XML11NSDTDValidator
fXML11NSDTDValidator
The XML 1.1 DTD validator that does namespace binding.
protected XML11NSDocumentScannerImpl
fXML11NSDocScanner
The XML 1.1 document scanner that does namespace binding.

Fields inherited from class org.apache.xerces.util.ParserConfigurationSettings

PARSER_SETTINGS, fFeatures, fParentSettings, fProperties, fRecognizedFeatures, fRecognizedProperties

Constructor Summary

XML11Configuration()
Default constructor.
XML11Configuration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
XML11Configuration(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.
XML11Configuration(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool, org.apache.xerces.xni.parser.XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.

Method Summary

protected void
addCommonComponent(org.apache.xerces.xni.parser.XMLComponent component)
Adds common component to the parser configuration.
protected void
addComponent(org.apache.xerces.xni.parser.XMLComponent component)
Adds a component to the parser configuration.
protected void
addRecognizedParamsAndSetDefaults(org.apache.xerces.xni.parser.XMLComponent component)
Adds all of the component's recognized features and properties to the list of default recognized features and properties, and sets default values on the configuration for features and properties which were previously absent from the configuration.
protected void
addXML11Component(org.apache.xerces.xni.parser.XMLComponent component)
Adds an XML 1.1 component to the parser configuration.
protected void
checkFeature(String featureId)
Check a feature.
protected void
checkProperty(String propertyId)
Check a property.
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.
protected void
configurePipeline()
Configures the pipeline.
protected void
configureXML11Pipeline()
Configures the XML 1.1 pipeline.
org.apache.xerces.xni.XMLDTDContentModelHandler
getDTDContentModelHandler()
Returns the registered DTD content model handler.
org.apache.xerces.xni.XMLDTDHandler
getDTDHandler()
Returns the registered DTD handler.
org.apache.xerces.xni.XMLDocumentHandler
getDocumentHandler()
Returns the registered document handler.
org.apache.xerces.xni.parser.XMLEntityResolver
getEntityResolver()
Return the current entity resolver.
org.apache.xerces.xni.parser.XMLErrorHandler
getErrorHandler()
Return the current error handler.
boolean
getFeature(String featureId)
Returns the state of a feature.
Locale
getLocale()
Returns the locale.
boolean
parse(boolean complete)
void
parse(org.apache.xerces.xni.parser.XMLInputSource source)
Parses the specified input source.
protected void
reset()
reset all XML 1.0 components before parsing and namespace context
protected void
resetCommon()
reset all common components before parsing
protected void
resetXML11()
reset all components before parsing and namespace context
void
setDTDContentModelHandler(org.apache.xerces.xni.XMLDTDContentModelHandler handler)
Sets the DTD content model handler.
void
setDTDHandler(org.apache.xerces.xni.XMLDTDHandler dtdHandler)
Sets the DTD handler.
void
setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler on the last component in the pipeline to receive information about the document.
void
setEntityResolver(org.apache.xerces.xni.parser.XMLEntityResolver resolver)
Sets the resolver used to resolve external entities.
void
setErrorHandler(org.apache.xerces.xni.parser.XMLErrorHandler errorHandler)
Allow an application to register an error event handler.
void
setFeature(String featureId, boolean state)
Set the state of a feature.
void
setInputSource(org.apache.xerces.xni.parser.XMLInputSource inputSource)
Sets the input source for the document to parse.
void
setLocale(Locale locale)
Set the locale to use for messages.
void
setProperty(String propertyId, Object value)
setProperty

Methods inherited from class org.apache.xerces.util.ParserConfigurationSettings

addRecognizedFeatures, addRecognizedProperties, checkFeature, checkProperty, getFeature, getProperty, setFeature, setProperty

Field Details

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.

ENTITY_RESOLVER

protected static final String ENTITY_RESOLVER
Property identifier: entity resolver.

ERROR_HANDLER

protected static final String ERROR_HANDLER
Property identifier: error handler.

ERROR_REPORTER

protected static final String ERROR_REPORTER
Property identifier: error reporter.

EXTERNAL_GENERAL_ENTITIES

protected static final String EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities.

EXTERNAL_PARAMETER_ENTITIES

protected static final String EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities.

GENERATE_SYNTHETIC_ANNOTATIONS

protected static final String GENERATE_SYNTHETIC_ANNOTATIONS
Feature: generate synthetic annotations

HONOUR_ALL_SCHEMALOCATIONS

protected static final String HONOUR_ALL_SCHEMALOCATIONS
Feature identifier: honour all schemaLocations

IDENTITY_CONSTRAINT_CHECKING

protected static final String IDENTITY_CONSTRAINT_CHECKING
Feature identifier: whether to ignore identity constraint errors

ID_IDREF_CHECKING

protected static final String ID_IDREF_CHECKING
Feature identifier: whether to ignore ID/IDREF errors

IGNORE_XSI_TYPE

protected static final String IGNORE_XSI_TYPE
Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered

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.

NAMESPACES

protected static final String NAMESPACES
Feature identifier: namespaces.

NAMESPACE_BINDER

protected static final String NAMESPACE_BINDER
Property identifier: namespace binder.

NORMALIZE_DATA

protected static final String NORMALIZE_DATA
Feature identifier: expose schema normalized value

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.
Field Value:
false

ROOT_TYPE_DEF

protected static final String ROOT_TYPE_DEF
Property identifier: root type definition.

SCHEMA_AUGMENT_PSVI

protected static final String SCHEMA_AUGMENT_PSVI
Feature identifier: augment PSVI

SCHEMA_ELEMENT_DEFAULT

protected static final String SCHEMA_ELEMENT_DEFAULT
Feature identifier: send element default value via characters()

SCHEMA_LOCATION

protected static final String SCHEMA_LOCATION
Property identifier: schema location.

SCHEMA_NONS_LOCATION

protected static final String SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.

SCHEMA_VALIDATOR

protected static final String SCHEMA_VALIDATOR
Property identifier: XML Schema validator.

SYMBOL_TABLE

protected static final String SYMBOL_TABLE
Property identifier: symbol table.

UNPARSED_ENTITY_CHECKING

protected static final String UNPARSED_ENTITY_CHECKING
Feature identifier: whether to ignore unparsed entity errors

USE_GRAMMAR_POOL_ONLY

protected static final String USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only

VALIDATE_ANNOTATIONS

protected static final String VALIDATE_ANNOTATIONS
Feature identifier: validate annotations

VALIDATION

protected static final String VALIDATION
Feature identifier: validation.

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.

XML11_DATATYPE_VALIDATOR_FACTORY

protected static final String XML11_DATATYPE_VALIDATOR_FACTORY

XMLGRAMMAR_POOL

protected static final String XMLGRAMMAR_POOL
Property identifier: grammar pool.

XMLSCHEMA_FULL_CHECKING

protected static final String XMLSCHEMA_FULL_CHECKING
feature identifier: XML Schema validation -- full checking

XMLSCHEMA_VALIDATION

protected static final String XMLSCHEMA_VALIDATION
feature identifier: XML Schema validation

XML_STRING

protected static final String XML_STRING
Property identifier: xml string.

fCommonComponents

protected ArrayList fCommonComponents
Common components: XMLEntityManager, XMLErrorReporter, XMLSchemaValidator

fComponents

protected ArrayList fComponents
XML 1.0 Components.

fConfigUpdated

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.

fCurrentDTDScanner

protected org.apache.xerces.xni.parser.XMLDTDScanner fCurrentDTDScanner
Current DTD scanner.

fCurrentDVFactory

protected DTDDVFactory fCurrentDVFactory
Current Datatype validator factory.

fCurrentScanner

protected org.apache.xerces.xni.parser.XMLDocumentScanner fCurrentScanner
Current scanner

fDTDContentModelHandler

protected org.apache.xerces.xni.XMLDTDContentModelHandler fDTDContentModelHandler
The DTD content model handler.

fDTDHandler

protected org.apache.xerces.xni.XMLDTDHandler fDTDHandler
The DTD handler.

fDTDProcessor

protected XMLDTDProcessor fDTDProcessor
The XML 1.0 DTD Processor .

fDTDScanner

protected org.apache.xerces.xni.parser.XMLDTDScanner fDTDScanner
The XML 1.0 DTD scanner.

fDTDValidator

protected XMLDTDValidator fDTDValidator
The XML 1.0 DTD Validator: binds namespaces

fDatatypeValidatorFactory

protected DTDDVFactory fDatatypeValidatorFactory
The XML 1.0 Datatype validator factory.

fDocumentHandler

protected org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler
The document handler.

fEntityManager

protected XMLEntityManager fEntityManager
Entity manager.

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter.

fGrammarPool

protected org.apache.xerces.xni.grammars.XMLGrammarPool fGrammarPool
Grammar pool.

fInputSource

protected org.apache.xerces.xni.parser.XMLInputSource fInputSource

fLastComponent

protected org.apache.xerces.xni.parser.XMLDocumentSource fLastComponent
Last component in the document pipeline

fLocale

protected Locale fLocale

fLocator

protected org.apache.xerces.xni.XMLLocator fLocator

fNamespaceScanner

protected XMLNSDocumentScannerImpl fNamespaceScanner
The XML 1.0 Document scanner that does namespace binding.

fNonNSDTDValidator

protected XMLDTDValidator fNonNSDTDValidator
The XML 1.0 DTD Validator that does not bind namespaces

fNonNSScanner

protected XMLDocumentScannerImpl fNonNSScanner
The XML 1.0 Non-namespace implementation of scanner

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

fSchemaValidator

protected XMLSchemaValidator fSchemaValidator
XML Schema Validator.

fSymbolTable

protected SymbolTable fSymbolTable

fValidationManager

protected ValidationManager fValidationManager

fVersionDetector

protected XMLVersionDetector fVersionDetector

fXML11Components

protected ArrayList fXML11Components
XML 1.1. Components.

fXML11DTDProcessor

protected XML11DTDProcessor fXML11DTDProcessor
The XML 1.1 DTD processor. *

fXML11DTDScanner

protected XML11DTDScannerImpl fXML11DTDScanner
The XML 1.1 DTD scanner. *

fXML11DTDValidator

protected XML11DTDValidator fXML11DTDValidator
The XML 1.1 DTD validator that does not do namespace binding. *

fXML11DatatypeFactory

protected DTDDVFactory fXML11DatatypeFactory
The XML 1.1 datatype factory. *

fXML11DocScanner

protected XML11DocumentScannerImpl fXML11DocScanner
The XML 1.1 document scanner that does not do namespace binding. *

fXML11NSDTDValidator

protected XML11NSDTDValidator fXML11NSDTDValidator
The XML 1.1 DTD validator that does namespace binding. *

fXML11NSDocScanner

protected XML11NSDocumentScannerImpl fXML11NSDocScanner
The XML 1.1 document scanner that does namespace binding. *

Constructor Details

XML11Configuration

public XML11Configuration()
Default constructor.

XML11Configuration

public XML11Configuration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
Parameters:
symbolTable - The symbol table to use.

XML11Configuration

public XML11Configuration(SymbolTable symbolTable,
                          org.apache.xerces.xni.grammars.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.

XML11Configuration

public XML11Configuration(SymbolTable symbolTable,
                          org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool,
                          org.apache.xerces.xni.parser.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 Details

addCommonComponent

protected void addCommonComponent(org.apache.xerces.xni.parser.XMLComponent component)
Adds common component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.
Parameters:
component - The component to add.

addComponent

protected void addComponent(org.apache.xerces.xni.parser.XMLComponent component)
Adds a component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.
Parameters:
component - The component to add.

addRecognizedParamsAndSetDefaults

protected void addRecognizedParamsAndSetDefaults(org.apache.xerces.xni.parser.XMLComponent component)
Adds all of the component's recognized features and properties to the list of default recognized features and properties, and sets default values on the configuration for features and properties which were previously absent from the configuration.
Parameters:
component - The component whose recognized features and properties will be added to the configuration

addXML11Component

protected void addXML11Component(org.apache.xerces.xni.parser.XMLComponent component)
Adds an XML 1.1 component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.
Parameters:
component - The component to add.

checkFeature

protected void checkFeature(String featureId)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.
Overrides:
checkFeature in interface ParserConfigurationSettings
Parameters:
featureId - The unique identifier (URI) of the feature.
Throws:
org.apache.xerces.xni.parser.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)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Check a property. If the property is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.
Overrides:
checkProperty in interface ParserConfigurationSettings
Parameters:
propertyId - The unique identifier (URI) of the property being set.
Throws:
org.apache.xerces.xni.parser.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.
Specified by:
cleanup in interface org.apache.xerces.xni.parser.XMLPullParserConfiguration

configurePipeline

protected void configurePipeline()
Configures the pipeline.

configureXML11Pipeline

protected void configureXML11Pipeline()
Configures the XML 1.1 pipeline. Note: this method also resets the new XML11 components.

getDTDContentModelHandler

public org.apache.xerces.xni.XMLDTDContentModelHandler getDTDContentModelHandler()
Returns the registered DTD content model handler.
Specified by:
getDTDContentModelHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

getDTDHandler

public org.apache.xerces.xni.XMLDTDHandler getDTDHandler()
Returns the registered DTD handler.
Specified by:
getDTDHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

getDocumentHandler

public org.apache.xerces.xni.XMLDocumentHandler getDocumentHandler()
Returns the registered document handler.
Specified by:
getDocumentHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

getEntityResolver

public org.apache.xerces.xni.parser.XMLEntityResolver getEntityResolver()
Return the current entity resolver.
Specified by:
getEntityResolver in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Returns:
The current entity resolver, or null if none has been registered.

getErrorHandler

public org.apache.xerces.xni.parser.XMLErrorHandler getErrorHandler()
Return the current error handler.
Specified by:
getErrorHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Returns:
The current error handler, or null if none has been registered.

getFeature

public boolean getFeature(String featureId)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Returns the state of a feature.
Specified by:
getFeature in interface org.apache.xerces.xni.parser.XMLParserConfiguration
getFeature in interface org.apache.xerces.xni.parser.XMLComponentManager
Overrides:
getFeature in interface ParserConfigurationSettings
Parameters:
featureId - The feature identifier.
Returns:
true if the feature is supported
Throws:
org.apache.xerces.xni.parser.XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

getLocale

public Locale getLocale()
Returns the locale.
Specified by:
getLocale in interface org.apache.xerces.xni.parser.XMLParserConfiguration

parse

public boolean parse(boolean complete)
            throws org.apache.xerces.xni.XNIException,
                   IOException
Specified by:
parse in interface org.apache.xerces.xni.parser.XMLPullParserConfiguration

parse

public void parse(org.apache.xerces.xni.parser.XMLInputSource source)
            throws org.apache.xerces.xni.XNIException,
                   IOException
Parses the specified input source.
Specified by:
parse in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
source - The input source.
Throws:
org.apache.xerces.xni.XNIException - Throws exception on XNI error.

reset

protected void reset()
            throws org.apache.xerces.xni.XNIException
reset all XML 1.0 components before parsing and namespace context

resetCommon

protected void resetCommon()
            throws org.apache.xerces.xni.XNIException
reset all common components before parsing

resetXML11

protected void resetXML11()
            throws org.apache.xerces.xni.XNIException
reset all components before parsing and namespace context

setDTDContentModelHandler

public void setDTDContentModelHandler(org.apache.xerces.xni.XMLDTDContentModelHandler handler)
Sets the DTD content model handler.
Specified by:
setDTDContentModelHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
handler - The DTD content model handler.

setDTDHandler

public void setDTDHandler(org.apache.xerces.xni.XMLDTDHandler dtdHandler)
Sets the DTD handler.
Specified by:
setDTDHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
dtdHandler - The DTD handler.

setDocumentHandler

public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler on the last component in the pipeline to receive information about the document.
Specified by:
setDocumentHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
documentHandler - The document handler.

setEntityResolver

public void setEntityResolver(org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
resolver - The new entity resolver. Passing a null value will uninstall the currently installed resolver.

setErrorHandler

public void setErrorHandler(org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
errorHandler - The error handler.

setFeature

public void setFeature(String featureId,
                       boolean state)
            throws org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLParserConfiguration
Overrides:
setFeature in interface ParserConfigurationSettings
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.

setInputSource

public void setInputSource(org.apache.xerces.xni.parser.XMLInputSource inputSource)
            throws org.apache.xerces.xni.parser.XMLConfigurationException,
                   IOException
Sets the input source for the document to parse.
Specified by:
setInputSource in interface org.apache.xerces.xni.parser.XMLPullParserConfiguration
Parameters:
inputSource - The document's input source.
Throws:
org.apache.xerces.xni.parser.XMLConfigurationException - Thrown if there is a configuration error when initializing the parser.

setLocale

public void setLocale(Locale locale)
            throws org.apache.xerces.xni.XNIException
Set the locale to use for messages.
Specified by:
setLocale in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Parameters:
locale - The locale object to use for localization of messages.
Throws:
org.apache.xerces.xni.XNIException - Thrown if the parser does not support the specified locale.

setProperty

public void setProperty(String propertyId,
                        Object value)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
setProperty
Specified by:
setProperty in interface org.apache.xerces.xni.parser.XMLParserConfiguration
Overrides:
setProperty in interface ParserConfigurationSettings
Parameters:
propertyId -
value -

Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.