Package org.apache.xerces.xni.grammars
Interface XMLGrammarLoader
public interface XMLGrammarLoader
The intention of this interface is to provide a generic means
by which Grammar objects may be created without parsing instance
documents. Implementations of this interface will know how to load
specific types of grammars (e.g., DTD's or schemas); a wrapper
will be provided for user applications to interact with these implementations.
- Version:
- $Id: XMLGrammarLoader.java 699892 2008-09-28 21:08:27Z mrglavas $
- Author:
- Neil Graham, IBM
-
Method Summary
Modifier and TypeMethodDescriptionReturns the registered entity resolver.Returns the registered error handler.boolean
getFeature
(String featureId) Returns the state of a feature.Return the Locale the XMLGrammarLoader is using.getProperty
(String propertyId) Returns the state of a property.String[]
Returns a list of feature identifiers that are recognized by this XMLGrammarLoader.String[]
Returns a list of property identifiers that are recognized by this XMLGrammarLoader.loadGrammar
(XMLInputSource source) Returns a Grammar object by parsing the contents of the entity pointed to by source.void
setEntityResolver
(XMLEntityResolver entityResolver) Sets the entity resolver.void
setErrorHandler
(XMLErrorHandler errorHandler) Sets the error handler.void
setFeature
(String featureId, boolean state) Sets the state of a feature.void
Set the locale to use for messages.void
setProperty
(String propertyId, Object state) Sets the state of a property.
-
Method Details
-
getRecognizedFeatures
String[] getRecognizedFeatures()Returns a list of feature identifiers that are recognized by this XMLGrammarLoader. This method may return null if no features are recognized. -
getFeature
Returns the state of a feature.- Parameters:
featureId
- The feature identifier.- Throws:
XMLConfigurationException
- Thrown on configuration error.
-
setFeature
Sets the state of a feature.- Parameters:
featureId
- The feature identifier.state
- The state of the feature.- Throws:
XMLConfigurationException
- Thrown when a feature is not recognized or cannot be set.
-
getRecognizedProperties
String[] getRecognizedProperties()Returns a list of property identifiers that are recognized by this XMLGrammarLoader. This method may return null if no properties are recognized. -
getProperty
Returns the state of a property.- Parameters:
propertyId
- The property identifier.- Throws:
XMLConfigurationException
- Thrown on configuration error.
-
setProperty
Sets the state of a property.- Parameters:
propertyId
- The property identifier.state
- The state of the property.- Throws:
XMLConfigurationException
- Thrown when a property is not recognized or cannot be set.
-
setLocale
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.
-
getLocale
Locale getLocale()Return the Locale the XMLGrammarLoader is using. -
setErrorHandler
Sets the error handler.- Parameters:
errorHandler
- The error handler.
-
getErrorHandler
XMLErrorHandler getErrorHandler()Returns the registered error handler. -
setEntityResolver
Sets the entity resolver.- Parameters:
entityResolver
- The new entity resolver.
-
getEntityResolver
XMLEntityResolver getEntityResolver()Returns the registered entity resolver. -
loadGrammar
Returns a Grammar object by parsing the contents of the entity pointed to by source.- Parameters:
source
- the location of the entity which forms the starting point of the grammar to be constructed.- Throws:
IOException
- When a problem is encountered reading the entity XNIException When a condition arises (such as a FatalError) that requires parsing of the entity be terminated.XNIException
-