Xerces2-j 2.12.2 · org.apache.xerces.impl.xs.opti.SchemaParsingConfig

Field Summary

Modifier and Type	Field and Description
protected static final String	ALLOW_JAVA_ENCODINGS Feature identifier: allow Java encodings.
protected static final String	CONTINUE_AFTER_FATAL_ERROR Feature identifier: continue after fatal error.
protected static final String	DATATYPE_VALIDATOR_FACTORY Property identifier: datatype validator factory.
protected static final String	DOCUMENT_SCANNER Property identifier document scanner:
protected static final String	DTD_SCANNER Property identifier: DTD scanner.
protected static final String	DTD_VALIDATOR Property identifier: DTD validator.
protected static final String	ENTITY_MANAGER Property identifier: entity manager.
protected static final String	ERROR_REPORTER Property identifier: error reporter.
private boolean	f11Initialized Flag indiciating whether XML11 components have been initialized.
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 final DTDDVFactory	fDatatypeValidatorFactory The XML 1.0 Datatype validator factory.
protected final XMLDTDScannerImpl	fDTDScanner The XML 1.0 DTD scanner.
protected final XMLEntityManager	fEntityManager Entity manager.
protected final XMLErrorReporter	fErrorReporter Error reporter.
protected XMLGrammarPool	fGrammarPool Grammar pool.
protected XMLInputSource	fInputSource Input Source
protected XMLLocator	fLocator Locator
protected final XMLNSDocumentScannerImpl	fNamespaceScanner The XML 1.0 Document scanner.
protected boolean	fParseInProgress True if a parse is in progress.
protected final ValidationManager	fValidationManager
protected final 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 final String	GENERATE_SYNTHETIC_ANNOTATIONS Feature identifier: generate synthetic annotations.
protected static final String	LOAD_EXTERNAL_DTD Feature identifier: load external DTD.
protected static final String	LOCALE Property identifier: locale.
protected static final String	NAMESPACE_BINDER Property identifier: namespace binder.
protected static final String	NORMALIZE_DATA Feature identifier: expose schema normalized value
protected static final String	NOTIFY_BUILTIN_REFS Feature identifier: notify built-in refereces.
protected static final String	NOTIFY_CHAR_REFS Feature identifier: notify character refereces.
private static final boolean	PRINT_EXCEPTION_STACK_TRACE Set to true and recompile to print exception stack trace.
protected static final String	SCHEMA_ELEMENT_DEFAULT Feature identifier: send element default value via characters()
protected static final String	SCHEMA_VALIDATOR Property identifier: XML Schema validator.
protected static final String	VALIDATION_MANAGER
protected static final String	WARN_ON_DUPLICATE_ATTDEF Feature identifier: warn on duplicate attribute definition.
protected static final String	WARN_ON_UNDECLARED_ELEMDEF Feature identifier: warn on undeclared element definition.
protected static final String	XML11_DATATYPE_VALIDATOR_FACTORY
protected static final String	XMLGRAMMAR_POOL Property identifier: grammar pool.

Inherited from 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

Constructor Summary

