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 447245 2006-09-18 05:22:10Z mrglavas $
Author:
Neil Graham, IBM

Method Summary

XMLEntityResolver
getEntityResolver()
Returns the registered entity resolver.
XMLErrorHandler
getErrorHandler()
Returns the registered error handler.
boolean
getFeature(String featureId)
Returns the state of a feature.
Locale
getLocale()
Return the Locale the XMLGrammarLoader is using.
Object
getProperty(String propertyId)
Returns the state of a property.
String[]
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this XMLGrammarLoader.
String[]
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this XMLGrammarLoader.
Grammar
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
setLocale(Locale locale)
Set the locale to use for messages.
void
setProperty(String propertyId, Object state)
Sets the state of a property.

Method Details

getEntityResolver

public XMLEntityResolver getEntityResolver()
Returns the registered entity resolver.

getErrorHandler

public XMLErrorHandler getErrorHandler()
Returns the registered error handler.

getFeature

public boolean getFeature(String featureId)
            throws XMLConfigurationException
Returns the state of a feature.
Parameters:
featureId - The feature identifier.
Throws:
XMLConfigurationException - Thrown on configuration error.

getLocale

public Locale getLocale()
Return the Locale the XMLGrammarLoader is using.

getProperty

public Object getProperty(String propertyId)
            throws XMLConfigurationException
Returns the state of a property.
Parameters:
propertyId - The property identifier.
Throws:
XMLConfigurationException - Thrown on configuration error.

getRecognizedFeatures

public String[] getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this XMLGrammarLoader. This method may return null if no features are recognized.

getRecognizedProperties

public String[] getRecognizedProperties()
Returns a list of property identifiers that are recognized by this XMLGrammarLoader. This method may return null if no properties are recognized.

loadGrammar

public Grammar loadGrammar(XMLInputSource source)
            throws IOException,
                   XNIException
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.

setEntityResolver

public void setEntityResolver(XMLEntityResolver entityResolver)
Sets the entity resolver.
Parameters:
entityResolver - The new entity resolver.

setErrorHandler

public void setErrorHandler(XMLErrorHandler errorHandler)
Sets the error handler.
Parameters:
errorHandler - The error handler.

setFeature

public void setFeature(String featureId,
                       boolean state)
            throws XMLConfigurationException
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.

setLocale

public void setLocale(Locale locale)
Set the locale to use for messages.
Parameters:
locale - The locale object to use for localization of messages.

setProperty

public void setProperty(String propertyId,
                        Object state)
            throws XMLConfigurationException
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.

Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved.