org.apache.xerces.dom
Class DOMConfigurationImpl

java.lang.Object
  org.apache.xerces.util.ParserConfigurationSettings
      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: DOMConfigurationImpl.java 530107 2007-04-18 17:59:54Z mrglavas $

Author:

Elena Litani, IBM, Neeraj Bajaj, Sun Microsystems.

Method Summary

boolean	canSetParameter(java.lang.String name, java.lang.Object value) DOM Level 3 WD - Experimental.
XMLDocumentHandler	getDocumentHandler() Returns the registered document handler.
XMLDTDContentModelHandler	getDTDContentModelHandler() Returns the registered DTD content model handler.
XMLDTDHandler	getDTDHandler() Returns the registered DTD handler.
XMLEntityResolver	getEntityResolver() Return the current entity resolver.
XMLErrorHandler	getErrorHandler() Return the current error handler.
boolean	getFeature(java.lang.String featureId) Returns the state of a feature.
java.util.Locale	getLocale() Returns the locale.
java.lang.Object	getParameter(java.lang.String name) DOM Level 3 WD - Experimental.
DOMStringList	getParameterNames() DOM Level 3 CR - Experimental.
void	parse(XMLInputSource inputSource) Parse an XML document.
void	setDocumentHandler(XMLDocumentHandler documentHandler) Sets the document handler on the last component in the pipeline to receive information about the document.
void	setDTDContentModelHandler(XMLDTDContentModelHandler handler) Sets the DTD content model handler.
void	setDTDHandler(XMLDTDHandler dtdHandler) Sets the DTD handler.
void	setEntityResolver(XMLEntityResolver resolver) Sets the resolver used to resolve external entities.
void	setErrorHandler(XMLErrorHandler errorHandler) Allow an application to register an error event handler.
void	setFeature(java.lang.String featureId, boolean state) Set the state of a feature.
void	setLocale(java.util.Locale locale) Set the locale to use for messages.
void	setParameter(java.lang.String name, java.lang.Object value) DOM Level 3 WD - Experimental.
void	setProperty(java.lang.String propertyId, java.lang.Object value) setProperty

Methods inherited from class org.apache.xerces.util.ParserConfigurationSettings

addRecognizedFeatures, addRecognizedProperties, getProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.xerces.xni.parser.XMLParserConfiguration

addRecognizedFeatures, addRecognizedProperties, getProperty

Method Detail

parse

public void parse(XMLInputSource inputSource)
           throws XNIException,
                  java.io.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 XMLParserConfiguration

Parameters:

inputSource - The input source for the top-level of the XML document.

Throws:

XNIException - Any XNI exception, possibly wrapping another exception.

java.io.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:

setDocumentHandler in interface XMLParserConfiguration

Parameters:

documentHandler - The document handler.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()

Returns the registered document handler.

Specified by:

getDocumentHandler in interface XMLParserConfiguration

setDTDHandler

public void setDTDHandler(XMLDTDHandler dtdHandler)

Sets the DTD handler.

Specified by:

setDTDHandler in interface XMLParserConfiguration

Parameters:

dtdHandler - The DTD handler.

getDTDHandler

public XMLDTDHandler getDTDHandler()

Returns the registered DTD handler.

Specified by:

getDTDHandler in interface XMLParserConfiguration

setDTDContentModelHandler

public void setDTDContentModelHandler(XMLDTDContentModelHandler handler)

Sets the DTD content model handler.

Specified by:

setDTDContentModelHandler in interface XMLParserConfiguration

Parameters:

handler - The DTD content model handler.

getDTDContentModelHandler

public XMLDTDContentModelHandler getDTDContentModelHandler()

Returns the registered DTD content model handler.

Specified by:

getDTDContentModelHandler in interface XMLParserConfiguration

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:

setEntityResolver in interface XMLParserConfiguration

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:

getEntityResolver in interface XMLParserConfiguration

Returns:

The current entity resolver, or null if none has been registered.

See Also:

setEntityResolver(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:

setErrorHandler in interface XMLParserConfiguration

Parameters:

errorHandler - The error handler.

Throws:

java.lang.NullPointerException - If the handler argument is null.

See Also:

getErrorHandler()

getErrorHandler

public XMLErrorHandler getErrorHandler()

Return the current error handler.

Specified by:

getErrorHandler in interface XMLParserConfiguration

Returns:

The current error handler, or null if none has been registered.

See Also:

setErrorHandler(org.apache.xerces.xni.parser.XMLErrorHandler)

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws XMLConfigurationException

Returns the state of a feature.

Specified by:

getFeature in interface XMLComponentManager

Specified by:

getFeature in interface XMLParserConfiguration

Overrides:

getFeature in class ParserConfigurationSettings

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(java.lang.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:

setFeature in interface 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:

XMLConfigurationException - If the requested feature is not known.

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLConfigurationException

setProperty

Specified by:

setProperty in interface XMLParserConfiguration

Overrides:

setProperty in class ParserConfigurationSettings

Parameters:

propertyId -

value -

Throws:

XMLConfigurationException - Thrown if there is a configuration error.

setLocale

public void setLocale(java.util.Locale locale)
               throws XNIException

Set the locale to use for messages.

Specified by:

setLocale in interface XMLParserConfiguration

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 java.util.Locale getLocale()

Returns the locale.

Specified by:

getLocale in interface XMLParserConfiguration

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)
                  throws DOMException

DOM Level 3 WD - Experimental. setParameter

Specified by:

setParameter in interface DOMConfiguration

Parameters:

name - The name of the parameter to set.

value - The new value or null if the user wishes to unset the parameter. While the type of the value parameter is defined as DOMUserData, the object type must match the type defined by the definition of the parameter. For example, if the parameter is "error-handler", the value must be of type DOMErrorHandler.

Throws:

DOMException - NOT_FOUND_ERR: Raised when the parameter name is not recognized.
NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but the requested value cannot be set.
TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is incompatible with the expected value type.

getParameter

public java.lang.Object getParameter(java.lang.String name)
                              throws DOMException

DOM Level 3 WD - Experimental. getParameter

Specified by:

getParameter in interface DOMConfiguration

Parameters:

name - The name of the parameter.

Returns:

The current object associated with the specified parameter or null if no object has been associated or if the parameter is not supported.

Throws:

DOMException - NOT_FOUND_ERR: Raised when the parameter name is not recognized.

canSetParameter

public boolean canSetParameter(java.lang.String name,
                               java.lang.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