Top Description Fields Constructors Methods

org.apache.xerces.parsers

public Class XIncludeAwareParserConfiguration

Class Inheritance

java.lang.Object
org.apache.xerces.util.ParserConfigurationSettings
org.apache.xerces.parsers.XML11Configuration
org.apache.xerces.parsers.XIncludeAwareParserConfiguration

Known Direct Subclasses

org.apache.xerces.parsers.XMLGrammarCachingConfiguration, org.apache.xerces.parsers.SecureProcessingConfiguration, org.apache.xerces.parsers.SecurityConfiguration, org.apache.xerces.parsers.SoftReferenceSymbolTableConfiguration

Imports

org.apache.xerces.impl.Constants, org.apache.xerces.util.NamespaceSupport, .SymbolTable, org.apache.xerces.xinclude.XIncludeHandler, .XIncludeNamespaceSupport, org.apache.xerces.xni.NamespaceContext, .XMLDocumentHandler, org.apache.xerces.xni.grammars.XMLGrammarPool, org.apache.xerces.xni.parser.XMLComponentManager, .XMLConfigurationException, .XMLDocumentSource

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.

Author: Michael Glavassevich, IBM
Version: $Id: XIncludeAwareParserConfiguration.java 987475 2010-08-20 12:27:44Z mrglavas $

Field Summary

Modifier and Type	Field and Description
protected static final 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 final String	NAMESPACE_CONTEXT Property identifier: error reporter.
protected static final String	XINCLUDE_FEATURE Feature identifier: XInclude processing
protected static final String	XINCLUDE_FIXUP_BASE_URIS Feature identifier: fixup base URIs.
protected static final String	XINCLUDE_FIXUP_LANGUAGE Feature identifier: fixup language.
protected static final String	XINCLUDE_HANDLER Property identifier: XInclude handler.

Inherited from 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 XML11_DATATYPE_VALIDATOR_FACTORY XML_STRING XMLGRAMMAR_POOL XMLSCHEMA_FULL_CHECKING XMLSCHEMA_VALIDATION

Constructor Summary

Access	Constructor and Description
public	XIncludeAwareParserConfiguration() Default constructor.
public	XIncludeAwareParserConfiguration(SymbolTable The symbol table to use. symbolTable) Constructs a parser configuration using the specified symbol table.
public	XIncludeAwareParserConfiguration(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	XIncludeAwareParserConfiguration(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 Type	Method and Description
protected void	configurePipeline() Overrides org.apache.xerces.parsers.XML11Configuration.configurePipeline. Configures the pipeline.
protected void	configureXML11Pipeline() Overrides org.apache.xerces.parsers.XML11Configuration.configureXML11Pipeline. Configures the XML 1.1 pipeline.
public boolean	getFeature(String The feature identifier. featureId) Overrides org.apache.xerces.parsers.XML11Configuration.getFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.getFeature. Returns the state of a feature.
public void	setFeature(String The unique identifier (URI) of the feature. featureId, boolean The requested state of the feature (true or false). state) Overrides org.apache.xerces.parsers.XML11Configuration.setFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setFeature. Set the state of a feature.

Field Detail

ALLOW_UE_AND_NOTATION_EVENTS	back to summary
protected static final String ALLOW_UE_AND_NOTATION_EVENTS Feature identifier: allow notation and unparsed entity events to be sent out of order.

fCurrentNSContext	back to summary
protected NamespaceContext fCurrentNSContext Current NamespaceContext.

fNonXIncludeNSContext	back to summary
protected NamespaceSupport fNonXIncludeNSContext Non-XInclude NamespaceContext.

fXIncludeEnabled	back to summary
protected boolean fXIncludeEnabled Flag indicating whether XInclude processsing is enabled.

fXIncludeHandler	back to summary
protected XIncludeHandler fXIncludeHandler XInclude handler.

fXIncludeNSContext	back to summary
protected XIncludeNamespaceSupport fXIncludeNSContext XInclude NamespaceContext.

NAMESPACE_CONTEXT	back to summary
protected static final String NAMESPACE_CONTEXT Property identifier: error reporter.

XINCLUDE_FEATURE	back to summary
protected static final String XINCLUDE_FEATURE Feature identifier: XInclude processing

XINCLUDE_FIXUP_BASE_URIS	back to summary
protected static final String XINCLUDE_FIXUP_BASE_URIS Feature identifier: fixup base URIs.

XINCLUDE_FIXUP_LANGUAGE	back to summary
protected static final String XINCLUDE_FIXUP_LANGUAGE Feature identifier: fixup language.

XINCLUDE_HANDLER	back to summary
protected static final String XINCLUDE_HANDLER Property identifier: XInclude handler.

Constructor Detail

XIncludeAwareParserConfiguration	back to summary
public XIncludeAwareParserConfiguration() Default constructor.

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

XIncludeAwareParserConfiguration

back to summary

public XIncludeAwareParserConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters

symbolTable:SymbolTable: The symbol table to use.

XIncludeAwareParserConfiguration	back to summary
public XIncludeAwareParserConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool) Constructs a parser configuration using the specified symbol table and grammar pool. Parameters symbolTable:SymbolTable The symbol table to use. grammarPool:XMLGrammarPool The grammar pool to use.

XIncludeAwareParserConfiguration

back to summary

public XIncludeAwareParserConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool)

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

