Class XML11Configuration
- java.lang.Object
-
- org.smooks.engine.delivery.sax.ng.org.apache.xerces.util.ParserConfigurationSettings
-
- org.smooks.engine.delivery.sax.ng.org.apache.xerces.parsers.XML11Configuration
-
- All Implemented Interfaces:
XML11Configurable,XMLComponentManager,XMLParserConfiguration,XMLPullParserConfiguration
- Direct Known Subclasses:
XIncludeAwareParserConfiguration,XIncludeParserConfiguration,XPointerParserConfiguration
public class XML11Configuration extends ParserConfigurationSettings implements XMLPullParserConfiguration, XML11Configurable
This class is the configuration used to parse XML 1.0 and XML 1.1 documents.- Version:
- $Id$
- Author:
- Elena Litani, IBM, Neil Graham, IBM, Michael Glavassevich, IBM
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringALLOW_JAVA_ENCODINGSFeature identifier: allow Java encodings.protected static StringCONTINUE_AFTER_FATAL_ERRORFeature identifier: continue after fatal error.protected static StringDATATYPE_VALIDATOR_FACTORYProperty identifier: datatype validator factory.protected static StringDOCUMENT_SCANNERProperty identifier document scanner:protected static StringDTD_PROCESSORProperty identifier: DTD loader.protected static StringDTD_SCANNERProperty identifier: DTD scanner.protected static StringDTD_VALIDATORProperty identifier: DTD validator.protected static StringENTITY_MANAGERProperty identifier: entity manager.protected static StringENTITY_RESOLVERProperty identifier: entity resolver.protected static StringERROR_HANDLERProperty identifier: error handler.protected static StringERROR_REPORTERProperty identifier: error reporter.protected static StringEXTERNAL_GENERAL_ENTITIESFeature identifier: external general entities.protected static StringEXTERNAL_PARAMETER_ENTITIESFeature identifier: external parameter entities.protected ArrayListfCommonComponentsCommon components: XMLEntityManager, XMLErrorReporter, XMLSchemaValidatorprotected ArrayListfComponentsXML 1.0 Components.protected booleanfConfigUpdatedfConfigUpdated is set to true if there has been any change to the configuration settings, i.e a feature or a property was changed.protected XMLDTDScannerfCurrentDTDScannerCurrent DTD scanner.protected DTDDVFactoryfCurrentDVFactoryCurrent Datatype validator factory.protected XMLDocumentScannerfCurrentScannerCurrent scannerprotected DTDDVFactoryfDatatypeValidatorFactoryThe XML 1.0 Datatype validator factory.protected XMLDocumentHandlerfDocumentHandlerThe document handler.protected XMLDTDContentModelHandlerfDTDContentModelHandlerThe DTD content model handler.protected XMLDTDHandlerfDTDHandlerThe DTD handler.protected XMLDTDProcessorfDTDProcessorThe XML 1.0 DTD Processor .protected XMLDTDScannerfDTDScannerThe XML 1.0 DTD scanner.protected XMLDTDValidatorfDTDValidatorThe XML 1.0 DTD Validator: binds namespacesprotected XMLEntityManagerfEntityManagerEntity manager.protected XMLErrorReporterfErrorReporterError reporter.protected XMLGrammarPoolfGrammarPoolGrammar pool.protected XMLInputSourcefInputSourceprotected XMLDocumentSourcefLastComponentLast component in the document pipelineprotected LocalefLocaleprotected XMLNSDocumentScannerImplfNamespaceScannerThe XML 1.0 Document scanner that does namespace binding.protected XMLDTDValidatorfNonNSDTDValidatorThe XML 1.0 DTD Validator that does not bind namespacesprotected XMLDocumentScannerImplfNonNSScannerThe XML 1.0 Non-namespace implementation of scannerprotected booleanfParseInProgressTrue if a parse is in progress.protected XMLSchemaValidatorfSchemaValidatorXML Schema Validator.protected SymbolTablefSymbolTableprotected ValidationManagerfValidationManagerprotected XMLVersionDetectorfVersionDetectorprotected ArrayListfXML11ComponentsXML 1.1.protected DTDDVFactoryfXML11DatatypeFactoryThe XML 1.1 datatype factory.protected XML11DocumentScannerImplfXML11DocScannerThe XML 1.1 document scanner that does not do namespace binding.protected XML11DTDProcessorfXML11DTDProcessorThe XML 1.1 DTD processor.protected XML11DTDScannerImplfXML11DTDScannerThe XML 1.1 DTD scanner.protected XML11DTDValidatorfXML11DTDValidatorThe XML 1.1 DTD validator that does not do namespace binding.protected XML11NSDocumentScannerImplfXML11NSDocScannerThe XML 1.1 document scanner that does namespace binding.protected XML11NSDTDValidatorfXML11NSDTDValidatorThe XML 1.1 DTD validator that does namespace binding.protected static StringGENERATE_SYNTHETIC_ANNOTATIONSFeature: generate synthetic annotationsprotected static StringHONOUR_ALL_SCHEMALOCATIONSFeature identifier: honour all schemaLocationsprotected static StringID_IDREF_CHECKINGFeature identifier: whether to ignore ID/IDREF errorsprotected static StringIDENTITY_CONSTRAINT_CHECKINGFeature identifier: whether to ignore identity constraint errorsprotected static StringIGNORE_XSI_TYPEFeature identifier: whether to ignore xsi:type attributes until a global element declaration is encounteredprotected static StringJAXP_SCHEMA_LANGUAGEProperty identifier: JAXP schema language / DOM schema-type.protected static StringJAXP_SCHEMA_SOURCEProperty identifier: JAXP schema source/ DOM schema-location.protected static StringLOAD_EXTERNAL_DTDFeature identifier: load external DTD.protected static StringLOCALEProperty identifier: locale.protected static StringNAMESPACE_BINDERProperty identifier: namespace binder.protected static StringNAMESPACE_GROWTHFeature identifier: namespace growthprotected static StringNAMESPACESFeature identifier: namespaces.protected static StringNORMALIZE_DATAFeature identifier: expose schema normalized valueprotected static StringNOTIFY_BUILTIN_REFSFeature identifier: notify built-in refereces.protected static StringNOTIFY_CHAR_REFSFeature identifier: notify character refereces.protected static booleanPRINT_EXCEPTION_STACK_TRACESet to true and recompile to print exception stack trace.protected static StringROOT_ELEMENT_DECLProperty identifier: root element declaration.protected static StringROOT_TYPE_DEFProperty identifier: root type definition.protected static StringSCHEMA_AUGMENT_PSVIFeature identifier: augment PSVIprotected static StringSCHEMA_DV_FACTORYProperty identifier: Schema DV Factoryprotected static StringSCHEMA_ELEMENT_DEFAULTFeature identifier: send element default value via characters()protected static StringSCHEMA_LOCATIONProperty identifier: schema location.protected static StringSCHEMA_NONS_LOCATIONProperty identifier: no namespace schema location.protected static StringSCHEMA_VALIDATORProperty identifier: XML Schema validator.protected static StringSYMBOL_TABLEProperty identifier: symbol table.protected static StringTOLERATE_DUPLICATESFeature identifier: tolerate duplicatesprotected static StringUNPARSED_ENTITY_CHECKINGFeature identifier: whether to ignore unparsed entity errorsprotected static StringUSE_GRAMMAR_POOL_ONLYFeature identifier: use grammar pool onlyprotected static StringVALIDATE_ANNOTATIONSFeature identifier: validate annotationsprotected static StringVALIDATIONFeature identifier: validation.protected static StringVALIDATION_MANAGERprotected static StringWARN_ON_DUPLICATE_ATTDEFFeature identifier: warn on duplicate attribute definition.protected static StringWARN_ON_DUPLICATE_ENTITYDEFFeature identifier: warn on duplicate entity definition.protected static StringWARN_ON_UNDECLARED_ELEMDEFFeature identifier: warn on undeclared element definition.protected static StringXML_STRINGProperty identifier: xml string.protected static StringXML11_DATATYPE_VALIDATOR_FACTORYprotected static StringXMLGRAMMAR_POOLProperty identifier: grammar pool.protected static StringXMLSCHEMA_FULL_CHECKINGfeature identifier: XML Schema validation -- full checkingprotected static StringXMLSCHEMA_VALIDATIONfeature identifier: XML Schema validation-
Fields inherited from class org.smooks.engine.delivery.sax.ng.org.apache.xerces.util.ParserConfigurationSettings
fFeatures, fParentSettings, fProperties, fRecognizedFeatures, fRecognizedProperties, PARSER_SETTINGS
-
-
Constructor Summary
Constructors Constructor Description XML11Configuration()Default constructor.XML11Configuration(SymbolTable symbolTable)Constructs a parser configuration using the specified symbol table.XML11Configuration(SymbolTable symbolTable, XMLGrammarPool grammarPool)Constructs a parser configuration using the specified symbol table and grammar pool.XML11Configuration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings)Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddCommonComponent(XMLComponent component)Adds common component to the parser configuration.protected voidaddComponent(XMLComponent component)Adds a component to the parser configuration.protected voidaddRecognizedParamsAndSetDefaults(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.protected voidaddXML11Component(XMLComponent component)Adds an XML 1.1 component to the parser configuration.protected voidcheckFeature(String featureId)Check a feature.protected voidcheckProperty(String propertyId)Check a property.voidcleanup()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 voidconfigurePipeline()Configures the pipeline.protected voidconfigureXML11Pipeline()Configures the XML 1.1 pipeline.XMLDocumentHandlergetDocumentHandler()Returns the registered document handler.XMLDTDContentModelHandlergetDTDContentModelHandler()Returns the registered DTD content model handler.XMLDTDHandlergetDTDHandler()Returns the registered DTD handler.XMLEntityResolvergetEntityResolver()Return the current entity resolver.XMLErrorHandlergetErrorHandler()Return the current error handler.booleangetFeature(String featureId)Returns the state of a feature.LocalegetLocale()Returns the locale.ObjectgetProperty(String propertyId)Returns the value of a property.booleanparse(boolean complete)Parses the document in a pull parsing fashion.voidparse(XMLInputSource source)Parses the specified input source.protected voidreset()reset all XML 1.0 components before parsing and namespace contextprotected voidresetCommon()reset all common components before parsingprotected voidresetXML11()reset all components before parsing and namespace contextvoidsetDocumentHandler(XMLDocumentHandler documentHandler)Sets the document handler on the last component in the pipeline to receive information about the document.voidsetDTDContentModelHandler(XMLDTDContentModelHandler handler)Sets the DTD content model handler.voidsetDTDHandler(XMLDTDHandler dtdHandler)Sets the DTD handler.voidsetEntityResolver(XMLEntityResolver resolver)Sets the resolver used to resolve external entities.voidsetErrorHandler(XMLErrorHandler errorHandler)Allow an application to register an error event handler.voidsetFeature(String featureId, boolean state)Set the state of a feature.voidsetInputSource(XMLInputSource inputSource)Sets the input source for the document to parse.voidsetLocale(Locale locale)Set the locale to use for messages.voidsetProperty(String propertyId, Object value)setProperty-
Methods inherited from class org.smooks.engine.delivery.sax.ng.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.smooks.engine.delivery.sax.ng.org.apache.xerces.xni.parser.XMLParserConfiguration
addRecognizedFeatures, addRecognizedProperties
-
-
-
-
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_DUPLICATE_ENTITYDEF
protected static final String WARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate entity 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
-
SCHEMA_AUGMENT_PSVI
protected static final String SCHEMA_AUGMENT_PSVI
Feature identifier: augment PSVI- See Also:
- Constant Field Values
-
XMLSCHEMA_VALIDATION
protected static final String XMLSCHEMA_VALIDATION
feature identifier: XML Schema validation- See Also:
- Constant Field Values
-
XMLSCHEMA_FULL_CHECKING
protected static final String XMLSCHEMA_FULL_CHECKING
feature identifier: XML Schema validation -- full checking- See Also:
- Constant Field Values
-
GENERATE_SYNTHETIC_ANNOTATIONS
protected static final String GENERATE_SYNTHETIC_ANNOTATIONS
Feature: generate synthetic annotations- See Also:
- Constant Field Values
-
VALIDATE_ANNOTATIONS
protected static final String VALIDATE_ANNOTATIONS
Feature identifier: validate annotations- See Also:
- Constant Field Values
-
HONOUR_ALL_SCHEMALOCATIONS
protected static final String HONOUR_ALL_SCHEMALOCATIONS
Feature identifier: honour all schemaLocations- See Also:
- Constant Field Values
-
NAMESPACE_GROWTH
protected static final String NAMESPACE_GROWTH
Feature identifier: namespace growth- See Also:
- Constant Field Values
-
TOLERATE_DUPLICATES
protected static final String TOLERATE_DUPLICATES
Feature identifier: tolerate duplicates- See Also:
- Constant Field Values
-
USE_GRAMMAR_POOL_ONLY
protected static final String USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only- See Also:
- Constant Field Values
-
VALIDATION
protected static final String VALIDATION
Feature identifier: validation.- See Also:
- Constant Field Values
-
NAMESPACES
protected static final String NAMESPACES
Feature identifier: namespaces.- See Also:
- Constant Field Values
-
EXTERNAL_GENERAL_ENTITIES
protected static final String EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities.- See Also:
- Constant Field Values
-
EXTERNAL_PARAMETER_ENTITIES
protected static final String EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities.- See Also:
- Constant Field Values
-
IGNORE_XSI_TYPE
protected static final String IGNORE_XSI_TYPE
Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered- See Also:
- Constant Field Values
-
ID_IDREF_CHECKING
protected static final String ID_IDREF_CHECKING
Feature identifier: whether to ignore ID/IDREF errors- See Also:
- Constant Field Values
-
UNPARSED_ENTITY_CHECKING
protected static final String UNPARSED_ENTITY_CHECKING
Feature identifier: whether to ignore unparsed entity errors- See Also:
- Constant Field Values
-
IDENTITY_CONSTRAINT_CHECKING
protected static final String IDENTITY_CONSTRAINT_CHECKING
Feature identifier: whether to ignore identity constraint errors- See Also:
- Constant Field Values
-
XML_STRING
protected static final String XML_STRING
Property identifier: xml string.- See Also:
- Constant Field Values
-
SYMBOL_TABLE
protected static final String SYMBOL_TABLE
Property identifier: symbol table.- See Also:
- Constant Field Values
-
ERROR_HANDLER
protected static final String ERROR_HANDLER
Property identifier: error handler.- See Also:
- Constant Field Values
-
ENTITY_RESOLVER
protected static final String ENTITY_RESOLVER
Property identifier: entity resolver.- See Also:
- Constant Field Values
-
SCHEMA_VALIDATOR
protected static final String SCHEMA_VALIDATOR
Property identifier: XML Schema validator.- See Also:
- Constant Field Values
-
SCHEMA_LOCATION
protected static final String SCHEMA_LOCATION
Property identifier: schema location.- See Also:
- Constant Field Values
-
SCHEMA_NONS_LOCATION
protected static final String SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.- 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_PROCESSOR
protected static final String DTD_PROCESSOR
Property identifier: DTD loader.- 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
-
JAXP_SCHEMA_LANGUAGE
protected static final String JAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language / DOM schema-type.- See Also:
- Constant Field Values
-
JAXP_SCHEMA_SOURCE
protected static final String JAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source/ DOM schema-location.- See Also:
- Constant Field Values
-
LOCALE
protected static final String LOCALE
Property identifier: locale.- See Also:
- Constant Field Values
-
ROOT_TYPE_DEF
protected static final String ROOT_TYPE_DEF
Property identifier: root type definition.- See Also:
- Constant Field Values
-
ROOT_ELEMENT_DECL
protected static final String ROOT_ELEMENT_DECL
Property identifier: root element declaration.- See Also:
- Constant Field Values
-
SCHEMA_DV_FACTORY
protected static final String SCHEMA_DV_FACTORY
Property identifier: Schema DV Factory- See Also:
- Constant Field Values
-
PRINT_EXCEPTION_STACK_TRACE
protected static final boolean PRINT_EXCEPTION_STACK_TRACE
Set to true and recompile to print exception stack trace.- See Also:
- Constant Field Values
-
fSymbolTable
protected SymbolTable fSymbolTable
-
fInputSource
protected XMLInputSource fInputSource
-
fValidationManager
protected final ValidationManager fValidationManager
-
fVersionDetector
protected final XMLVersionDetector fVersionDetector
-
fLocale
protected Locale fLocale
-
fComponents
protected final ArrayList fComponents
XML 1.0 Components.
-
fXML11Components
protected final ArrayList fXML11Components
XML 1.1. Components.
-
fCommonComponents
protected final ArrayList fCommonComponents
Common components: XMLEntityManager, XMLErrorReporter, XMLSchemaValidator
-
fDocumentHandler
protected XMLDocumentHandler fDocumentHandler
The document handler.
-
fDTDHandler
protected XMLDTDHandler fDTDHandler
The DTD handler.
-
fDTDContentModelHandler
protected XMLDTDContentModelHandler fDTDContentModelHandler
The DTD content model handler.
-
fLastComponent
protected XMLDocumentSource fLastComponent
Last component in the document pipeline
-
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.
-
fDatatypeValidatorFactory
protected final DTDDVFactory fDatatypeValidatorFactory
The XML 1.0 Datatype validator factory.
-
fNamespaceScanner
protected final XMLNSDocumentScannerImpl fNamespaceScanner
The XML 1.0 Document scanner that does namespace binding.
-
fNonNSScanner
protected XMLDocumentScannerImpl fNonNSScanner
The XML 1.0 Non-namespace implementation of scanner
-
fDTDValidator
protected final XMLDTDValidator fDTDValidator
The XML 1.0 DTD Validator: binds namespaces
-
fNonNSDTDValidator
protected XMLDTDValidator fNonNSDTDValidator
The XML 1.0 DTD Validator that does not bind namespaces
-
fDTDScanner
protected final XMLDTDScanner fDTDScanner
The XML 1.0 DTD scanner.
-
fDTDProcessor
protected final XMLDTDProcessor fDTDProcessor
The XML 1.0 DTD Processor .
-
fXML11DatatypeFactory
protected DTDDVFactory fXML11DatatypeFactory
The XML 1.1 datatype factory.
-
fXML11NSDocScanner
protected XML11NSDocumentScannerImpl fXML11NSDocScanner
The XML 1.1 document scanner that does namespace binding.
-
fXML11DocScanner
protected XML11DocumentScannerImpl fXML11DocScanner
The XML 1.1 document scanner that does not do namespace binding.
-
fXML11NSDTDValidator
protected XML11NSDTDValidator fXML11NSDTDValidator
The XML 1.1 DTD validator that does namespace binding.
-
fXML11DTDValidator
protected XML11DTDValidator fXML11DTDValidator
The XML 1.1 DTD validator that does not do namespace binding.
-
fXML11DTDScanner
protected XML11DTDScannerImpl fXML11DTDScanner
The XML 1.1 DTD scanner.
-
fXML11DTDProcessor
protected XML11DTDProcessor fXML11DTDProcessor
The XML 1.1 DTD processor.
-
fGrammarPool
protected XMLGrammarPool fGrammarPool
Grammar pool.
-
fErrorReporter
protected XMLErrorReporter fErrorReporter
Error reporter.
-
fEntityManager
protected XMLEntityManager fEntityManager
Entity manager.
-
fSchemaValidator
protected XMLSchemaValidator fSchemaValidator
XML Schema Validator.
-
fCurrentScanner
protected XMLDocumentScanner fCurrentScanner
Current scanner
-
fCurrentDVFactory
protected DTDDVFactory fCurrentDVFactory
Current Datatype validator factory.
-
fCurrentDTDScanner
protected XMLDTDScanner fCurrentDTDScanner
Current DTD scanner.
-
-
Constructor Detail
-
XML11Configuration
public XML11Configuration()
Default constructor.
-
XML11Configuration
public XML11Configuration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.- Parameters:
symbolTable- The symbol table to use.
-
XML11Configuration
public XML11Configuration(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.
-
XML11Configuration
public XML11Configuration(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
-
setInputSource
public void setInputSource(XMLInputSource inputSource) throws XMLConfigurationException, IOException
Sets the input source for the document to parse.- Specified by:
setInputSourcein interfaceXMLPullParserConfiguration- 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)
-
setLocale
public void setLocale(Locale locale) throws XNIException
Set the locale to use for messages.- Specified by:
setLocalein interfaceXMLParserConfiguration- Parameters:
locale- The locale object to use for localization of messages.- Throws:
XNIException- Thrown if the parser does not support the specified locale.
-
setDocumentHandler
public void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler on the last component in the pipeline to receive information about the document.- Specified by:
setDocumentHandlerin interfaceXMLParserConfiguration- Parameters:
documentHandler- The document handler.
-
getDocumentHandler
public XMLDocumentHandler getDocumentHandler()
Returns the registered document handler.- Specified by:
getDocumentHandlerin interfaceXMLParserConfiguration
-
setDTDHandler
public void setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.- Specified by:
setDTDHandlerin interfaceXMLParserConfiguration- Parameters:
dtdHandler- The DTD handler.
-
getDTDHandler
public XMLDTDHandler getDTDHandler()
Returns the registered DTD handler.- Specified by:
getDTDHandlerin interfaceXMLParserConfiguration
-
setDTDContentModelHandler
public void setDTDContentModelHandler(XMLDTDContentModelHandler handler)
Sets the DTD content model handler.- Specified by:
setDTDContentModelHandlerin interfaceXMLParserConfiguration- Parameters:
handler- The DTD content model handler.
-
getDTDContentModelHandler
public XMLDTDContentModelHandler getDTDContentModelHandler()
Returns the registered DTD content model handler.- Specified by:
getDTDContentModelHandlerin interfaceXMLParserConfiguration
-
setEntityResolver
public void setEntityResolver(XMLEntityResolver resolver)
Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.- Specified by:
setEntityResolverin interfaceXMLParserConfiguration- Parameters:
resolver- The new entity resolver. Passing a null value will uninstall the currently installed resolver.
-
getEntityResolver
public XMLEntityResolver getEntityResolver()
Return the current entity resolver.- Specified by:
getEntityResolverin interfaceXMLParserConfiguration- Returns:
- The current entity resolver, or null if none has been registered.
- See Also:
setEntityResolver(org.smooks.engine.delivery.sax.ng.org.apache.xerces.xni.parser.XMLEntityResolver)
-
setErrorHandler
public void setErrorHandler(XMLErrorHandler errorHandler)
Allow an application to register an error event handler.If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
- Specified by:
setErrorHandlerin interfaceXMLParserConfiguration- Parameters:
errorHandler- The error handler.- Throws:
NullPointerException- If the handler argument is null.- See Also:
getErrorHandler()
-
getErrorHandler
public XMLErrorHandler getErrorHandler()
Return the current error handler.- Specified by:
getErrorHandlerin interfaceXMLParserConfiguration- Returns:
- The current error handler, or null if none has been registered.
- See Also:
setErrorHandler(org.smooks.engine.delivery.sax.ng.org.apache.xerces.xni.parser.XMLErrorHandler)
-
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:
cleanupin interfaceXMLPullParserConfiguration
-
parse
public void parse(XMLInputSource source) throws XNIException, IOException
Parses the specified input source.- Specified by:
parsein interfaceXMLParserConfiguration- Parameters:
source- The input source.- Throws:
XNIException- Throws exception on XNI error.IOException- Throws exception on i/o error.
-
parse
public boolean parse(boolean complete) throws XNIException, IOExceptionDescription copied from interface:XMLPullParserConfigurationParses the document in a pull parsing fashion.- Specified by:
parsein interfaceXMLPullParserConfiguration- 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:
XMLPullParserConfiguration.setInputSource(org.smooks.engine.delivery.sax.ng.org.apache.xerces.xni.parser.XMLInputSource)
-
getFeature
public boolean getFeature(String featureId) throws XMLConfigurationException
Returns the state of a feature.- Specified by:
getFeaturein interfaceXMLComponentManager- Specified by:
getFeaturein interfaceXMLParserConfiguration- Overrides:
getFeaturein classParserConfigurationSettings- 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:
setFeaturein interfaceXMLParserConfiguration- Overrides:
setFeaturein classParserConfigurationSettings- 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.
-
getProperty
public Object getProperty(String propertyId) throws XMLConfigurationException
Returns the value of a property.- Specified by:
getPropertyin interfaceXMLComponentManager- Specified by:
getPropertyin interfaceXMLParserConfiguration- Overrides:
getPropertyin classParserConfigurationSettings- Parameters:
propertyId- The property identifier.- Returns:
- the value of the property
- Throws:
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 XMLConfigurationException
setProperty- Specified by:
setPropertyin interfaceXMLParserConfiguration- Overrides:
setPropertyin classParserConfigurationSettings- Parameters:
propertyId-value-- Throws:
XMLConfigurationException- If the requested feature is not known.
-
getLocale
public Locale getLocale()
Returns the locale.- Specified by:
getLocalein interfaceXMLParserConfiguration
-
reset
protected void reset() throws XNIExceptionreset all XML 1.0 components before parsing and namespace context- Throws:
XNIException
-
resetCommon
protected void resetCommon() throws XNIExceptionreset all common components before parsing- Throws:
XNIException
-
resetXML11
protected void resetXML11() throws XNIExceptionreset all components before parsing and namespace context- Throws:
XNIException
-
configureXML11Pipeline
protected void configureXML11Pipeline()
Configures the XML 1.1 pipeline. Note: this method also resets the new XML11 components.
-
configurePipeline
protected void configurePipeline()
Configures the 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:
checkFeaturein classParserConfigurationSettings- 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:
checkPropertyin classParserConfigurationSettings- 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.
-
addComponent
protected void addComponent(XMLComponent component)
Adds a component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.- Parameters:
component- The component to add.
-
addCommonComponent
protected void addCommonComponent(XMLComponent component)
Adds common component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.- Parameters:
component- The component to add.
-
addXML11Component
protected void addXML11Component(XMLComponent component)
Adds an XML 1.1 component to the parser configuration. This method will also add all of the component's recognized features and properties to the list of default recognized features and properties.- Parameters:
component- The component to add.
-
addRecognizedParamsAndSetDefaults
protected 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- The component whose recognized features and properties will be added to the configuration
-
-