Class DOMConfigurationImpl
- java.lang.Object
-
- org.smooks.engine.delivery.sax.ng.org.apache.xerces.util.ParserConfigurationSettings
-
- org.smooks.engine.delivery.sax.ng.org.apache.xerces.dom.DOMConfigurationImpl
-
- All Implemented Interfaces:
XMLComponentManager,XMLParserConfiguration,DOMConfiguration
public class DOMConfigurationImpl extends ParserConfigurationSettings implements XMLParserConfiguration, DOMConfiguration
Xerces implementation of DOMConfiguration that maintains a table of recognized parameters.- Version:
- $Id$
- Author:
- Elena Litani, IBM, Neeraj Bajaj, Sun Microsystems.
-
-
Field Summary
Fields Modifier and Type Field Description protected static StringBALANCE_SYNTAX_TREESFeature identifier: balance syntax trees.protected static shortCDATAprotected static shortCOMMENTSprotected static StringDISALLOW_DOCTYPE_DECL_FEATUREFeature identifier: load external DTD.protected static StringDTD_VALIDATOR_FACTORY_PROPERTYProperty identifier: datatype validator factory.protected static StringDTD_VALIDATOR_PROPERTYProperty identifier: DTD validator.protected static shortDTNORMALIZATIONprotected static StringDYNAMIC_VALIDATIONprotected static shortENTITIESprotected 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 ArrayListfComponentsComponents.protected DTDDVFactoryfCurrentDVFactoryCurrent Datatype validator factory.protected DTDDVFactoryfDatatypeValidatorFactoryThe XML 1.0 Datatype validator factory.protected shortfeaturesNormalization featuresprotected DOMErrorHandlerWrapperfErrorHandlerWrapperprotected XMLErrorReporterfErrorReporterError reporterprotected LocalefLocaleLocale.protected SymbolTablefSymbolTableSymbol table.protected ValidationManagerfValidationManagerprotected DTDDVFactoryfXML11DatatypeFactoryThe XML 1.1 Datatype validator factory.protected static StringGENERATE_SYNTHETIC_ANNOTATIONSFeature: generate synthetic annotationsprotected static StringGRAMMAR_POOLProperty id: Grammar pool.protected static StringHONOUR_ALL_SCHEMALOCATIONSFeature identifier: honour all schemaLocationsprotected static shortINFOSET_FALSE_PARAMSprotected static shortINFOSET_MASKprotected static shortINFOSET_TRUE_PARAMSprotected 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 StringNAMESPACE_GROWTHFeature identifier: namespace growthprotected static shortNAMESPACESprotected static StringNORMALIZE_DATAprotected static shortNSDECLprotected static shortPSVIprotected static StringSCHEMAprotected static StringSCHEMA_DV_FACTORYProperty identifier: Schema DV Factoryprotected static StringSCHEMA_ELEMENT_DEFAULTFeature identifier: send element default value via characters()protected static StringSCHEMA_FULL_CHECKINGprotected static StringSCHEMA_LOCATIONProperty identifier: schema location.protected static StringSCHEMA_NONS_LOCATIONProperty identifier: no namespace schema location.protected static StringSECURITY_MANAGERproperty identifier: security manager.protected static StringSEND_PSVIsending psvi in the pipelineprotected static shortSPLITCDATAprotected static StringSYMBOL_TABLEProperty identifier: symbol table.protected static StringTOLERATE_DUPLICATESprotected static StringUSE_GRAMMAR_POOL_ONLYFeature identifier: use grammar pool onlyprotected static shortVALIDATEprotected static StringVALIDATE_ANNOTATIONSFeature identifier: validate annotationsprotected static StringVALIDATION_MANAGERprotected static StringWARN_ON_DUPLICATE_ATTDEFFeature identifier: warn on duplicate attribute definition.protected static shortWELLFORMEDprotected static StringXERCES_NAMESPACESFeature identifier: namespaces.protected static StringXERCES_VALIDATIONFeature identifier: validation.protected static StringXML_STRINGProperty identifier: xml string.protected static StringXML11_DATATYPE_VALIDATOR_FACTORY-
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 Modifier Constructor Description protectedDOMConfigurationImpl()Default Constructor.protectedDOMConfigurationImpl(SymbolTable symbolTable)Constructs a parser configuration using the specified symbol table.protectedDOMConfigurationImpl(SymbolTable symbolTable, XMLComponentManager parentSettings)Constructs a parser configuration using the specified symbol table and parent settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddComponent(XMLComponent component)booleancanSetParameter(String name, Object value)DOM Level 3 WD - Experimental.protected voidcheckProperty(String propertyId)Check a property.protected ValidationManagercreateValidationManager()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.ObjectgetParameter(String name)DOM Level 3 WD - Experimental.DOMStringListgetParameterNames()DOM Level 3 CR - Experimental.voidparse(XMLInputSource inputSource)Parse an XML document.protected voidreset()reset all components before parsingvoidsetDocumentHandler(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.protected voidsetDTDValidatorFactory(String version)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.voidsetLocale(Locale locale)Set the locale to use for messages.voidsetParameter(String name, Object value)DOM Level 3 WD - Experimental.voidsetProperty(String propertyId, Object value)setProperty-
Methods inherited from class org.smooks.engine.delivery.sax.ng.org.apache.xerces.util.ParserConfigurationSettings
addRecognizedFeatures, addRecognizedProperties, checkFeature, getProperty
-
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, getProperty
-
-
-
-
Field Detail
-
XML11_DATATYPE_VALIDATOR_FACTORY
protected static final String XML11_DATATYPE_VALIDATOR_FACTORY
- See Also:
- Constant Field Values
-
XERCES_VALIDATION
protected static final String XERCES_VALIDATION
Feature identifier: validation.- See Also:
- Constant Field Values
-
XERCES_NAMESPACES
protected static final String XERCES_NAMESPACES
Feature identifier: namespaces.- See Also:
- Constant Field Values
-
SCHEMA
protected static final String SCHEMA
- See Also:
- Constant Field Values
-
SCHEMA_FULL_CHECKING
protected static final String SCHEMA_FULL_CHECKING
- See Also:
- Constant Field Values
-
DYNAMIC_VALIDATION
protected static final String DYNAMIC_VALIDATION
- See Also:
- Constant Field Values
-
NORMALIZE_DATA
protected static final String NORMALIZE_DATA
- 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
-
SEND_PSVI
protected static final String SEND_PSVI
sending psvi in the pipeline- 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
-
USE_GRAMMAR_POOL_ONLY
protected static final String USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only- See Also:
- Constant Field Values
-
DISALLOW_DOCTYPE_DECL_FEATURE
protected static final String DISALLOW_DOCTYPE_DECL_FEATURE
Feature identifier: load external DTD.- See Also:
- Constant Field Values
-
BALANCE_SYNTAX_TREES
protected static final String BALANCE_SYNTAX_TREES
Feature identifier: balance syntax trees.- 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
-
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
- See Also:
- Constant Field Values
-
ENTITY_MANAGER
protected static final String ENTITY_MANAGER
Property identifier: entity manager.- See Also:
- Constant Field Values
-
ERROR_REPORTER
protected static final String ERROR_REPORTER
Property identifier: error reporter.- 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
-
GRAMMAR_POOL
protected static final String GRAMMAR_POOL
Property id: Grammar pool.- See Also:
- Constant Field Values
-
SECURITY_MANAGER
protected static final String SECURITY_MANAGER
property identifier: security manager.- 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
-
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
-
DTD_VALIDATOR_PROPERTY
protected static final String DTD_VALIDATOR_PROPERTY
Property identifier: DTD validator.- See Also:
- Constant Field Values
-
DTD_VALIDATOR_FACTORY_PROPERTY
protected static final String DTD_VALIDATOR_FACTORY_PROPERTY
Property identifier: datatype validator factory.- See Also:
- Constant Field Values
-
VALIDATION_MANAGER
protected static final String VALIDATION_MANAGER
- 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
-
SCHEMA_DV_FACTORY
protected static final String SCHEMA_DV_FACTORY
Property identifier: Schema DV Factory- See Also:
- Constant Field Values
-
features
protected short features
Normalization features
-
NAMESPACES
protected static final short NAMESPACES
- See Also:
- Constant Field Values
-
DTNORMALIZATION
protected static final short DTNORMALIZATION
- See Also:
- Constant Field Values
-
ENTITIES
protected static final short ENTITIES
- See Also:
- Constant Field Values
-
CDATA
protected static final short CDATA
- See Also:
- Constant Field Values
-
SPLITCDATA
protected static final short SPLITCDATA
- See Also:
- Constant Field Values
-
COMMENTS
protected static final short COMMENTS
- See Also:
- Constant Field Values
-
VALIDATE
protected static final short VALIDATE
- See Also:
- Constant Field Values
-
PSVI
protected static final short PSVI
- See Also:
- Constant Field Values
-
WELLFORMED
protected static final short WELLFORMED
- See Also:
- Constant Field Values
-
NSDECL
protected static final short NSDECL
- See Also:
- Constant Field Values
-
INFOSET_TRUE_PARAMS
protected static final short INFOSET_TRUE_PARAMS
- See Also:
- Constant Field Values
-
INFOSET_FALSE_PARAMS
protected static final short INFOSET_FALSE_PARAMS
- See Also:
- Constant Field Values
-
INFOSET_MASK
protected static final short INFOSET_MASK
- See Also:
- Constant Field Values
-
fSymbolTable
protected SymbolTable fSymbolTable
Symbol table.
-
fComponents
protected ArrayList fComponents
Components.
-
fValidationManager
protected ValidationManager fValidationManager
-
fLocale
protected Locale fLocale
Locale.
-
fErrorReporter
protected XMLErrorReporter fErrorReporter
Error reporter
-
fErrorHandlerWrapper
protected final DOMErrorHandlerWrapper fErrorHandlerWrapper
-
fCurrentDVFactory
protected DTDDVFactory fCurrentDVFactory
Current Datatype validator factory.
-
fDatatypeValidatorFactory
protected DTDDVFactory fDatatypeValidatorFactory
The XML 1.0 Datatype validator factory.
-
fXML11DatatypeFactory
protected DTDDVFactory fXML11DatatypeFactory
The XML 1.1 Datatype validator factory.
-
-
Constructor Detail
-
DOMConfigurationImpl
protected DOMConfigurationImpl()
Default Constructor.
-
DOMConfigurationImpl
protected DOMConfigurationImpl(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.- Parameters:
symbolTable- The symbol table to use.
-
DOMConfigurationImpl
protected DOMConfigurationImpl(SymbolTable symbolTable, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table and parent settings.- Parameters:
symbolTable- The symbol table to use.parentSettings- The parent settings.
-
-
Method Detail
-
parse
public void parse(XMLInputSource inputSource) throws XNIException, IOException
Parse an XML document.The parser can use this method to instruct this configuration to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Parsers may not invoke this method while a parse is in progress. Once a parse is complete, the parser may then parse another XML document.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
- Specified by:
parsein interfaceXMLParserConfiguration- Parameters:
inputSource- The input source for the top-level of the XML document.- 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.
-
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)
-
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.
-
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.
-
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.
-
getLocale
public Locale getLocale()
Returns the locale.- Specified by:
getLocalein interfaceXMLParserConfiguration
-
setParameter
public void setParameter(String name, Object value) throws DOMException
DOM Level 3 WD - Experimental. setParameter- Specified by:
setParameterin interfaceDOMConfiguration- Throws:
DOMException
-
getParameter
public Object getParameter(String name) throws DOMException
DOM Level 3 WD - Experimental. getParameter- Specified by:
getParameterin interfaceDOMConfiguration- Throws:
DOMException
-
canSetParameter
public boolean canSetParameter(String name, Object value)
DOM Level 3 WD - Experimental. Check if setting a parameter to a specific value is supported.- Specified by:
canSetParameterin interfaceDOMConfiguration- Parameters:
name- The name of the parameter to check.value- An object. if null, the returned value is true.- Returns:
- true if the parameter could be successfully set to the specified value, or false if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself.
-
getParameterNames
public DOMStringList getParameterNames()
DOM Level 3 CR - Experimental. The list of the parameters supported by thisDOMConfigurationobject and for which at least one value can be set by the application. Note that this list can also contain parameter names defined outside this specification.- Specified by:
getParameterNamesin interfaceDOMConfiguration
-
reset
protected void reset() throws XNIExceptionreset all components before parsing- Throws:
XNIException
-
checkProperty
protected void checkProperty(String propertyId) throws XMLConfigurationException
Check a property. If the property is known 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- If the requested feature is not known or supported.
-
addComponent
protected void addComponent(XMLComponent component)
-
createValidationManager
protected ValidationManager createValidationManager()
-
setDTDValidatorFactory
protected final void setDTDValidatorFactory(String version)
-
-