Access	Constructor and Description
public	SchemaParsingConfig() Default constructor.
public	SchemaParsingConfig(SymbolTable The symbol table to use. symbolTable) Constructs a parser configuration using the specified symbol table.
public	SchemaParsingConfig(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	SchemaParsingConfig(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
private void	addRecognizedParamsAndSetDefaults(XMLComponent The component whose recognized features and properties will be added to the configuration component) Adds all of the component's recognized features and properties to the list of default recognized features and properties, and sets default values on the configuration for features and properties which were previously absent from the configuration.
protected void	checkFeature(String The unique identifier (URI) of the feature. featureId) Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkFeature. Check a feature.
protected void	checkProperty(String The unique identifier (URI) of the property being set. propertyId) Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkProperty. Check a property.
public void	cleanup() Implements org.apache.xerces.xni.parser.XMLPullParserConfiguration.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.
public boolean	Returns: true if the feature is supported getFeature(String The feature identifier. featureId) Overrides org.apache.xerces.util.ParserConfigurationSettings.getFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.getFeature. Returns the state of a feature.
public Object	Returns: the value of the property getProperty(String The property identifier. propertyId) Overrides org.apache.xerces.util.ParserConfigurationSettings.getProperty. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getProperty, org.apache.xerces.xni.parser.XMLComponentManager.getProperty. Returns the value of a property.
private void	initXML11Components()
public boolean	Returns: True if there is more document to parse. parse(boolean True if the pull parser should parse the remaining document completely. complete) Implements org.apache.xerces.xni.parser.XMLPullParserConfiguration.parse. Parses the document in a pull parsing fashion.
public void	parse(XMLInputSource The input source. source) Implements abstract org.apache.xerces.parsers.BasicParserConfiguration.parse. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.parse. Parses the specified input source.
public void	reset() Overrides org.apache.xerces.parsers.BasicParserConfiguration.reset. Reset all components before parsing.
public void	resetNodePool()
protected final void	resetXML10() Reset all XML 1.0 components before parsing
protected final void	resetXML11() Reset all XML 1.1 components before parsing
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.BasicParserConfiguration.setFeature. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setFeature. Set the state of a feature.
public void	setInputSource(XMLInputSource The document's input source. inputSource) Implements org.apache.xerces.xni.parser.XMLPullParserConfiguration.setInputSource. Sets the input source for the document to parse.
public void	setLocale(Locale The locale object to use for localization of messages. locale) Overrides org.apache.xerces.parsers.BasicParserConfiguration.setLocale. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setLocale. Set the locale to use for messages.
public void	setProperty(String propertyId, Object value) Overrides org.apache.xerces.parsers.BasicParserConfiguration.setProperty. Implements org.apache.xerces.xni.parser.XMLParserConfiguration.setProperty. setProperty

Inherited from org.apache.xerces.parsers.BasicParserConfiguration:: addComponent getDocumentHandler getDTDContentModelHandler getDTDHandler getEntityResolver getErrorHandler getLocale setDocumentHandler setDTDContentModelHandler setDTDHandler setEntityResolver setErrorHandler

Field Detail

ALLOW_JAVA_ENCODINGS	back to summary
protected static final String ALLOW_JAVA_ENCODINGS Feature identifier: allow Java encodings.

CONTINUE_AFTER_FATAL_ERROR	back to summary
protected static final String CONTINUE_AFTER_FATAL_ERROR Feature identifier: continue after fatal error.

DATATYPE_VALIDATOR_FACTORY	back to summary
protected static final String DATATYPE_VALIDATOR_FACTORY Property identifier: datatype validator factory.

DOCUMENT_SCANNER	back to summary
protected static final String DOCUMENT_SCANNER Property identifier document scanner:

DTD_SCANNER	back to summary
protected static final String DTD_SCANNER Property identifier: DTD scanner.

DTD_VALIDATOR	back to summary
protected static final String DTD_VALIDATOR Property identifier: DTD validator.

ENTITY_MANAGER	back to summary
protected static final String ENTITY_MANAGER Property identifier: entity manager.

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

f11Initialized	back to summary
private boolean f11Initialized Flag indiciating whether XML11 components have been initialized.

fConfigUpdated	back to summary
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.

fCurrentDTDScanner	back to summary
protected XMLDTDScanner fCurrentDTDScanner Current DTD scanner.

fCurrentDVFactory	back to summary
protected DTDDVFactory fCurrentDVFactory Current Datatype validator factory.

fCurrentScanner	back to summary
protected XMLDocumentScanner fCurrentScanner Current scanner

fDatatypeValidatorFactory	back to summary
protected final DTDDVFactory fDatatypeValidatorFactory The XML 1.0 Datatype validator factory.

fDTDScanner	back to summary
protected final XMLDTDScannerImpl fDTDScanner The XML 1.0 DTD scanner.

fEntityManager	back to summary
protected final XMLEntityManager fEntityManager Entity manager.

fErrorReporter	back to summary
protected final XMLErrorReporter fErrorReporter Error reporter.

fGrammarPool	back to summary
protected XMLGrammarPool fGrammarPool Grammar pool.

fInputSource	back to summary
protected XMLInputSource fInputSource Input Source

fLocator	back to summary
protected XMLLocator fLocator Locator

fNamespaceScanner	back to summary
protected final XMLNSDocumentScannerImpl fNamespaceScanner The XML 1.0 Document scanner.

fParseInProgress	back to summary
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).

fValidationManager	back to summary
protected final ValidationManager fValidationManager

fVersionDetector	back to summary
protected final XMLVersionDetector fVersionDetector XML version detector.

fXML11DatatypeFactory	back to summary
protected DTDDVFactory fXML11DatatypeFactory The XML 1.1 Datatype validator factory.

fXML11DTDScanner	back to summary
protected XML11DTDScannerImpl fXML11DTDScanner The XML 1.1 DTD scanner.

fXML11NSDocScanner	back to summary
protected XML11NSDocumentScannerImpl fXML11NSDocScanner The XML 1.1 Document scanner.

GENERATE_SYNTHETIC_ANNOTATIONS	back to summary
protected static final String GENERATE_SYNTHETIC_ANNOTATIONS Feature identifier: generate synthetic annotations.

LOAD_EXTERNAL_DTD	back to summary
protected static final String LOAD_EXTERNAL_DTD Feature identifier: load external DTD.

LOCALE	back to summary
protected static final String LOCALE Property identifier: locale.

NAMESPACE_BINDER	back to summary
protected static final String NAMESPACE_BINDER Property identifier: namespace binder.

NORMALIZE_DATA	back to summary
protected static final String NORMALIZE_DATA Feature identifier: expose schema normalized value

NOTIFY_BUILTIN_REFS	back to summary
protected static final String NOTIFY_BUILTIN_REFS Feature identifier: notify built-in refereces.

NOTIFY_CHAR_REFS	back to summary
protected static final String NOTIFY_CHAR_REFS Feature identifier: notify character refereces.

PRINT_EXCEPTION_STACK_TRACE	back to summary
private static final boolean PRINT_EXCEPTION_STACK_TRACE Set to true and recompile to print exception stack trace.

SCHEMA_ELEMENT_DEFAULT	back to summary
protected static final String SCHEMA_ELEMENT_DEFAULT Feature identifier: send element default value via characters()

SCHEMA_VALIDATOR	back to summary
protected static final String SCHEMA_VALIDATOR Property identifier: XML Schema validator.

VALIDATION_MANAGER	back to summary
protected static final String VALIDATION_MANAGER

WARN_ON_DUPLICATE_ATTDEF	back to summary
protected static final String WARN_ON_DUPLICATE_ATTDEF Feature identifier: warn on duplicate attribute definition.

WARN_ON_UNDECLARED_ELEMDEF	back to summary
protected static final String WARN_ON_UNDECLARED_ELEMDEF Feature identifier: warn on undeclared element definition.

XML11_DATATYPE_VALIDATOR_FACTORY	back to summary
protected static final String XML11_DATATYPE_VALIDATOR_FACTORY

XMLGRAMMAR_POOL	back to summary
protected static final String XMLGRAMMAR_POOL Property identifier: grammar pool.

Constructor Detail

SchemaParsingConfig	back to summary
public SchemaParsingConfig() Default constructor.

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

SchemaParsingConfig

back to summary

public SchemaParsingConfig(SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters

symbolTable:SymbolTable: The symbol table to use.

SchemaParsingConfig	back to summary
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:SymbolTable The symbol table to use. grammarPool:XMLGrammarPool The grammar pool to use.

SchemaParsingConfig

back to summary

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:SymbolTable: The symbol table to use.
grammarPool:XMLGrammarPool: The grammar pool to use.

SchemaParsingConfig	back to summary
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:SymbolTable The symbol table to use. grammarPool:XMLGrammarPool The grammar pool to use. parentSettings:XMLComponentManager The parent settings.

SchemaParsingConfig

back to summary

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:SymbolTable: The symbol table to use.
grammarPool:XMLGrammarPool: The grammar pool to use.
parentSettings:XMLComponentManager: The parent settings.

Method Detail

addRecognizedParamsAndSetDefaults	back to summary
private void addRecognizedParamsAndSetDefaults(XMLComponent component) Adds all of the component's recognized features and properties to the list of default recognized features and properties, and sets default values on the configuration for features and properties which were previously absent from the configuration. Parameters component:XMLComponent The component whose recognized features and properties will be added to the configuration

addRecognizedParamsAndSetDefaults

back to summary

private void addRecognizedParamsAndSetDefaults(XMLComponent component)

Adds all of the component's recognized features and properties to the list of default recognized features and properties, and sets default values on the configuration for features and properties which were previously absent from the configuration.

Parameters

component:XMLComponent: The component whose recognized features and properties will be added to the configuration

checkFeature

back to summary

protected void checkFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkFeature.

Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters

featureId:String: The unique identifier (URI) of the feature.

Exceptions

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

checkProperty

back to summary

protected void checkProperty(String propertyId) throws XMLConfigurationException

Overrides org.apache.xerces.parsers.BasicParserConfiguration.checkProperty.

Check a property. If the property is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters

propertyId:String: The unique identifier (URI) of the property being set.

Exceptions

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

cleanup

back to summary

public void cleanup()

Implements org.apache.xerces.xni.parser.XMLPullParserConfiguration.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.

configurePipeline	back to summary
protected void configurePipeline() Configures the XML 1.0 pipeline.

configureXML11Pipeline	back to summary
protected void configureXML11Pipeline() Configures the XML 1.1 pipeline.

getFeature

back to summary

public boolean getFeature(String featureId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.getFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.getFeature, org.apache.xerces.xni.parser.XMLComponentManager.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.

getProperty

back to summary

public Object getProperty(String propertyId) throws XMLConfigurationException

Overrides org.apache.xerces.util.ParserConfigurationSettings.getProperty.

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

Returns the value of a property.

Parameters

propertyId:String: The property identifier.

Returns:Object

the value of the property

Exceptions

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

initXML11Components	back to summary
private void initXML11Components()

parse back to summary

public boolean parse(boolean complete) throws XNIException, IOException

Implements org.apache.xerces.xni.parser.XMLPullParserConfiguration.parse.

Parses the document in a pull parsing fashion.

Parameters

complete:boolean: True if the pull parser should parse the remaining document completely.

Returns:boolean

True if there is more document to parse.

Exceptions

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

parse

back to summary

public void parse(XMLInputSource source) throws XNIException, IOException

Implements abstract org.apache.xerces.parsers.BasicParserConfiguration.parse.

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

Parses the specified input source.

Parameters

source:XMLInputSource: The input source.

Exceptions

XNIException:: Throws exception on XNI error.
IOException:: Throws exception on i/o error.

reset

back to summary

public void reset() throws XNIException

Overrides org.apache.xerces.parsers.BasicParserConfiguration.reset.

Reset all components before parsing.

Exceptions

XNIException:: Thrown if an error occurs during initialization.

resetNodePool	back to summary
public void resetNodePool()

resetXML10	back to summary
protected final void resetXML10() throws XNIException Reset all XML 1.0 components before parsing

resetXML11	back to summary
protected final void resetXML11() throws XNIException Reset all XML 1.1 components before parsing

setFeature

back to summary

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

Overrides org.apache.xerces.parsers.BasicParserConfiguration.setFeature.

Implements org.apache.xerces.xni.parser.XMLParserConfiguration.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