org.apache.xerces.xni.parser

Interface XMLParserConfiguration

public interface XMLParserConfiguration extends XMLComponentManager

Represents a parser configuration. The parser configuration maintains a table of recognized features and properties, assembles components for the parsing pipeline, and is responsible for initiating parsing of an XML document.

By separating the configuration of a parser from the specific parser instance, applications can create new configurations and re-use the existing parser components and external API generators (e.g. the DOMParser and SAXParser).

The internals of any specific parser configuration instance are hidden. Therefore, each configuration may implement the parsing mechanism any way necessary. However, the parser configuration should follow these guidelines:

Version: $Id: XMLParserConfiguration.java,v 1.7 2004/10/03 21:58:18 mrglavas Exp $

Author: Arnaud Le Hors, IBM Andy Clark, IBM

Method Summary
voidaddRecognizedFeatures(String[] featureIds)
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
voidaddRecognizedProperties(String[] propertyIds)
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
XMLDocumentHandlergetDocumentHandler()
Returns the registered document handler.
XMLDTDContentModelHandlergetDTDContentModelHandler()
Returns the registered DTD content model handler.
XMLDTDHandlergetDTDHandler()
Returns the registered DTD handler.
XMLEntityResolvergetEntityResolver()
Returns the registered entity resolver.
XMLErrorHandlergetErrorHandler()
Returns the registered error handler.
booleangetFeature(String featureId)
Returns the state of a feature.
LocalegetLocale()
Returns the locale.
ObjectgetProperty(String propertyId)
Returns the value of a property.
voidparse(XMLInputSource inputSource)
Parse an XML document.
voidsetDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
voidsetDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler.
voidsetDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.
voidsetEntityResolver(XMLEntityResolver entityResolver)
Sets the entity resolver.
voidsetErrorHandler(XMLErrorHandler errorHandler)
Sets the error handler.
voidsetFeature(String featureId, boolean state)
Sets the state of a feature.
voidsetLocale(Locale locale)
Set the locale to use for messages.
voidsetProperty(String propertyId, Object value)
Sets the value of a property.

Method Detail

addRecognizedFeatures

public void addRecognizedFeatures(String[] featureIds)
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.

Parameters: featureIds An array of the additional feature identifiers to be recognized.

addRecognizedProperties

public void addRecognizedProperties(String[] propertyIds)
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.

Parameters: propertyIds An array of the additional property identifiers to be recognized.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()
Returns the registered document handler.

getDTDContentModelHandler

public XMLDTDContentModelHandler getDTDContentModelHandler()
Returns the registered DTD content model handler.

getDTDHandler

public XMLDTDHandler getDTDHandler()
Returns the registered DTD handler.

getEntityResolver

public XMLEntityResolver getEntityResolver()
Returns the registered entity resolver.

getErrorHandler

public XMLErrorHandler getErrorHandler()
Returns the registered error handler.

getFeature

public boolean getFeature(String featureId)
Returns the state of a feature.

Parameters: featureId The feature identifier.

Throws: XMLConfigurationException Thrown if there is a configuration error.

getLocale

public Locale getLocale()
Returns the locale.

getProperty

public Object getProperty(String propertyId)
Returns the value of a property.

Parameters: propertyId The property identifier.

Throws: XMLConfigurationException Thrown if there is a configuration error.

parse

public void parse(XMLInputSource inputSource)
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.

When this method returns, all characters streams and byte streams opened by the parser are closed.

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 to receive information about the document.

Parameters: documentHandler The document handler.

setDTDContentModelHandler

public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler.

Parameters: dtdContentModelHandler The DTD content model handler.

setDTDHandler

public void setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.

Parameters: dtdHandler The DTD handler.

setEntityResolver

public void setEntityResolver(XMLEntityResolver entityResolver)
Sets the entity resolver.

Parameters: entityResolver The new entity resolver.

setErrorHandler

public void setErrorHandler(XMLErrorHandler errorHandler)
Sets the error handler.

Parameters: errorHandler The error resolver.

setFeature

public void setFeature(String featureId, boolean state)
Sets the state of a feature. This method is called by the parser and gets propagated to components in this parser configuration.

Parameters: featureId The feature identifier. state The state of the feature.

Throws: XMLConfigurationException Thrown if there is a configuration error.

setLocale

public void setLocale(Locale locale)
Set the locale to use for messages.

Parameters: locale The locale object to use for localization of messages.

Throws: XNIException Thrown if the parser does not support the specified locale.

setProperty

public void setProperty(String propertyId, Object value)
Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.

Parameters: propertyId The property identifier. value The value of the property.

Throws: XMLConfigurationException Thrown if there is a configuration error.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.