org.apache.xerces.parsers

Class XIncludeAwareParserConfiguration

java.lang.Object

org.apache.xerces.util.ParserConfigurationSettings

org.apache.xerces.parsers.XML11Configuration

org.apache.xerces.parsers.XIncludeAwareParserConfiguration

All Implemented Interfaces:

XML11Configurable, XMLComponentManager, XMLParserConfiguration, XMLPullParserConfiguration

Direct Known Subclasses:

SecurityConfiguration, SoftReferenceSymbolTableConfiguration, XMLGrammarCachingConfiguration

public class XIncludeAwareParserConfiguration
extends XML11Configuration

This class is the configuration used to parse XML 1.0 and XML 1.1 documents and provides support for XInclude. This is the default Xerces configuration.

Version:

$Id$

Author:

Michael Glavassevich, IBM

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALLOW_UE_AND_NOTATION_EVENTS Feature identifier: allow notation and unparsed entity events to be sent out of order.
protected NamespaceContext	fCurrentNSContext Current NamespaceContext.
protected NamespaceSupport	fNonXIncludeNSContext Non-XInclude NamespaceContext.
protected boolean	fXIncludeEnabled Flag indicating whether XInclude processsing is enabled.
protected XIncludeHandler	fXIncludeHandler XInclude handler.
protected XIncludeNamespaceSupport	fXIncludeNSContext XInclude NamespaceContext.
protected static String	NAMESPACE_CONTEXT Property identifier: error reporter.
protected static String	XINCLUDE_FEATURE Feature identifier: XInclude processing
protected static String	XINCLUDE_FIXUP_BASE_URIS Feature identifier: fixup base URIs.
protected static String	XINCLUDE_FIXUP_LANGUAGE Feature identifier: fixup language.
protected static String	XINCLUDE_HANDLER Property identifier: XInclude handler.

Fields inherited from class org.apache.xerces.parsers.XML11Configuration

ALLOW_JAVA_ENCODINGS, CONTINUE_AFTER_FATAL_ERROR, DATATYPE_VALIDATOR_FACTORY, DOCUMENT_SCANNER, DTD_PROCESSOR, DTD_SCANNER, DTD_VALIDATOR, ENTITY_MANAGER, ENTITY_RESOLVER, ERROR_HANDLER, ERROR_REPORTER, EXTERNAL_GENERAL_ENTITIES, EXTERNAL_PARAMETER_ENTITIES, fCommonComponents, fComponents, fConfigUpdated, fCurrentDTDScanner, fCurrentDVFactory, fCurrentScanner, fDatatypeValidatorFactory, fDocumentHandler, fDTDContentModelHandler, fDTDHandler, fDTDProcessor, fDTDScanner, fDTDValidator, fEntityManager, fErrorReporter, fGrammarPool, fInputSource, fLastComponent, fLocale, fNamespaceScanner, fNonNSDTDValidator, fNonNSScanner, fParseInProgress, fSchemaValidator, fSymbolTable, fValidationManager, fVersionDetector, fXML11Components, fXML11DatatypeFactory, fXML11DocScanner, fXML11DTDProcessor, fXML11DTDScanner, fXML11DTDValidator, fXML11NSDocScanner, fXML11NSDTDValidator, GENERATE_SYNTHETIC_ANNOTATIONS, HONOUR_ALL_SCHEMALOCATIONS, ID_IDREF_CHECKING, IDENTITY_CONSTRAINT_CHECKING, IGNORE_XSI_TYPE, JAXP_SCHEMA_LANGUAGE, JAXP_SCHEMA_SOURCE, LOAD_EXTERNAL_DTD, LOCALE, NAMESPACE_BINDER, NAMESPACE_GROWTH, NAMESPACES, NORMALIZE_DATA, NOTIFY_BUILTIN_REFS, NOTIFY_CHAR_REFS, PRINT_EXCEPTION_STACK_TRACE, ROOT_ELEMENT_DECL, ROOT_TYPE_DEF, SCHEMA_AUGMENT_PSVI, SCHEMA_DV_FACTORY, SCHEMA_ELEMENT_DEFAULT, SCHEMA_LOCATION, SCHEMA_NONS_LOCATION, SCHEMA_VALIDATOR, SYMBOL_TABLE, TOLERATE_DUPLICATES, UNPARSED_ENTITY_CHECKING, USE_GRAMMAR_POOL_ONLY, VALIDATE_ANNOTATIONS, VALIDATION, VALIDATION_MANAGER, WARN_ON_DUPLICATE_ATTDEF, WARN_ON_DUPLICATE_ENTITYDEF, WARN_ON_UNDECLARED_ELEMDEF, XML_STRING, XML11_DATATYPE_VALIDATOR_FACTORY, XMLGRAMMAR_POOL, XMLSCHEMA_FULL_CHECKING, XMLSCHEMA_VALIDATION

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

