| org.apache.xerces.xni.parser.XMLParserConfiguration
All known Subclasses: org.apache.xerces.parsers.BasicParserConfiguration, org.apache.xerces.dom.DOMConfigurationImpl,
| XMLParserConfiguration | | public interface XMLParserConfiguration extends XMLComponentManager(Code) | | 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 $ |
| addRecognizedFeatures | | public void addRecognizedFeatures(String[] featureIds)(Code) | | 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)(Code) | | 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. |
| getLocale | | public Locale getLocale()(Code) | | Returns the locale.
|
| parse | | public void parse(XMLInputSource inputSource) throws XNIException, IOException(Code) | | 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 theXML document.
exception:
XNIException - Any XNI exception, possibly wrapping another exception.
exception:
IOException - An IO exception from the parser, possiblyfrom a byte stream or character streamsupplied by the parser. |
| setDTDContentModelHandler | | public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)(Code) | | Sets the DTD content model handler.
Parameters:
dtdContentModelHandler - The DTD content model handler. |
| setDTDHandler | | public void setDTDHandler(XMLDTDHandler dtdHandler)(Code) | | Sets the DTD handler.
Parameters:
dtdHandler - The DTD handler. |
| setDocumentHandler | | public void setDocumentHandler(XMLDocumentHandler documentHandler)(Code) | | Sets the document handler to receive information about the document.
Parameters:
documentHandler - The document handler. |
| setEntityResolver | | public void setEntityResolver(XMLEntityResolver entityResolver)(Code) | | Sets the entity resolver.
Parameters:
entityResolver - The new entity resolver. |
| setErrorHandler | | public void setErrorHandler(XMLErrorHandler errorHandler)(Code) | | Sets the error handler.
Parameters:
errorHandler - The error resolver. |
| setFeature | | public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code) | | 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.
Parameters:
state - The state of the feature.
throws:
XMLConfigurationException - Thrown if there is a configurationerror. |
| setLocale | | public void setLocale(Locale locale) throws XNIException(Code) | | Set the locale to use for messages.
Parameters:
locale - The locale object to use for localization of messages.
exception:
XNIException - Thrown if the parser does not support thespecified locale. |
| setProperty | | public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code) | | 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.
Parameters:
value - The value of the property.
throws:
XMLConfigurationException - Thrown if there is a configurationerror. |
|
|