Package org.apache.xerces.impl.xs.opti
Class SchemaParsingConfig
java.lang.Object
org.apache.xerces.util.ParserConfigurationSettings
org.apache.xerces.parsers.BasicParserConfiguration
org.apache.xerces.impl.xs.opti.SchemaParsingConfig
- All Implemented Interfaces:
org.apache.xerces.xni.parser.XMLComponentManager
,org.apache.xerces.xni.parser.XMLParserConfiguration
,org.apache.xerces.xni.parser.XMLPullParserConfiguration
public class SchemaParsingConfig
extends BasicParserConfiguration
implements org.apache.xerces.xni.parser.XMLPullParserConfiguration
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Version:
- $Id: SchemaParsingConfig.java 713638 2008-11-13 04:42:18Z mrglavas $
- Author:
- Rahul Srivastava, Sun Microsystems Inc.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final String
Feature identifier: allow Java encodings.protected static final String
Feature identifier: continue after fatal error.protected static final String
Property identifier: datatype validator factory.protected static final String
Property identifier document scanner:protected static final String
Property identifier: DTD scanner.protected static final String
Property identifier: DTD validator.protected static final String
Property identifier: entity manager.protected static final String
Property identifier: error reporter.protected boolean
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 org.apache.xerces.xni.parser.XMLDTDScanner
Current DTD scanner.protected DTDDVFactory
Current Datatype validator factory.protected org.apache.xerces.xni.parser.XMLDocumentScanner
Current scannerprotected final DTDDVFactory
The XML 1.0 Datatype validator factory.protected final XMLDTDScannerImpl
The XML 1.0 DTD scanner.protected final XMLEntityManager
Entity manager.protected final XMLErrorReporter
Error reporter.protected org.apache.xerces.xni.grammars.XMLGrammarPool
Grammar pool.protected org.apache.xerces.xni.parser.XMLInputSource
Input Sourceprotected org.apache.xerces.xni.XMLLocator
Locatorprotected final XMLNSDocumentScannerImpl
The XML 1.0 Document scanner.protected boolean
True if a parse is in progress.protected final ValidationManager
protected final XMLVersionDetector
XML version detector.protected DTDDVFactory
The XML 1.1 Datatype validator factory.protected XML11DTDScannerImpl
The XML 1.1 DTD scanner.protected XML11NSDocumentScannerImpl
The XML 1.1 Document scanner.protected static final String
Feature identifier: generate synthetic annotations.protected static final String
Feature identifier: load external DTD.protected static final String
Property identifier: locale.protected static final String
Property identifier: namespace binder.protected static final String
Feature identifier: expose schema normalized valueprotected static final String
Feature identifier: notify built-in refereces.protected static final String
Feature identifier: notify character refereces.protected static final String
Feature identifier: send element default value via characters()protected static final String
Property identifier: XML Schema validator.protected static final String
protected static final String
Feature identifier: warn on duplicate attribute definition.protected static final String
Feature identifier: warn on undeclared element definition.protected static final String
protected static final String
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
ConstructorsConstructorDescriptionDefault constructor.SchemaParsingConfig
(SymbolTable symbolTable) Constructs a parser configuration using the specified symbol table.SchemaParsingConfig
(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool) Constructs a parser configuration using the specified symbol table and grammar pool.SchemaParsingConfig
(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
Modifier and TypeMethodDescriptionprotected 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
Configures the XML 1.0 pipeline.protected void
Configures the XML 1.1 pipeline.boolean
getFeature
(String featureId) Returns the state of a feature.getProperty
(String propertyId) Returns the value of a property.boolean
parse
(boolean complete) Parses the document in a pull parsing fashion.void
parse
(org.apache.xerces.xni.parser.XMLInputSource source) Parses the specified input source.void
reset()
Reset all components before parsing.void
protected final void
Reset all XML 1.0 components before parsingprotected final void
Reset all XML 1.1 components before parsingvoid
setFeature
(String featureId, boolean state) Set the state of a feature.void
setInputSource
(org.apache.xerces.xni.parser.XMLInputSource inputSource) Sets the input source for the document to parse.void
Set the locale to use for messages.void
setProperty
(String propertyId, Object value) setPropertyMethods 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
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, setDocumentHandler, setDTDContentModelHandler, setDTDHandler, setEntityResolver, setErrorHandler
-
Field Details
-
XML11_DATATYPE_VALIDATOR_FACTORY
- See Also:
-
WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attribute definition.- See Also:
-
WARN_ON_UNDECLARED_ELEMDEF
Feature identifier: warn on undeclared element definition.- See Also:
-
ALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.- See Also:
-
CONTINUE_AFTER_FATAL_ERROR
Feature identifier: continue after fatal error.- See Also:
-
LOAD_EXTERNAL_DTD
Feature identifier: load external DTD.- See Also:
-
NOTIFY_BUILTIN_REFS
Feature identifier: notify built-in refereces.- See Also:
-
NOTIFY_CHAR_REFS
Feature identifier: notify character refereces.- See Also:
-
NORMALIZE_DATA
Feature identifier: expose schema normalized value- See Also:
-
SCHEMA_ELEMENT_DEFAULT
Feature identifier: send element default value via characters()- See Also:
-
GENERATE_SYNTHETIC_ANNOTATIONS
Feature identifier: generate synthetic annotations.- See Also:
-
ERROR_REPORTER
Property identifier: error reporter.- See Also:
-
ENTITY_MANAGER
Property identifier: entity manager.- See Also:
-
DOCUMENT_SCANNER
Property identifier document scanner:- See Also:
-
DTD_SCANNER
Property identifier: DTD scanner.- See Also:
-
XMLGRAMMAR_POOL
Property identifier: grammar pool.- See Also:
-
DTD_VALIDATOR
Property identifier: DTD validator.- See Also:
-
NAMESPACE_BINDER
Property identifier: namespace binder.- See Also:
-
DATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.- See Also:
-
VALIDATION_MANAGER
- See Also:
-
SCHEMA_VALIDATOR
Property identifier: XML Schema validator.- See Also:
-
LOCALE
Property identifier: locale.- See Also:
-
fDatatypeValidatorFactory
The XML 1.0 Datatype validator factory. -
fNamespaceScanner
The XML 1.0 Document scanner. -
fDTDScanner
The XML 1.0 DTD scanner. -
fXML11DatatypeFactory
The XML 1.1 Datatype validator factory. -
fXML11NSDocScanner
The XML 1.1 Document scanner. -
fXML11DTDScanner
The XML 1.1 DTD scanner. -
fCurrentDVFactory
Current Datatype validator factory. -
fCurrentScanner
protected org.apache.xerces.xni.parser.XMLDocumentScanner fCurrentScannerCurrent scanner -
fCurrentDTDScanner
protected org.apache.xerces.xni.parser.XMLDTDScanner fCurrentDTDScannerCurrent DTD scanner. -
fGrammarPool
protected org.apache.xerces.xni.grammars.XMLGrammarPool fGrammarPoolGrammar pool. -
fVersionDetector
XML version detector. -
fErrorReporter
Error reporter. -
fEntityManager
Entity manager. -
fInputSource
protected org.apache.xerces.xni.parser.XMLInputSource fInputSourceInput Source -
fValidationManager
-
fLocator
protected org.apache.xerces.xni.XMLLocator fLocatorLocator -
fParseInProgress
protected boolean fParseInProgressTrue 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 fConfigUpdatedfConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.
-
-
Constructor Details
-
SchemaParsingConfig
public SchemaParsingConfig()Default constructor. -
SchemaParsingConfig
Constructs a parser configuration using the specified symbol table.- Parameters:
symbolTable
- The symbol table to use.
-
SchemaParsingConfig
public SchemaParsingConfig(SymbolTable symbolTable, org.apache.xerces.xni.grammars.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, 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.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 Details
-
getFeature
public boolean getFeature(String featureId) throws org.apache.xerces.xni.parser.XMLConfigurationException Returns the state of a feature.- Specified by:
getFeature
in interfaceorg.apache.xerces.xni.parser.XMLComponentManager
- Specified by:
getFeature
in interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Overrides:
getFeature
in classParserConfigurationSettings
- 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 interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Overrides:
setFeature
in classBasicParserConfiguration
- 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.
-
getProperty
public Object getProperty(String propertyId) throws org.apache.xerces.xni.parser.XMLConfigurationException Returns the value of a property.- Specified by:
getProperty
in interfaceorg.apache.xerces.xni.parser.XMLComponentManager
- Specified by:
getProperty
in interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Overrides:
getProperty
in classParserConfigurationSettings
- Parameters:
propertyId
- The property identifier.- Returns:
- the value of the property
- 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.
-
setProperty
public void setProperty(String propertyId, Object value) throws org.apache.xerces.xni.parser.XMLConfigurationException setProperty- Specified by:
setProperty
in interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Overrides:
setProperty
in classBasicParserConfiguration
- Parameters:
propertyId
-value
-- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- If the requested feature is not known.
-
setLocale
Set the locale to use for messages.- Specified by:
setLocale
in interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Overrides:
setLocale
in classBasicParserConfiguration
- Parameters:
locale
- The locale object to use for localization of messages.- Throws:
org.apache.xerces.xni.XNIException
- Thrown if the parser does not support the specified locale.
-
setInputSource
public void setInputSource(org.apache.xerces.xni.parser.XMLInputSource inputSource) throws org.apache.xerces.xni.parser.XMLConfigurationException, IOException Sets the input source for the document to parse.- Specified by:
setInputSource
in interfaceorg.apache.xerces.xni.parser.XMLPullParserConfiguration
- Parameters:
inputSource
- The document's input source.- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- Thrown if there is a configuration error when initializing the parser.IOException
- Thrown on I/O error.- See Also:
-
parse
Parses the document in a pull parsing fashion.- Specified by:
parse
in interfaceorg.apache.xerces.xni.parser.XMLPullParserConfiguration
- Parameters:
complete
- True if the pull parser should parse the remaining document completely.- Returns:
- True if there is more document to parse.
- Throws:
org.apache.xerces.xni.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:
-
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 interfaceorg.apache.xerces.xni.parser.XMLPullParserConfiguration
-
parse
public void parse(org.apache.xerces.xni.parser.XMLInputSource source) throws org.apache.xerces.xni.XNIException, IOException Parses the specified input source.- Specified by:
parse
in interfaceorg.apache.xerces.xni.parser.XMLParserConfiguration
- Specified by:
parse
in classBasicParserConfiguration
- Parameters:
source
- The input source.- Throws:
org.apache.xerces.xni.XNIException
- Throws exception on XNI error.IOException
- Throws exception on i/o error.
-
reset
public void reset() throws org.apache.xerces.xni.XNIExceptionReset all components before parsing.- Overrides:
reset
in classBasicParserConfiguration
- Throws:
org.apache.xerces.xni.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 org.apache.xerces.xni.parser.XMLConfigurationException Check a feature. If feature is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.- Overrides:
checkFeature
in classBasicParserConfiguration
- Parameters:
featureId
- The unique identifier (URI) of the feature.- 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.
-
checkProperty
protected void checkProperty(String propertyId) throws org.apache.xerces.xni.parser.XMLConfigurationException Check a property. If the property is know and supported, this method simply returns. Otherwise, the appropriate exception is thrown.- Overrides:
checkProperty
in classBasicParserConfiguration
- Parameters:
propertyId
- The unique identifier (URI) of the property being set.- 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.
-
resetXML10
protected final void resetXML10() throws org.apache.xerces.xni.XNIExceptionReset all XML 1.0 components before parsing- Throws:
org.apache.xerces.xni.XNIException
-
resetXML11
protected final void resetXML11() throws org.apache.xerces.xni.XNIExceptionReset all XML 1.1 components before parsing- Throws:
org.apache.xerces.xni.XNIException
-
resetNodePool
public void resetNodePool()
-