SchemaParsingConfig (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.apache.xerces.util.ParserConfigurationSettings
- - org.apache.xerces.parsers.BasicParserConfiguration
  - - org.apache.xerces.impl.xs.opti.SchemaParsingConfig

All Implemented Interfaces:

XMLComponentManager, XMLParserConfiguration, XMLPullParserConfiguration
```
public class SchemaParsingConfig
extends BasicParserConfiguration
implements XMLPullParserConfiguration
```
Version:

$Id$

Author:

Rahul Srivastava, Sun Microsystems Inc.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ALLOW_JAVA_ENCODINGS` Feature identifier: allow Java encodings.
`protected static String`	`CONTINUE_AFTER_FATAL_ERROR` Feature identifier: continue after fatal error.
`protected static String`	`DATATYPE_VALIDATOR_FACTORY` Property identifier: datatype validator factory.
`protected static String`	`DOCUMENT_SCANNER` Property identifier document scanner:
`protected static String`	`DTD_SCANNER` Property identifier: DTD scanner.
`protected static String`	`DTD_VALIDATOR` Property identifier: DTD validator.
`protected static String`	`ENTITY_MANAGER` Property identifier: entity manager.
`protected static String`	`ERROR_REPORTER` Property identifier: error reporter.
`protected boolean`	`fConfigUpdated` fConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.
`protected XMLDTDScanner`	`fCurrentDTDScanner` Current DTD scanner.
`protected DTDDVFactory`	`fCurrentDVFactory` Current Datatype validator factory.
`protected XMLDocumentScanner`	`fCurrentScanner` Current scanner
`protected DTDDVFactory`	`fDatatypeValidatorFactory` The XML 1.0 Datatype validator factory.
`protected XMLDTDScannerImpl`	`fDTDScanner` The XML 1.0 DTD scanner.
`protected XMLEntityManager`	`fEntityManager` Entity manager.
`protected XMLErrorReporter`	`fErrorReporter` Error reporter.
`protected XMLGrammarPool`	`fGrammarPool` Grammar pool.
`protected XMLInputSource`	`fInputSource` Input Source
`protected XMLLocator`	`fLocator` Locator
`protected XMLNSDocumentScannerImpl`	`fNamespaceScanner` The XML 1.0 Document scanner.
`protected boolean`	`fParseInProgress` True if a parse is in progress.
`protected SchemaDOMParser`	`fSchemaDOMParser`
`protected ValidationManager`	`fValidationManager`
`protected XMLVersionDetector`	`fVersionDetector` XML version detector.
`protected DTDDVFactory`	`fXML11DatatypeFactory` The XML 1.1 Datatype validator factory.
`protected XML11DTDScannerImpl`	`fXML11DTDScanner` The XML 1.1 DTD scanner.
`protected XML11NSDocumentScannerImpl`	`fXML11NSDocScanner` The XML 1.1 Document scanner.
`protected static String`	`GENERATE_SYNTHETIC_ANNOTATIONS` Feature identifier: generate synthetic annotations.
`protected static String`	`LOAD_EXTERNAL_DTD` Feature identifier: load external DTD.
`protected static String`	`NAMESPACE_BINDER` Property identifier: namespace binder.
`protected static String`	`NORMALIZE_DATA` Feature identifier: expose schema normalized value
`protected static String`	`NOTIFY_BUILTIN_REFS` Feature identifier: notify built-in refereces.
`protected static String`	`NOTIFY_CHAR_REFS` Feature identifier: notify character refereces.
`protected static String`	`SCHEMA_ELEMENT_DEFAULT` Feature identifier: send element default value via characters()
`protected static String`	`SCHEMA_VALIDATOR` Property identifier: XML Schema validator.
`protected static String`	`VALIDATION_MANAGER`
`protected static String`	`WARN_ON_DUPLICATE_ATTDEF` Feature identifier: warn on duplicate attribute definition.
`protected static String`	`WARN_ON_UNDECLARED_ELEMDEF` Feature identifier: warn on undeclared element definition.
`protected static String`	`XML11_DATATYPE_VALIDATOR_FACTORY`
`protected static String`	`XMLGRAMMAR_POOL` Property identifier: grammar pool.

Fields inherited from class org.apache.xerces.parsers.BasicParserConfiguration
ENTITY_RESOLVER, ERROR_HANDLER, EXTERNAL_GENERAL_ENTITIES, EXTERNAL_PARAMETER_ENTITIES, fComponents, fDocumentHandler, fDTDContentModelHandler, fDTDHandler, fLastComponent, fLocale, fSymbolTable, NAMESPACES, SYMBOL_TABLE, VALIDATION, XML_STRING

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkFeature(String featureId)` Check a feature.
`protected void`	`checkProperty(String propertyId)` Check a property.
`void`	`cleanup()` If the application decides to terminate parsing before the xml document is fully parsed, the application should call this method to free any resource allocated during parsing.
`protected void`	`configurePipeline()` Configures the XML 1.0 pipeline.
`protected void`	`configureXML11Pipeline()` Configures the XML 1.1 pipeline.
`Document`	`getDocument()` Returns the Document object.
`boolean`	`getFeature(String featureId)` Returns the state of a feature.
`boolean`	`parse(boolean complete)` Parses the document in a pull parsing fashion.
`void`	`parse(XMLInputSource source)` Parses the specified input source.
`void`	`reset()` Reset all components before parsing.
`void`	`resetNodePool()`
`protected void`	`resetXML10()` Reset all XML 1.0 components before parsing
`protected void`	`resetXML11()` Reset all XML 1.1 components before parsing
`void`	`setFeature(String featureId, boolean state)` Set the state of a feature.
`void`	`setInputSource(XMLInputSource inputSource)` Sets the input source for the document to parse.
`void`	`setLocale(Locale locale)` Set the locale to use for messages.
`void`	`setProperty(String propertyId, Object value)` setProperty

Methods inherited from class org.apache.xerces.parsers.BasicParserConfiguration
addComponent, getDocumentHandler, getDTDContentModelHandler, getDTDHandler, getEntityResolver, getErrorHandler, getLocale, setDocumentHandler, setDTDContentModelHandler, setDTDHandler, setEntityResolver, setErrorHandler

Methods inherited from class org.apache.xerces.util.ParserConfigurationSettings
addRecognizedFeatures, addRecognizedProperties, getProperty

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, getDocumentHandler, getDTDContentModelHandler, getDTDHandler, getEntityResolver, getErrorHandler, getLocale, getProperty, setDocumentHandler, setDTDContentModelHandler, setDTDHandler, setEntityResolver, setErrorHandler

- Field Detail
  - XML11_DATATYPE_VALIDATOR_FACTORY
```
protected static final String XML11_DATATYPE_VALIDATOR_FACTORY
```
    See Also:
    Constant Field Values
  - WARN_ON_DUPLICATE_ATTDEF
```
protected static final String WARN_ON_DUPLICATE_ATTDEF
```
    Feature identifier: warn on duplicate attribute definition.
    
    See Also:
    Constant Field Values
  - WARN_ON_UNDECLARED_ELEMDEF
```
protected static final String WARN_ON_UNDECLARED_ELEMDEF
```
    Feature identifier: warn on undeclared element definition.
    
    See Also:
    Constant Field Values
  - ALLOW_JAVA_ENCODINGS
```
protected static final String ALLOW_JAVA_ENCODINGS
```
    Feature identifier: allow Java encodings.
    
    See Also:
    Constant Field Values
  - CONTINUE_AFTER_FATAL_ERROR
```
protected static final String CONTINUE_AFTER_FATAL_ERROR
```
    Feature identifier: continue after fatal error.
    
    See Also:
    Constant Field Values
  - LOAD_EXTERNAL_DTD
```
protected static final String LOAD_EXTERNAL_DTD
```
    Feature identifier: load external DTD.
    
    See Also:
    Constant Field Values
  - NOTIFY_BUILTIN_REFS
```
protected static final String NOTIFY_BUILTIN_REFS
```
    Feature identifier: notify built-in refereces.
    
    See Also:
    Constant Field Values
  - NOTIFY_CHAR_REFS
```
protected static final String NOTIFY_CHAR_REFS
```
    Feature identifier: notify character refereces.
    
    See Also:
    Constant Field Values
  - NORMALIZE_DATA
```
protected static final String NORMALIZE_DATA
```
    Feature identifier: expose schema normalized value
    
    See Also:
    Constant Field Values
  - SCHEMA_ELEMENT_DEFAULT
```
protected static final String SCHEMA_ELEMENT_DEFAULT
```
    Feature identifier: send element default value via characters()
    
    See Also:
    Constant Field Values
  - GENERATE_SYNTHETIC_ANNOTATIONS
```
protected static final String GENERATE_SYNTHETIC_ANNOTATIONS
```
    Feature identifier: generate synthetic annotations.
    
    See Also:
    Constant Field Values
  - ERROR_REPORTER
```
protected static final String ERROR_REPORTER
```
    Property identifier: error reporter.
    
    See Also:
    Constant Field Values
  - ENTITY_MANAGER
```
protected static final String ENTITY_MANAGER
```
    Property identifier: entity manager.
    
    See Also:
    Constant Field Values
  - DOCUMENT_SCANNER
```
protected static final String DOCUMENT_SCANNER
```
    Property identifier document scanner:
    
    See Also:
    Constant Field Values
  - DTD_SCANNER
```
protected static final String DTD_SCANNER
```
    Property identifier: DTD scanner.
    
    See Also:
    Constant Field Values
  - XMLGRAMMAR_POOL
```
protected static final String XMLGRAMMAR_POOL
```
    Property identifier: grammar pool.
    
    See Also:
    Constant Field Values
  - DTD_VALIDATOR
```
protected static final String DTD_VALIDATOR
```
    Property identifier: DTD validator.
    
    See Also:
    Constant Field Values
  - NAMESPACE_BINDER
```
protected static final String NAMESPACE_BINDER
```
    Property identifier: namespace binder.
    
    See Also:
    Constant Field Values
  - DATATYPE_VALIDATOR_FACTORY
```
protected static final String DATATYPE_VALIDATOR_FACTORY
```
    Property identifier: datatype validator factory.
    
    See Also:
    Constant Field Values
  - VALIDATION_MANAGER
```
protected static final String VALIDATION_MANAGER
```
    See Also:
    Constant Field Values
  - SCHEMA_VALIDATOR
```
protected static final String SCHEMA_VALIDATOR
```
    Property identifier: XML Schema validator.
    
    See Also:
    Constant Field Values
  - fDatatypeValidatorFactory
```
protected final DTDDVFactory fDatatypeValidatorFactory
```
    The XML 1.0 Datatype validator factory.
  - fNamespaceScanner
```
protected final XMLNSDocumentScannerImpl fNamespaceScanner
```
    The XML 1.0 Document scanner.
  - fDTDScanner
```
protected final XMLDTDScannerImpl fDTDScanner
```
    The XML 1.0 DTD scanner.
  - fXML11DatatypeFactory
```
protected DTDDVFactory fXML11DatatypeFactory
```
    The XML 1.1 Datatype validator factory.
  - fXML11NSDocScanner
```
protected XML11NSDocumentScannerImpl fXML11NSDocScanner
```
    The XML 1.1 Document scanner.
  - fXML11DTDScanner
```
protected XML11DTDScannerImpl fXML11DTDScanner
```
    The XML 1.1 DTD scanner.
  - fCurrentDVFactory
```
protected DTDDVFactory fCurrentDVFactory
```
    Current Datatype validator factory.
  - fCurrentScanner
```
protected XMLDocumentScanner fCurrentScanner
```
    Current scanner
  - fCurrentDTDScanner
```
protected XMLDTDScanner fCurrentDTDScanner
```
    Current DTD scanner.
  - fGrammarPool
```
protected XMLGrammarPool fGrammarPool
```
    Grammar pool.
  - fVersionDetector
```
protected final XMLVersionDetector fVersionDetector
```
    XML version detector.
  - fErrorReporter
```
protected final XMLErrorReporter fErrorReporter
```
    Error reporter.
  - fEntityManager
```
protected final XMLEntityManager fEntityManager
```
    Entity manager.
  - fInputSource
```
protected XMLInputSource fInputSource
```
    Input Source
  - fSchemaDOMParser
```
protected SchemaDOMParser fSchemaDOMParser
```
  - fValidationManager
```
protected final ValidationManager fValidationManager
```
  - fLocator
```
protected XMLLocator fLocator
```
    Locator
  - fParseInProgress
```
protected boolean fParseInProgress
```
    True if a parse is in progress. This state is needed because some features/properties cannot be set while parsing (e.g. validation and namespaces).
  - fConfigUpdated
```
protected boolean fConfigUpdated
```
    fConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.
- Constructor Detail
  - SchemaParsingConfig
```
public SchemaParsingConfig()
```
    Default constructor.
  - SchemaParsingConfig
```
public SchemaParsingConfig(SymbolTable symbolTable)
```
    Constructs a parser configuration using the specified symbol table.
    
    Parameters:
    symbolTable - The symbol table to use.
  - SchemaParsingConfig
```
public SchemaParsingConfig(SymbolTable symbolTable,
                   XMLGrammarPool grammarPool)
```
    Constructs a parser configuration using the specified symbol table and grammar pool.
    REVISIT: Grammar pool will be updated when the new validation engine is implemented.
    
    Parameters:
    symbolTable - The symbol table to use.
    grammarPool - The grammar pool to use.
  - SchemaParsingConfig
```
public SchemaParsingConfig(SymbolTable symbolTable,
                   XMLGrammarPool grammarPool,
                   XMLComponentManager parentSettings)
```
    Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.
    REVISIT: Grammar pool will be updated when the new validation engine is implemented.
    
    Parameters:
    symbolTable - The symbol table to use.
    grammarPool - The grammar pool to use.
    parentSettings - The parent settings.
- Method Detail
  - getFeature
```
public boolean getFeature(String featureId)
                   throws XMLConfigurationException
```
    Returns the state of a feature.
    
    Specified by:
    
    getFeature in interface XMLComponentManager
    
    Specified by:
    
    getFeature in interface XMLParserConfiguration
    
    Overrides:
    
    getFeature in class ParserConfigurationSettings
    
    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
```
    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 BasicParserConfiguration
    
    Parameters:
    featureId - The unique identifier (URI) of the feature.
    state - The requested state of the feature (true or false).
    
    Throws:
    
    XMLConfigurationException - If the requested feature is not known.
  - setProperty
```
public void setProperty(String propertyId,
               Object value)
                 throws XMLConfigurationException
```
    setProperty
    
    Specified by:
    
    setProperty in interface XMLParserConfiguration
    
    Overrides:
    
    setProperty in class BasicParserConfiguration
    
    Parameters:
    propertyId -
    value -
    
    Throws:
    
    XMLConfigurationException - Thrown if there is a configuration error.
  - setLocale
```
public void setLocale(Locale locale)
               throws XNIException
```
    Set the locale to use for messages.
    
    Specified by:
    
    setLocale in interface XMLParserConfiguration
    
    Overrides:
    
    setLocale in class BasicParserConfiguration
    
    Parameters:
    locale - The locale object to use for localization of messages.
    
    Throws:
    
    XNIException - Thrown if the parser does not support the specified locale.
  - setInputSource
```
public void setInputSource(XMLInputSource inputSource)
                    throws XMLConfigurationException,
                           IOException
```
    Sets the input source for the document to parse.
    
    Specified by:
    
    setInputSource in interface XMLPullParserConfiguration
    
    Parameters:
    inputSource - The document's input source.
    
    Throws:
    
    XMLConfigurationException - Thrown if there is a configuration error when initializing the parser.
    
    IOException - Thrown on I/O error.
    See Also:
    parse(boolean)
  - parse
```
public boolean parse(boolean complete)
              throws XNIException,
                     IOException
```
    Parses the document in a pull parsing fashion.
    
    Specified by:
    
    parse in interface XMLPullParserConfiguration
    
    Parameters:
    complete - True if the pull parser should parse the remaining document completely.
    
    Returns:
    True if there is more document to parse.
    
    Throws:
    
    XNIException - Any XNI exception, possibly wrapping another exception.
    
    IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.
    See Also:
    setInputSource(org.apache.xerces.xni.parser.XMLInputSource)
  - cleanup
```
public void cleanup()
```
    If the application decides to terminate parsing before the xml document is fully parsed, the application should call this method to free any resource allocated during parsing. For example, close all opened streams.
    
    Specified by:
    
    cleanup in interface XMLPullParserConfiguration
  - parse
```
public void parse(XMLInputSource source)
           throws XNIException,
                  IOException
```
    Parses the specified input source.
    
    Specified by:
    
    parse in interface XMLParserConfiguration
    
    Specified by:
    
    parse in class BasicParserConfiguration
    
    Parameters:
    source - The input source.
    
    Throws:
    
    XNIException - Throws exception on XNI error.
    
    IOException - Throws exception on i/o error.
  - reset
```
public void reset()
           throws XNIException
```
    Reset all components before parsing.
    
    Overrides:
    
    reset in class BasicParserConfiguration
    
    Throws:
    
    XNIException - Thrown if an error occurs during initialization.
  - configurePipeline
```
protected void configurePipeline()
```
    Configures the XML 1.0 pipeline.
  - configureXML11Pipeline
```
protected void configureXML11Pipeline()
```
    Configures the XML 1.1 pipeline.
  - checkFeature
```
protected void checkFeature(String featureId)
                     throws XMLConfigurationException
```
    Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.
    
    Overrides:
    
    checkFeature in class BasicParserConfiguration
    
    Parameters:
    featureId - The unique identifier (URI) of the feature.
    
    Throws:
    
    XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
  - checkProperty
```
protected void checkProperty(String propertyId)
                      throws XMLConfigurationException
```
    Check a property. If the property is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.
    
    Overrides:
    
    checkProperty in class BasicParserConfiguration
    
    Parameters:
    propertyId - The unique identifier (URI) of the property being set.
    
    Throws:
    
    XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
  - resetXML10
```
protected final void resetXML10()
                         throws XNIException
```
    Reset all XML 1.0 components before parsing
    
    Throws:
    
    XNIException
  - resetXML11
```
protected final void resetXML11()
                         throws XNIException
```
    Reset all XML 1.1 components before parsing
    
    Throws:
    
    XNIException
  - getDocument
```
public Document getDocument()
```
    Returns the Document object.
  - resetNodePool
```
public void resetNodePool()
```

Class SchemaParsingConfig

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

XML11_DATATYPE_VALIDATOR_FACTORY

WARN_ON_DUPLICATE_ATTDEF

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

GENERATE_SYNTHETIC_ANNOTATIONS

ERROR_REPORTER

ENTITY_MANAGER

DOCUMENT_SCANNER

DTD_SCANNER

XMLGRAMMAR_POOL

DTD_VALIDATOR

NAMESPACE_BINDER

DATATYPE_VALIDATOR_FACTORY

VALIDATION_MANAGER

SCHEMA_VALIDATOR

fDatatypeValidatorFactory

fNamespaceScanner

fDTDScanner

fXML11DatatypeFactory

fXML11NSDocScanner

fXML11DTDScanner

fCurrentDVFactory

fCurrentScanner

fCurrentDTDScanner

fGrammarPool

fVersionDetector

fErrorReporter

fEntityManager

fInputSource

fSchemaDOMParser

fValidationManager

fLocator

fParseInProgress

fConfigUpdated

Constructor Detail

SchemaParsingConfig

SchemaParsingConfig

SchemaParsingConfig

SchemaParsingConfig

Method Detail

getFeature

setFeature

setProperty

setLocale

setInputSource

parse

cleanup

parse

reset

configurePipeline

configureXML11Pipeline

checkFeature

checkProperty

resetXML10

resetXML11

getDocument

resetNodePool