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

public Class XIncludeParserConfiguration

extends XML11Configuration
Class Inheritance
Imports
org.apache.xerces.impl.Constants, org.apache.xerces.util.SymbolTable, org.apache.xerces.xinclude.XIncludeHandler, .XIncludeNamespaceSupport, org.apache.xerces.xni.XMLDocumentHandler, org.apache.xerces.xni.grammars.XMLGrammarPool, org.apache.xerces.xni.parser.XMLComponentManager, .XMLConfigurationException, .XMLDocumentSource
This parser configuration includes an XIncludeHandler in the pipeline before the schema validator, or as the last component in the pipeline if there is no schema validator. Using this pipeline will enable processing according to the XML Inclusions specification, to the conformance level described in XIncludeHandler.
Author
Peter McCracken, IBM
See Also
org.apache.xerces.xinclude.XIncludeHandler

Field Summary

Modifier and TypeField 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.

private XIncludeHandler
fXIncludeHandler

protected static final String
NAMESPACE_CONTEXT

Property identifier: error reporter.

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: error reporter.

Inherited from org.apache.xerces.parsers.XML11Configuration:
ALLOW_JAVA_ENCODINGSCONTINUE_AFTER_FATAL_ERRORDATATYPE_VALIDATOR_FACTORYDOCUMENT_SCANNERDTD_PROCESSORDTD_SCANNERDTD_VALIDATORENTITY_MANAGERENTITY_RESOLVERERROR_HANDLERERROR_REPORTEREXTERNAL_GENERAL_ENTITIESEXTERNAL_PARAMETER_ENTITIESfCommonComponentsfComponentsfConfigUpdatedfCurrentDTDScannerfCurrentDVFactoryfCurrentScannerfDatatypeValidatorFactoryfDocumentHandlerfDTDContentModelHandlerfDTDHandlerfDTDProcessorfDTDScannerfDTDValidatorfEntityManagerfErrorReporterfGrammarPoolfInputSourcefLastComponentfLocalefNamespaceScannerfNonNSDTDValidatorfNonNSScannerfParseInProgressfSchemaValidatorfSymbolTablefValidationManagerfVersionDetectorfXML11ComponentsfXML11DatatypeFactoryfXML11DocScannerfXML11DTDProcessorfXML11DTDScannerfXML11DTDValidatorfXML11NSDocScannerfXML11NSDTDValidatorGENERATE_SYNTHETIC_ANNOTATIONSHONOUR_ALL_SCHEMALOCATIONSID_IDREF_CHECKINGIDENTITY_CONSTRAINT_CHECKINGIGNORE_XSI_TYPEJAXP_SCHEMA_LANGUAGEJAXP_SCHEMA_SOURCELOAD_EXTERNAL_DTDLOCALENAMESPACE_BINDERNAMESPACE_GROWTHNAMESPACESNORMALIZE_DATANOTIFY_BUILTIN_REFSNOTIFY_CHAR_REFSPRINT_EXCEPTION_STACK_TRACEROOT_ELEMENT_DECLROOT_TYPE_DEFSCHEMA_AUGMENT_PSVISCHEMA_DV_FACTORYSCHEMA_ELEMENT_DEFAULTSCHEMA_LOCATIONSCHEMA_NONS_LOCATIONSCHEMA_VALIDATORSYMBOL_TABLETOLERATE_DUPLICATESUNPARSED_ENTITY_CHECKINGUSE_GRAMMAR_POOL_ONLYVALIDATE_ANNOTATIONSVALIDATIONVALIDATION_MANAGERWARN_ON_DUPLICATE_ATTDEFWARN_ON_DUPLICATE_ENTITYDEFWARN_ON_UNDECLARED_ELEMDEFXML11_DATATYPE_VALIDATOR_FACTORYXML_STRINGXMLGRAMMAR_POOLXMLSCHEMA_FULL_CHECKINGXMLSCHEMA_VALIDATION

Constructor Summary

AccessConstructor and Description
public
XIncludeParserConfiguration()

Default constructor.

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

Constructs a parser configuration using the specified symbol table.

public
XIncludeParserConfiguration(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
XIncludeParserConfiguration(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
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 void
setProperty(String propertyId, Object value)

Overrides org.apache.xerces.parsers.XML11Configuration.setProperty.

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

setProperty
Inherited from org.apache.xerces.parsers.XML11Configuration:
addCommonComponentaddComponentaddRecognizedParamsAndSetDefaultsaddXML11ComponentcheckFeaturecheckPropertycleanupgetDocumentHandlergetDTDContentModelHandlergetDTDHandlergetEntityResolvergetErrorHandlergetFeaturegetFeature0getLocalegetPropertyparseparseresetresetCommonresetXML11setDocumentHandlersetDTDContentModelHandlersetDTDHandlersetEntityResolversetErrorHandlersetFeaturesetInputSourcesetLocale

Field Detail

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

fXIncludeHandlerback to summary
private XIncludeHandler fXIncludeHandler
NAMESPACE_CONTEXTback to summary
protected static final String NAMESPACE_CONTEXT

Property identifier: error reporter.

XINCLUDE_FIXUP_BASE_URISback to summary
protected static final String XINCLUDE_FIXUP_BASE_URIS

Feature identifier: fixup base URIs.

XINCLUDE_FIXUP_LANGUAGEback to summary
protected static final String XINCLUDE_FIXUP_LANGUAGE

Feature identifier: fixup language.

XINCLUDE_HANDLERback to summary
protected static final String XINCLUDE_HANDLER

Property identifier: error reporter.

Constructor Detail

XIncludeParserConfigurationback to summary
public XIncludeParserConfiguration()

Default constructor.

XIncludeParserConfigurationback to summary
public XIncludeParserConfiguration(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters
symbolTable:SymbolTable

The symbol table to use.

XIncludeParserConfigurationback to summary
public XIncludeParserConfiguration(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.

XIncludeParserConfigurationback to summary
public XIncludeParserConfiguration(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

configurePipelineback to summary
protected void configurePipeline()

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

Configures the pipeline.

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

setPropertyback to summary
public void setProperty(String propertyId, Object value) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.XML11Configuration.setProperty.

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

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

setProperty

Exceptions
XMLConfigurationException:

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

Thrown if there is a configuration error.