fFeatures, fParentSettings, fProperties, fRecognizedFeatures, fRecognizedProperties, PARSER_SETTINGS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	configurePipeline() Configures the pipeline.
protected void	configureXML11Pipeline() Configures the XML 1.1 pipeline.
boolean	getFeature(String featureId) Returns the state of a feature.
void	setFeature(String featureId, boolean state) Set the state of a feature.

Methods inherited from class org.apache.xerces.parsers.XML11Configuration

addCommonComponent, addComponent, addRecognizedParamsAndSetDefaults, addXML11Component, checkFeature, checkProperty, cleanup, getDocumentHandler, getDTDContentModelHandler, getDTDHandler, getEntityResolver, getErrorHandler, getLocale, getProperty, parse, parse, reset, resetCommon, resetXML11, setDocumentHandler, setDTDContentModelHandler, setDTDHandler, setEntityResolver, setErrorHandler, setInputSource, setLocale, setProperty

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

addRecognizedFeatures, addRecognizedProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.xerces.xni.parser.XMLParserConfiguration

addRecognizedFeatures, addRecognizedProperties

Field Detail

ALLOW_UE_AND_NOTATION_EVENTS

protected static final String ALLOW_UE_AND_NOTATION_EVENTS

Feature identifier: allow notation and unparsed entity events to be sent out of order.

See Also:

Constant Field Values

XINCLUDE_FIXUP_BASE_URIS

protected static final String XINCLUDE_FIXUP_BASE_URIS

Feature identifier: fixup base URIs.

See Also:

Constant Field Values

XINCLUDE_FIXUP_LANGUAGE

protected static final String XINCLUDE_FIXUP_LANGUAGE

Feature identifier: fixup language.

See Also:

Constant Field Values

XINCLUDE_FEATURE

protected static final String XINCLUDE_FEATURE

Feature identifier: XInclude processing

See Also:

Constant Field Values

XINCLUDE_HANDLER

protected static final String XINCLUDE_HANDLER

Property identifier: XInclude handler.

See Also:

Constant Field Values

NAMESPACE_CONTEXT

protected static final String NAMESPACE_CONTEXT

Property identifier: error reporter.

See Also:

Constant Field Values

fXIncludeHandler

protected XIncludeHandler fXIncludeHandler

XInclude handler.

fNonXIncludeNSContext

protected NamespaceSupport fNonXIncludeNSContext

Non-XInclude NamespaceContext.

fXIncludeNSContext

protected XIncludeNamespaceSupport fXIncludeNSContext

XInclude NamespaceContext.

fCurrentNSContext

protected NamespaceContext fCurrentNSContext

Current NamespaceContext.

fXIncludeEnabled

protected boolean fXIncludeEnabled

Flag indicating whether XInclude processsing is enabled.

Constructor Detail

XIncludeAwareParserConfiguration

public XIncludeAwareParserConfiguration()

Default constructor.

XIncludeAwareParserConfiguration

public XIncludeAwareParserConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters:

symbolTable - The symbol table to use.

XIncludeAwareParserConfiguration

public XIncludeAwareParserConfiguration(SymbolTable symbolTable,
                                        XMLGrammarPool grammarPool)

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

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

XIncludeAwareParserConfiguration

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

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

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

parentSettings - The parent settings.

Method Detail

configurePipeline

protected void configurePipeline()

Configures the pipeline.

Overrides:

configurePipeline in class XML11Configuration

configureXML11Pipeline

protected void configureXML11Pipeline()

Description copied from class: XML11Configuration

Configures the XML 1.1 pipeline. Note: this method also resets the new XML11 components.

Overrides:

configureXML11Pipeline in class XML11Configuration

getFeature

public boolean getFeature(String featureId)
                   throws XMLConfigurationException

Description copied from class: XML11Configuration

Returns the state of a feature.

Specified by:

getFeature in interface XMLComponentManager

Specified by:

getFeature in interface XMLParserConfiguration

Overrides:

getFeature in class XML11Configuration

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(String featureId,
                       boolean state)
                throws XMLConfigurationException

Description copied from class: XML11Configuration

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 XML11Configuration

Parameters:

featureId - The unique identifier (URI) of the feature.

state - The requested state of the feature (true or false).

Throws:

XMLConfigurationException - Thrown if there is a configuration error.