public class

XMLGrammarCachingConfiguration

extends XIncludeAwareParserConfiguration
java.lang.Object
   ↳ org.apache.xerces.util.ParserConfigurationSettings
     ↳ org.apache.xerces.parsers.XML11Configuration
       ↳ org.apache.xerces.parsers.XIncludeAwareParserConfiguration
         ↳ org.apache.xerces.parsers.XMLGrammarCachingConfiguration

Class Overview

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:

Summary

Constants
int BIG_PRIME
String SCHEMA_FULL_CHECKING
[Expand]
Inherited Constants
From class org.apache.xerces.parsers.XIncludeAwareParserConfiguration
From class org.apache.xerces.parsers.XML11Configuration
From class org.apache.xerces.util.ParserConfigurationSettings
Fields
protected XMLDTDLoader fDTDLoader
protected XMLSchemaLoader fSchemaLoader
protected static final XMLGrammarPoolImpl fStaticGrammarPool
protected static final SynchronizedSymbolTable fStaticSymbolTable
[Expand]
Inherited Fields
From class org.apache.xerces.parsers.XIncludeAwareParserConfiguration
From class org.apache.xerces.parsers.XML11Configuration
From class org.apache.xerces.util.ParserConfigurationSettings
Public Constructors
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.
Public Methods
void clearGrammarPool()
void lockGrammarPool()
Grammar parseGrammar(String type, XMLInputSource is)
Parse a grammar from a location identified by an XMLInputSource.
Grammar parseGrammar(String type, String uri)
Parse a grammar from a location identified by an URI.
void unlockGrammarPool()
Protected Methods
void checkFeature(String featureId)
Check a feature.
void checkProperty(String propertyId)
Check a property.
[Expand]
Inherited Methods
From class org.apache.xerces.parsers.XIncludeAwareParserConfiguration
From class org.apache.xerces.parsers.XML11Configuration
From class org.apache.xerces.util.ParserConfigurationSettings
From class java.lang.Object
From interface org.apache.xerces.xni.parser.XMLComponentManager
From interface org.apache.xerces.xni.parser.XMLParserConfiguration
From interface org.apache.xerces.xni.parser.XMLPullParserConfiguration

Constants

public static final int BIG_PRIME

Constant Value: 2039 (0x000007f7)

protected static final String SCHEMA_FULL_CHECKING

Constant Value: "http://apache.org/xml/features/validation/schema-full-checking"

Fields

protected XMLDTDLoader fDTDLoader

protected XMLSchemaLoader fSchemaLoader

protected static final XMLGrammarPoolImpl fStaticGrammarPool

protected static final SynchronizedSymbolTable fStaticSymbolTable

Public Constructors

public XMLGrammarCachingConfiguration ()

Default constructor.

public XMLGrammarCachingConfiguration (SymbolTable symbolTable)

Constructs a parser configuration using the specified symbol table.

Parameters
symbolTable The symbol table to use.

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.

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.

Public Methods

public void clearGrammarPool ()

public void lockGrammarPool ()

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

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

public void unlockGrammarPool ()

Protected Methods

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.

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.