org.apache.xerces.xni.parser: public interface: XMLParserConfiguration

org.apache.xerces.xni.parser
public interface: XMLParserConfiguration [javadoc | source]

All Implemented Interfaces:
XMLComponentManager

All Known Implementing Classes:
XPointerParserConfiguration, CSVConfiguration, XMLPullParserConfiguration, SoftReferenceSymbolTableConfiguration, StandardParserConfiguration, PSVIConfiguration, XIncludeAwareParserConfiguration, NonValidatingParserConfiguration, DTDConfiguration, DOMConfigurationImpl, XML11Configuration, XML11DTDConfiguration, IntegratedParserConfiguration, XMLGrammarCachingConfiguration, AbstractConfiguration, SchemaParsingConfig, BasicParserConfiguration, XML11NonValidatingConfiguration, SecurityConfiguration, NonValidatingConfiguration, XIncludeParserConfiguration

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 $

Method from org.apache.xerces.xni.parser.XMLParserConfiguration Summary:
addRecognizedFeatures, addRecognizedProperties, getDTDContentModelHandler, getDTDHandler, getDocumentHandler, getEntityResolver, getErrorHandler, getFeature, getLocale, getProperty, parse, setDTDContentModelHandler, setDTDHandler, setDocumentHandler, setEntityResolver, setErrorHandler, setFeature, setLocale, setProperty

Method from org.apache.xerces.xni.parser.XMLParserConfiguration Detail:
public void addRecognizedFeatures(String[] featureIds) Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
public void addRecognizedProperties(String[] propertyIds) Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
public XMLDTDContentModelHandler getDTDContentModelHandler() Returns the registered DTD content model handler.
public XMLDTDHandler getDTDHandler() Returns the registered DTD handler.
public 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(String featureId) throws XMLConfigurationException Returns the state of a feature.
public Locale getLocale() Returns the locale.
public Object getProperty(String propertyId) throws XMLConfigurationException Returns the value of a property.
public void parse(XMLInputSource inputSource) throws IOException, XNIException 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.
public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler) Sets the DTD content model handler.
public void setDTDHandler(XMLDTDHandler dtdHandler) Sets the DTD handler.
public void setDocumentHandler(XMLDocumentHandler documentHandler) Sets the document handler to receive information about the document.
public void setEntityResolver(XMLEntityResolver entityResolver) Sets the entity resolver.
public void setErrorHandler(XMLErrorHandler errorHandler) Sets the error handler.
public void setFeature(String featureId, boolean state) throws XMLConfigurationException Sets the state of a feature. This method is called by the parser and gets propagated to components in this parser configuration.
public void setLocale(Locale locale) throws XNIException Set the locale to use for messages.
public void setProperty(String propertyId, Object value) throws XMLConfigurationException Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.