File Doc Category Size Date Package
XMLParserConfiguration.java API Doc Apache Xerces 3.0.1 9335 Fri Sep 14 20:33:56 BST 2007 org.apache.xerces.xni.parser

XMLParserConfiguration

public interface XMLParserConfiguration implements 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:

Call the reset method on each component before parsing. This is only required if the configuration is re-using existing components that conform to the XMLComponent interface. If the configuration uses all custom parts, then it is free to implement everything as it sees fit as long as it follows the other guidelines.
Call the setFeature and setProperty method on each component during parsing to propagate features and properties that have changed. This is only required if the configuration is re-using existing components that conform to the XMLComponent interface. If the configuration uses all custom parts, then it is free to implement everything as it sees fit as long as it follows the other guidelines.
Pass the same unique String references for all symbols that are propagated to the registered handlers. Symbols include, but may not be limited to, the names of elements and attributes (including their uri, prefix, and localpart). This is suggested but not an absolute must. However, the standard parser components may require access to the same symbol table for creation of unique symbol references to be propagated in the XNI pipeline.

author: Arnaud Le Hors, IBM
author: Andy Clark, IBM
version: $Id: XMLParserConfiguration.java 447244 2006-09-18 05:20:40Z mrglavas $

Fields Summary
Constructors Summary
Methods Summary
public void addRecognizedFeatures(java.lang.String[] featureIds)
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
param
featureIds An array of the additional feature identifiers to be recognized.
public void addRecognizedProperties(java.lang.String[] propertyIds)
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
param
propertyIds An array of the additional property identifiers to be recognized.
public org.apache.xerces.xni.XMLDTDContentModelHandler getDTDContentModelHandler()
Returns the registered DTD content model handler.
public org.apache.xerces.xni.XMLDTDHandler getDTDHandler()
Returns the registered DTD handler.
public org.apache.xerces.xni.XMLDocumentHandler getDocumentHandler()
Returns the registered document handler.
public XMLEntityResolver getEntityResolver()
Returns the registered entity resolver.
public XMLErrorHandler getErrorHandler()
Returns the registered error handler.
public boolean getFeature(java.lang.String featureId)
Returns the state of a feature.
param
featureId The feature identifier.
throws
XMLConfigurationException Thrown if there is a configuration error.
public java.util.Locale getLocale()
Returns the locale.
public java.lang.Object getProperty(java.lang.String propertyId)
Returns the value of a property.
param
propertyId The property identifier.
throws
XMLConfigurationException Thrown if there is a configuration error.
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.
param
inputSource The input source for the top-level of the XML document.
exception
XNIException Any XNI exception, possibly wrapping another exception.
exception
IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.
public void setDTDContentModelHandler(org.apache.xerces.xni.XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler.
param
dtdContentModelHandler The DTD content model handler.
public void setDTDHandler(org.apache.xerces.xni.XMLDTDHandler dtdHandler)
Sets the DTD handler.
param
dtdHandler The DTD handler.
public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
param
documentHandler The document handler.
public void setEntityResolver(XMLEntityResolver entityResolver)
Sets the entity resolver.
param
entityResolver The new entity resolver.
public void setErrorHandler(XMLErrorHandler errorHandler)
Sets the error handler.
param
errorHandler The error resolver.
public void setFeature(java.lang.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.
param
featureId The feature identifier.
param
state The state of the feature.
throws
XMLConfigurationException Thrown if there is a configuration error.
public void setLocale(java.util.Locale locale)
Set the locale to use for messages.
param
locale The locale object to use for localization of messages.
exception
XNIException Thrown if the parser does not support the specified locale.
public void setProperty(java.lang.String propertyId, java.lang.Object value)
Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.
param
propertyId The property identifier.
param
value The value of the property.
throws
XMLConfigurationException Thrown if there is a configuration error.