Package org.apache.xerces.dom

Class DOMConfigurationImpl

java.lang.Object
org.apache.xerces.util.ParserConfigurationSettings
org.apache.xerces.dom.DOMConfigurationImpl
All Implemented Interfaces:
org.apache.xerces.xni.parser.XMLComponentManager, org.apache.xerces.xni.parser.XMLParserConfiguration, DOMConfiguration
public class DOMConfigurationImpl extends ParserConfigurationSettings implements org.apache.xerces.xni.parser.XMLParserConfiguration, DOMConfiguration
Xerces implementation of DOMConfiguration that maintains a table of recognized parameters.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.
Version:
$Id: DOMConfigurationImpl.java 805582 2009-08-18 21:13:20Z sandygao $
Author:
Elena Litani, IBM, Neeraj Bajaj, Sun Microsystems.

  • Field Details

  • Constructor Details

    • 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, org.apache.xerces.xni.parser.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 Details

    • parse

      public void parse(org.apache.xerces.xni.parser.XMLInputSource inputSource) throws org.apache.xerces.xni.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:
      parse in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      inputSource - The input source for the top-level of the XML document.
      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.

    • setDocumentHandler

      public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
      Sets the document handler on the last component in the pipeline to receive information about the document.
      Specified by:
      setDocumentHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      documentHandler - The document handler.

    • getDocumentHandler

      public org.apache.xerces.xni.XMLDocumentHandler getDocumentHandler()
      Returns the registered document handler.
      Specified by:
      getDocumentHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

    • setDTDHandler

      public void setDTDHandler(org.apache.xerces.xni.XMLDTDHandler dtdHandler)
      Sets the DTD handler.
      Specified by:
      setDTDHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      dtdHandler - The DTD handler.

    • getDTDHandler

      public org.apache.xerces.xni.XMLDTDHandler getDTDHandler()
      Returns the registered DTD handler.
      Specified by:
      getDTDHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

    • setDTDContentModelHandler

      public void setDTDContentModelHandler(org.apache.xerces.xni.XMLDTDContentModelHandler handler)
      Sets the DTD content model handler.
      Specified by:
      setDTDContentModelHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      handler - The DTD content model handler.

    • getDTDContentModelHandler

      public org.apache.xerces.xni.XMLDTDContentModelHandler getDTDContentModelHandler()
      Returns the registered DTD content model handler.
      Specified by:
      getDTDContentModelHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration

    • setEntityResolver

      public void setEntityResolver(org.apache.xerces.xni.parser.XMLEntityResolver resolver)
      Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.
      Specified by:
      setEntityResolver in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      resolver - The new entity resolver. Passing a null value will uninstall the currently installed resolver.

    • getEntityResolver

      public org.apache.xerces.xni.parser.XMLEntityResolver getEntityResolver()
      Return the current entity resolver.
      Specified by:
      getEntityResolver in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Returns:
      The current entity resolver, or null if none has been registered.
      See Also:

    • setErrorHandler

      public void setErrorHandler(org.apache.xerces.xni.parser.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:
      setErrorHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Parameters:
      errorHandler - The error handler.
      Throws:
      NullPointerException - If the handler argument is null.
      See Also:

    • getErrorHandler

      public org.apache.xerces.xni.parser.XMLErrorHandler getErrorHandler()
      Return the current error handler.
      Specified by:
      getErrorHandler in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Returns:
      The current error handler, or null if none has been registered.
      See Also:

    • getFeature

      public boolean getFeature(String featureId) throws org.apache.xerces.xni.parser.XMLConfigurationException
      Returns the state of a feature.
      Specified by:
      getFeature in interface org.apache.xerces.xni.parser.XMLComponentManager
      Specified by:
      getFeature in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Overrides:
      getFeature in class ParserConfigurationSettings
      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 interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Overrides:
      setFeature in class ParserConfigurationSettings
      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.

    • setProperty

      public void setProperty(String propertyId, Object value) throws org.apache.xerces.xni.parser.XMLConfigurationException
      setProperty
      Specified by:
      setProperty in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      Overrides:
      setProperty in class ParserConfigurationSettings
      Parameters:
      propertyId -
      value -
      Throws:
      org.apache.xerces.xni.parser.XMLConfigurationException - If the requested feature is not known.

    • setLocale

      public void setLocale(Locale locale) throws org.apache.xerces.xni.XNIException
      Set the locale to use for messages.
      Specified by:
      setLocale in interface org.apache.xerces.xni.parser.XMLParserConfiguration
      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.

    • getLocale

      public Locale getLocale()
      Returns the locale.
      Specified by:
      getLocale in interface org.apache.xerces.xni.parser.XMLParserConfiguration

    • setParameter

      public void setParameter(String name, Object value) throws DOMException
      DOM Level 3 WD - Experimental. setParameter
      Specified by:
      setParameter in interface DOMConfiguration
      Throws:
      DOMException

    • getParameter

      public Object getParameter(String name) throws DOMException
      DOM Level 3 WD - Experimental. getParameter
      Specified by:
      getParameter in interface DOMConfiguration
      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:
      canSetParameter in interface DOMConfiguration
      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 this DOMConfiguration object 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:
      getParameterNames in interface DOMConfiguration

    • reset

      protected void reset() throws org.apache.xerces.xni.XNIException
      reset all components before parsing
      Throws:
      org.apache.xerces.xni.XNIException

    • checkProperty

      protected void checkProperty(String propertyId) throws org.apache.xerces.xni.parser.XMLConfigurationException
      Check a property. If the property is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.
      Overrides:
      checkProperty in class ParserConfigurationSettings
      Parameters:
      propertyId - The unique identifier (URI) of the property being set.
      Throws:
      org.apache.xerces.xni.parser.XMLConfigurationException - If the requested feature is not known or supported.

    • addComponent

      protected void addComponent(org.apache.xerces.xni.parser.XMLComponent component)

    • createValidationManager

      protected ValidationManager createValidationManager()

    • setDTDValidatorFactory

      protected final void setDTDValidatorFactory(String version)