org.apache.xerces.parsers

Class XMLGrammarCachingConfiguration

public class XMLGrammarCachingConfiguration extends XIncludeAwareParserConfiguration

This configuration provides a generic way of using Xerces's grammar caching facilities. It extends the XIncludeAwareParserConfiguration and thus may validate documents according to XML schemas or DTD's. It also allows the user to preparse a grammar, and to lock the grammar pool implementation such that no more grammars will be added.

Using the org.apache.xerces.xni.parser property, an application may instantiate a Xerces SAX or DOM parser with this configuration. When invoked in this manner, the default behaviour will be elicited; to use this configuration's specific facilities, the user will need to reference it directly.

In addition to the features and properties recognized by the base parser configuration, this class recognizes these additional features and properties:

Version: $Id: XMLGrammarCachingConfiguration.java,v 1.19 2005/05/04 04:23:46 mrglavas Exp $

Author: Neil Graham, IBM

Field Summary
static intBIG_PRIME
protected XMLDTDLoaderfDTDLoader
protected XMLSchemaLoaderfSchemaLoader
protected static XMLGrammarPoolImplfStaticGrammarPool
protected static SynchronizedSymbolTablefStaticSymbolTable
protected static StringSCHEMA_FULL_CHECKING
Constructor Summary
XMLGrammarCachingConfiguration()
Default constructor.
XMLGrammarCachingConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.
XMLGrammarCachingConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.
XMLGrammarCachingConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.
Method Summary
protected voidcheckFeature(String featureId)
Check a feature.
protected voidcheckProperty(String propertyId)
Check a property.
voidclearGrammarPool()
voidlockGrammarPool()
GrammarparseGrammar(String type, String uri)
Parse a grammar from a location identified by an URI.
GrammarparseGrammar(String type, XMLInputSource is)
Parse a grammar from a location identified by an XMLInputSource.
voidunlockGrammarPool()

Field Detail

BIG_PRIME

public static final int BIG_PRIME

fDTDLoader

protected XMLDTDLoader fDTDLoader

fSchemaLoader

protected XMLSchemaLoader fSchemaLoader

fStaticGrammarPool

protected static final XMLGrammarPoolImpl fStaticGrammarPool

fStaticSymbolTable

protected static final SynchronizedSymbolTable fStaticSymbolTable

SCHEMA_FULL_CHECKING

protected static final String SCHEMA_FULL_CHECKING

Constructor Detail

XMLGrammarCachingConfiguration

public XMLGrammarCachingConfiguration()
Default constructor.

XMLGrammarCachingConfiguration

public XMLGrammarCachingConfiguration(SymbolTable symbolTable)
Constructs a parser configuration using the specified symbol table.

Parameters: symbolTable The symbol table to use.

XMLGrammarCachingConfiguration

public XMLGrammarCachingConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a parser configuration using the specified symbol table and grammar pool.

REVISIT: Grammar pool will be updated when the new validation engine is implemented.

Parameters: symbolTable The symbol table to use. grammarPool The grammar pool to use.

XMLGrammarCachingConfiguration

public XMLGrammarCachingConfiguration(SymbolTable symbolTable, XMLGrammarPool grammarPool, XMLComponentManager parentSettings)
Constructs a parser configuration using the specified symbol table, grammar pool, and parent settings.

REVISIT: Grammar pool will be updated when the new validation engine is implemented.

Parameters: symbolTable The symbol table to use. grammarPool The grammar pool to use. parentSettings The parent settings.

Method Detail

checkFeature

protected void checkFeature(String featureId)
Check a feature. If feature is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters: featureId The unique identifier (URI) of the feature.

Throws: XMLConfigurationException Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

checkProperty

protected void checkProperty(String propertyId)
Check a property. If the property is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.

Parameters: propertyId The unique identifier (URI) of the property being set.

Throws: XMLConfigurationException Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

clearGrammarPool

public void clearGrammarPool()

lockGrammarPool

public void lockGrammarPool()

parseGrammar

public Grammar parseGrammar(String type, String uri)
Parse a grammar from a location identified by an URI. This method also adds this grammar to the XMLGrammarPool

Parameters: type The type of the grammar to be constructed uri The location of the grammar to be constructed. The parser will not expand this URI or make it available to the EntityResolver

Returns: The newly created Grammar.

Throws: XNIException thrown on an error in grammar construction IOException thrown if an error is encountered in reading the file

parseGrammar

public Grammar parseGrammar(String type, XMLInputSource is)
Parse a grammar from a location identified by an XMLInputSource. This method also adds this grammar to the XMLGrammarPool

Parameters: type The type of the grammar to be constructed is The XMLInputSource containing this grammar's information If a URI is included in the systemId field, the parser will not expand this URI or make it available to the EntityResolver

Returns: The newly created Grammar.

Throws: XNIException thrown on an error in grammar construction IOException thrown if an error is encountered in reading the file

unlockGrammarPool

public void unlockGrammarPool()
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.