Parameters

symbolTable:SymbolTable: The symbol table to use.
grammarPool:XMLGrammarPool: The grammar pool to use.

XIncludeAwareParserConfiguration	back to summary
public XIncludeAwareParserConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings) Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings. Parameters symbolTable:SymbolTable The symbol table to use. grammarPool:XMLGrammarPool The grammar pool to use. parentSettings:XMLComponentManager The parent settings.

XIncludeAwareParserConfiguration

back to summary

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

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

Parameters

symbolTable:SymbolTable: The symbol table to use.
grammarPool:XMLGrammarPool: The grammar pool to use.
parentSettings:XMLComponentManager: The parent settings.

Method Detail

configurePipeline	back to summary
protected void configurePipeline() Overrides org.apache.xerces.parsers.XML11Configuration.configurePipeline. Configures the pipeline.

configurePipeline

back to summary

protected void configurePipeline()

Overrides org.apache.xerces.parsers.XML11Configuration.configurePipeline.

Configures the pipeline.

configureXML11Pipeline	back to summary
protected void configureXML11Pipeline() Overrides org.apache.xerces.parsers.XML11Configuration.configureXML11Pipeline. Doc from org.apache.xerces.parsers.XML11Configuration.configureXML11Pipeline. Configures the XML 1.1 pipeline. Note this method also resets the new XML11 components.

configureXML11Pipeline

back to summary

protected void configureXML11Pipeline()

Overrides org.apache.xerces.parsers.XML11Configuration.configureXML11Pipeline.

Doc from org.apache.xerces.parsers.XML11Configuration.configureXML11Pipeline.

Configures the XML 1.1 pipeline.

Note

this method also resets the new XML11 components.

getFeature	back to summary
public boolean getFeature(String featureId) throws XMLConfigurationException Overrides org.apache.xerces.parsers.XML11Configuration.getFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.getFeature. Doc from org.apache.xerces.parsers.XML11Configuration.getFeature. Returns the state of a feature. Parameters featureId:String The feature identifier. Returns:boolean true if the feature is supported Exceptions XMLConfigurationException: Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

getFeature

back to summary

public boolean getFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.XML11Configuration.getFeature.

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

Doc from org.apache.xerces.parsers.XML11Configuration.getFeature.

Returns the state of a feature.

Parameters

featureId:String: The feature identifier.

Returns:boolean

true if the feature is supported

Exceptions

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

setFeature	back to summary
public void setFeature(String featureId, boolean state) throws XMLConfigurationException Overrides org.apache.xerces.parsers.XML11Configuration.setFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setFeature. Doc from org.apache.xerces.parsers.XML11Configuration.setFeature. 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. Parameters featureId:String The unique identifier (URI) of the feature. state:boolean The requested state of the feature (true or false). Exceptions XMLConfigurationException: If the requested feature is not known.

setFeature

back to summary

public void setFeature(String featureId, boolean state) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.XML11Configuration.setFeature.

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

Doc from org.apache.xerces.parsers.XML11Configuration.setFeature.

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.

Parameters

featureId:String: The unique identifier (URI) of the feature.
state:boolean: The requested state of the feature (true or false).

Exceptions

XMLConfigurationException:: If the requested feature is not known.