org.apache.xerces.parsers

Class XIncludeAwareParserConfiguration

Implemented Interfaces:
XML11Configurable, org.apache.xerces.xni.parser.XMLComponentManager, org.apache.xerces.xni.parser.XMLPullParserConfiguration
Known Direct Subclasses:
SecurityConfiguration, 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: XIncludeAwareParserConfiguration.java,v 1.2 2005/05/09 02:08:10 mrglavas Exp $
Author:
Michael Glavassevich, IBM

Field Summary

protected static String
ALLOW_UE_AND_NOTATION_EVENTS
Feature identifier: allow notation and unparsed entity events to be sent out of order.
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: error reporter.
protected org.apache.xerces.xni.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.

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, GENERATE_SYNTHETIC_ANNOTATIONS, HONOUR_ALL_SCHEMALOCATIONS, JAXP_SCHEMA_LANGUAGE, JAXP_SCHEMA_SOURCE, LOAD_EXTERNAL_DTD, NAMESPACES, NAMESPACE_BINDER, NORMALIZE_DATA, NOTIFY_BUILTIN_REFS, NOTIFY_CHAR_REFS, PRINT_EXCEPTION_STACK_TRACE, SCHEMA_AUGMENT_PSVI, SCHEMA_ELEMENT_DEFAULT, SCHEMA_LOCATION, SCHEMA_NONS_LOCATION, SCHEMA_VALIDATOR, SYMBOL_TABLE, 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, XMLGRAMMAR_POOL, XMLSCHEMA_FULL_CHECKING, XMLSCHEMA_VALIDATION, XML_STRING, fCommonComponents, fComponents, fConfigUpdated, fCurrentDTDScanner, fCurrentDVFactory, fCurrentScanner, fDTDContentModelHandler, fDTDHandler, fDTDProcessor, fDTDScanner, fDTDValidator, fDatatypeValidatorFactory, fDocumentHandler, fEntityManager, fErrorReporter, fGrammarPool, fInputSource, fLastComponent, fLocale, fLocator, fNamespaceScanner, fNonNSDTDValidator, fNonNSScanner, fParseInProgress, fSchemaValidator, fSymbolTable, fValidationManager, fVersionDetector, fXML11Components, fXML11DTDProcessor, fXML11DTDScanner, fXML11DTDValidator, fXML11DatatypeFactory, fXML11DocScanner, fXML11NSDTDValidator, fXML11NSDocScanner

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

PARSER_SETTINGS, fFeatures, fParentSettings, fProperties, fRecognizedFeatures, fRecognizedProperties

Constructor Summary

XIncludeAwareParserConfiguration()
Default constructor.
XIncludeAwareParserConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
XIncludeAwareParserConfiguration(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.
XIncludeAwareParserConfiguration(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
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, configurePipeline, configureXML11Pipeline, getDTDContentModelHandler, getDTDHandler, getDocumentHandler, getEntityResolver, getErrorHandler, getFeature, getLocale, parse, parse, reset, resetCommon, resetXML11, setDTDContentModelHandler, setDTDHandler, setDocumentHandler, setEntityResolver, setErrorHandler, setFeature, setInputSource, setLocale, setProperty

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

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

Field Details

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.

NAMESPACE_CONTEXT

protected static final String NAMESPACE_CONTEXT
Property identifier: error reporter.

XINCLUDE_FEATURE

protected static final String XINCLUDE_FEATURE
Feature identifier: XInclude processing

XINCLUDE_FIXUP_BASE_URIS

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

XINCLUDE_FIXUP_LANGUAGE

protected static final String XINCLUDE_FIXUP_LANGUAGE
Feature identifier: fixup language.

XINCLUDE_HANDLER

protected static final String XINCLUDE_HANDLER
Property identifier: error reporter.

fCurrentNSContext

protected org.apache.xerces.xni.NamespaceContext fCurrentNSContext
Current NamespaceContext.

fNonXIncludeNSContext

protected NamespaceSupport fNonXIncludeNSContext
Non-XInclude NamespaceContext.

fXIncludeEnabled

protected boolean fXIncludeEnabled
Flag indicating whether XInclude processsing is enabled.

fXIncludeHandler

protected XIncludeHandler fXIncludeHandler
XInclude handler.

fXIncludeNSContext

protected XIncludeNamespaceSupport fXIncludeNSContext
XInclude NamespaceContext.

Constructor Details

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

Parameters:
symbolTable - The symbol table to use.
grammarPool - The grammar pool to use.
parentSettings - The parent settings.

Method Details

configurePipeline

protected void configurePipeline()
Configures the pipeline.
Overrides:
configurePipeline in interface XML11Configuration

configureXML11Pipeline

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

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

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

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.