|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--weblogic.apache.xerces.util.ParserConfigurationSettings | +--weblogic.apache.xerces.parsers.BasicParserConfiguration
A very basic parser configuration. This configuration class can be used as a base class for custom parser configurations. The basic parser configuration creates the symbol table (if not specified at construction time) and manages all of the recognized features and properties.
The basic parser configuration does not mandate
any particular pipeline configuration or the use of specific
components except for the symbol table. If even this is too much
for a basic parser configuration, the programmer can create a new
configuration class that implements the
XMLParserConfiguration
interface.
Subclasses of the basic parser configuration can add their own
recognized features and properties by calling the
addRecognizedFeature
and
addRecognizedProperty
methods, respectively.
The basic parser configuration assumes that the configuration
will be made up of various parser components that implement the
XMLComponent
interface. If subclasses of this
configuration create their own components for use in the
parser configuration, then each component should be added to
the list of components by calling the addComponent
method. The basic parser configuration will make sure to call
the reset
method of each registered component
before parsing an instance document.
This class recognizes the following features and properties:
Field Summary | |
protected static java.lang.String |
ENTITY_RESOLVER
Property identifier: entity resolver. |
protected static java.lang.String |
ERROR_HANDLER
Property identifier: error handler. |
protected static java.lang.String |
EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities. |
protected static java.lang.String |
EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities. |
protected java.util.Vector |
fComponents
Components. |
protected XMLDocumentHandler |
fDocumentHandler
The document handler. |
protected XMLDTDContentModelHandler |
fDTDContentModelHandler
The DTD content model handler. |
protected XMLDTDHandler |
fDTDHandler
The DTD handler. |
protected XMLDocumentSource |
fLastComponent
Last component in the document pipeline |
protected java.util.Locale |
fLocale
Locale. |
protected SymbolTable |
fSymbolTable
Symbol table. |
protected static java.lang.String |
NAMESPACES
Feature identifier: namespaces. |
protected static java.lang.String |
SYMBOL_TABLE
Property identifier: symbol table. |
protected static java.lang.String |
VALIDATION
Feature identifier: validation. |
protected static java.lang.String |
XML_STRING
Property identifier: xml string. |
Fields inherited from class weblogic.apache.xerces.util.ParserConfigurationSettings |
fFeatures,
fParentSettings,
fProperties,
fRecognizedFeatures,
fRecognizedProperties |
Constructor Summary | |
protected |
BasicParserConfiguration()
Default Constructor. |
protected |
BasicParserConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table. |
protected |
BasicParserConfiguration(SymbolTable symbolTable,
XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table and parent settings. |
Method Summary | |
protected void |
addComponent(XMLComponent component)
Adds a component to the parser configuration. |
protected void |
checkProperty(java.lang.String propertyId)
Check a property. |
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. |
java.util.Locale |
getLocale()
Returns the locale. |
abstract void |
parse(XMLInputSource inputSource)
Parse an XML document. |
protected void |
reset()
reset all components before parsing |
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 |
setProperty(java.lang.String propertyId,
java.lang.Object value)
setProperty |
Methods inherited from class weblogic.apache.xerces.util.ParserConfigurationSettings |
addRecognizedFeatures,
addRecognizedProperties,
checkFeature,
getFeature,
getProperty |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected static final java.lang.String VALIDATION
protected static final java.lang.String NAMESPACES
protected static final java.lang.String EXTERNAL_GENERAL_ENTITIES
protected static final java.lang.String EXTERNAL_PARAMETER_ENTITIES
protected static final java.lang.String XML_STRING
protected static final java.lang.String SYMBOL_TABLE
protected static final java.lang.String ERROR_HANDLER
protected static final java.lang.String ENTITY_RESOLVER
protected SymbolTable fSymbolTable
protected java.util.Locale fLocale
protected java.util.Vector fComponents
protected XMLDocumentHandler fDocumentHandler
protected XMLDTDHandler fDTDHandler
protected XMLDTDContentModelHandler fDTDContentModelHandler
protected XMLDocumentSource fLastComponent
Constructor Detail |
protected BasicParserConfiguration()
protected BasicParserConfiguration(SymbolTable symbolTable)
symbolTable
- The symbol table to use.protected BasicParserConfiguration(SymbolTable symbolTable, XMLComponentManager parentSettings)
symbolTable
- The symbol table to use.parentSettings
- The parent settings.Method Detail |
protected void addComponent(XMLComponent component)
component
- The component to add.public abstract void parse(XMLInputSource inputSource) throws XNIException, java.io.IOException
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.
source
- The input source for the top-level of the
XML document.public void setDocumentHandler(XMLDocumentHandler documentHandler)
documentHandler
- The document handler.public XMLDocumentHandler getDocumentHandler()
public void setDTDHandler(XMLDTDHandler dtdHandler)
dtdHandler
- The DTD handler.public XMLDTDHandler getDTDHandler()
public void setDTDContentModelHandler(XMLDTDContentModelHandler handler)
handler
- The DTD content model handler.public XMLDTDContentModelHandler getDTDContentModelHandler()
public void setEntityResolver(XMLEntityResolver resolver)
resolver
- The new entity resolver. Passing a null value will
uninstall the currently installed resolver.public XMLEntityResolver getEntityResolver()
setEntityResolver(weblogic.apache.xerces.xni.parser.XMLEntityResolver)
public void setErrorHandler(XMLErrorHandler errorHandler)
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.
errorHandler
- The error handler.getErrorHandler()
public XMLErrorHandler getErrorHandler()
setErrorHandler(weblogic.apache.xerces.xni.parser.XMLErrorHandler)
public void setFeature(java.lang.String featureId, boolean state) throws XMLConfigurationException
featureId
- The unique identifier (URI) of the feature.state
- The requested state of the feature (true or false).public void setProperty(java.lang.String propertyId, java.lang.Object value) throws XMLConfigurationException
propertyId
- value
- public void setLocale(java.util.Locale locale) throws XNIException
locale
- The locale object to use for localization of messages.public java.util.Locale getLocale()
protected void reset() throws XNIException
protected void checkProperty(java.lang.String propertyId) throws XMLConfigurationException
propertyId
- The unique identifier (URI) of the property
being set.
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81b |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |