org.apache.xerces.parsers: public class: XIncludeParserConfiguration

org.apache.xerces.parsers
public class: XIncludeParserConfiguration [javadoc | source]

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

All Implemented Interfaces:
XMLPullParserConfiguration, XML11Configurable, XMLComponentManager

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.

Also see:

org.apache.xerces.xinclude.XIncludeHandler

author: Peter - McCracken, IBM

Field Summary
protected static final String	ALLOW_UE_AND_NOTATION_EVENTS	Feature identifier: allow notation and unparsed entity events to be sent out of order.
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.
protected static final String	NAMESPACE_CONTEXT	Property identifier: error reporter.

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

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

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

Fields inherited from org.apache.xerces.util.ParserConfigurationSettings:
PARSER_SETTINGS, fRecognizedProperties, fProperties, fRecognizedFeatures, fFeatures, fParentSettings

Constructor:

Constructor:
public XIncludeParserConfiguration() { this(null, null, null); } Default constructor.
public XIncludeParserConfiguration(SymbolTable symbolTable) { this(symbolTable, null, null); } Constructs a parser configuration using the specified symbol table. Parameters: `symbolTable` - The symbol table to use.
public XIncludeParserConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool) { this(symbolTable, grammarPool, null); } 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.
public XIncludeParserConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings) { super(symbolTable, grammarPool, parentSettings); fXIncludeHandler = new XIncludeHandler(); addCommonComponent(fXIncludeHandler); final String[] recognizedFeatures = { ALLOW_UE_AND_NOTATION_EVENTS, XINCLUDE_FIXUP_BASE_URIS, XINCLUDE_FIXUP_LANGUAGE }; addRecognizedFeatures(recognizedFeatures); // add default recognized properties final String[] recognizedProperties = { XINCLUDE_HANDLER, NAMESPACE_CONTEXT }; addRecognizedProperties(recognizedProperties); setFeature(ALLOW_UE_AND_NOTATION_EVENTS, true); setFeature(XINCLUDE_FIXUP_BASE_URIS, true); setFeature(XINCLUDE_FIXUP_LANGUAGE, true); setProperty(XINCLUDE_HANDLER, fXIncludeHandler); setProperty(NAMESPACE_CONTEXT, new XIncludeNamespaceSupport()); } 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.

 public XIncludeParserConfiguration() {
       
        this(null, null, null);
}

Default constructor.

 public XIncludeParserConfiguration(SymbolTable symbolTable) {
        this(symbolTable, null, null);
}

Constructs a parser configuration using the specified symbol table.

Parameters:

symbolTable - The symbol table to use.

 public XIncludeParserConfiguration(SymbolTable symbolTable,
    XMLGrammarPool grammarPool) {
        this(symbolTable, grammarPool, null);
}

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

 public XIncludeParserConfiguration(SymbolTable symbolTable,
    XMLGrammarPool grammarPool,
    XMLComponentManager parentSettings) {
        super(symbolTable, grammarPool, parentSettings);
        fXIncludeHandler = new XIncludeHandler();
        addCommonComponent(fXIncludeHandler);
        final String[] recognizedFeatures = {
            ALLOW_UE_AND_NOTATION_EVENTS,
            XINCLUDE_FIXUP_BASE_URIS,
            XINCLUDE_FIXUP_LANGUAGE
        };
        addRecognizedFeatures(recognizedFeatures);
        // add default recognized properties
        final String[] recognizedProperties =
            { XINCLUDE_HANDLER, NAMESPACE_CONTEXT };
        addRecognizedProperties(recognizedProperties);
        setFeature(ALLOW_UE_AND_NOTATION_EVENTS, true);
        setFeature(XINCLUDE_FIXUP_BASE_URIS, true);
        setFeature(XINCLUDE_FIXUP_LANGUAGE, true);
        setProperty(XINCLUDE_HANDLER, fXIncludeHandler);
        setProperty(NAMESPACE_CONTEXT, new XIncludeNamespaceSupport());
}

Parameters:

symbolTable - The symbol table to use.

grammarPool - The grammar pool to use.

parentSettings - The parent settings.

Method from org.apache.xerces.parsers.XIncludeParserConfiguration Summary:
configurePipeline, configureXML11Pipeline, setProperty

Methods from org.apache.xerces.parsers.XML11Configuration:
addCommonComponent, addComponent, addRecognizedParamsAndSetDefaults, addXML11Component, checkFeature, checkProperty, cleanup, configurePipeline, configureXML11Pipeline, getDTDContentModelHandler, getDTDHandler, getDocumentHandler, getEntityResolver, getErrorHandler, getFeature, getFeature0, getLocale, parse, parse, reset, resetCommon, resetXML11, setDTDContentModelHandler, setDTDHandler, setDocumentHandler, setEntityResolver, setErrorHandler, setFeature, setInputSource, setLocale, setProperty

Methods from org.apache.xerces.parsers.XML11Configuration:

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

Methods from org.apache.xerces.util.ParserConfigurationSettings:
addRecognizedFeatures, addRecognizedProperties, checkFeature, checkProperty, getFeature, getProperty, setFeature, setProperty

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.xerces.parsers.XIncludeParserConfiguration Detail:
protected void configurePipeline() { super.configurePipeline(); //configure DTD pipeline fDTDScanner.setDTDHandler(fDTDProcessor); fDTDProcessor.setDTDSource(fDTDScanner); fDTDProcessor.setDTDHandler(fXIncludeHandler); fXIncludeHandler.setDTDSource(fDTDProcessor); fXIncludeHandler.setDTDHandler(fDTDHandler); if (fDTDHandler != null) { fDTDHandler.setDTDSource(fXIncludeHandler); } // configure XML document pipeline: insert after DTDValidator and // before XML Schema validator XMLDocumentSource prev = null; if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) { // we don't have to worry about fSchemaValidator being null, since // super.configurePipeline() instantiated it if the feature was set prev = fSchemaValidator.getDocumentSource(); } // Otherwise, insert after the last component in the pipeline else { prev = fLastComponent; fLastComponent = fXIncludeHandler; } XMLDocumentHandler next = prev.getDocumentHandler(); prev.setDocumentHandler(fXIncludeHandler); fXIncludeHandler.setDocumentSource(prev); if (next != null) { fXIncludeHandler.setDocumentHandler(next); next.setDocumentSource(fXIncludeHandler); } } Configures the pipeline.
protected void configureXML11Pipeline() { super.configureXML11Pipeline(); // configure XML 1.1. DTD pipeline fXML11DTDScanner.setDTDHandler(fXML11DTDProcessor); fXML11DTDProcessor.setDTDSource(fXML11DTDScanner); fXML11DTDProcessor.setDTDHandler(fXIncludeHandler); fXIncludeHandler.setDTDSource(fXML11DTDProcessor); fXIncludeHandler.setDTDHandler(fDTDHandler); if (fDTDHandler != null) { fDTDHandler.setDTDSource(fXIncludeHandler); } // configure XML document pipeline: insert after DTDValidator and // before XML Schema validator XMLDocumentSource prev = null; if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) { // we don't have to worry about fSchemaValidator being null, since // super.configurePipeline() instantiated it if the feature was set prev = fSchemaValidator.getDocumentSource(); } // Otherwise, insert after the last component in the pipeline else { prev = fLastComponent; fLastComponent = fXIncludeHandler; } XMLDocumentHandler next = prev.getDocumentHandler(); prev.setDocumentHandler(fXIncludeHandler); fXIncludeHandler.setDocumentSource(prev); if (next != null) { fXIncludeHandler.setDocumentHandler(next); next.setDocumentSource(fXIncludeHandler); } }
public void setProperty(String propertyId, Object value) throws XMLConfigurationException { if (propertyId.equals(XINCLUDE_HANDLER)) { } super.setProperty(propertyId, value); }

Method from org.apache.xerces.parsers.XIncludeParserConfiguration Detail:

 protected  void configurePipeline() {
        super.configurePipeline();
        //configure DTD pipeline
        fDTDScanner.setDTDHandler(fDTDProcessor);
        fDTDProcessor.setDTDSource(fDTDScanner);
        fDTDProcessor.setDTDHandler(fXIncludeHandler);
        fXIncludeHandler.setDTDSource(fDTDProcessor);
		fXIncludeHandler.setDTDHandler(fDTDHandler);
        if (fDTDHandler != null) {
            fDTDHandler.setDTDSource(fXIncludeHandler);
        }
        // configure XML document pipeline: insert after DTDValidator and 
        // before XML Schema validator
        XMLDocumentSource prev = null;
        if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
            // we don't have to worry about fSchemaValidator being null, since
            // super.configurePipeline() instantiated it if the feature was set
            prev = fSchemaValidator.getDocumentSource();
        }
        // Otherwise, insert after the last component in the pipeline
        else {
            prev = fLastComponent;
            fLastComponent = fXIncludeHandler;
        }
        XMLDocumentHandler next = prev.getDocumentHandler();
		prev.setDocumentHandler(fXIncludeHandler);
		fXIncludeHandler.setDocumentSource(prev);
        if (next != null) {
            fXIncludeHandler.setDocumentHandler(next);
            next.setDocumentSource(fXIncludeHandler);
        }
}

Configures the pipeline.

 protected  void configureXML11Pipeline() {
		super.configureXML11Pipeline();
        // configure XML 1.1. DTD pipeline
		fXML11DTDScanner.setDTDHandler(fXML11DTDProcessor);
		fXML11DTDProcessor.setDTDSource(fXML11DTDScanner);
		fXML11DTDProcessor.setDTDHandler(fXIncludeHandler);
		fXIncludeHandler.setDTDSource(fXML11DTDProcessor);
		fXIncludeHandler.setDTDHandler(fDTDHandler);
		if (fDTDHandler != null) {
			fDTDHandler.setDTDSource(fXIncludeHandler);
		}
		// configure XML document pipeline: insert after DTDValidator and 
		// before XML Schema validator
		XMLDocumentSource prev = null;
		if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
			// we don't have to worry about fSchemaValidator being null, since
			// super.configurePipeline() instantiated it if the feature was set
			prev = fSchemaValidator.getDocumentSource();
		}
		// Otherwise, insert after the last component in the pipeline
		else {
			prev = fLastComponent;
			fLastComponent = fXIncludeHandler;
		}
		XMLDocumentHandler next = prev.getDocumentHandler();
		prev.setDocumentHandler(fXIncludeHandler);
		fXIncludeHandler.setDocumentSource(prev);
		if (next != null) {
			fXIncludeHandler.setDocumentHandler(next);
			next.setDocumentSource(fXIncludeHandler);
		}
}

 public  void setProperty(String propertyId,
    Object value) throws XMLConfigurationException {
        if (propertyId.equals(XINCLUDE_HANDLER)) {
        }
        super.setProperty(propertyId, value);
}