org.apache.xerces.parsers

Class CachingParserPool.ShadowedGrammarPool

public static final class CachingParserPool.ShadowedGrammarPool extends XMLGrammarPoolImpl

Shadowed grammar pool. This class is predicated on the existence of a concrete implementation; so using our own doesn't seem to bad an idea.

Author: Andy Clark, IBM Neil Graham, IBM

Constructor Summary
ShadowedGrammarPool(XMLGrammarPool grammarPool)
Constructs a shadowed grammar pool.
Method Summary
voidcacheGrammars(String grammarType, Grammar[] grammars)
Give the grammarPool the option of caching these grammars.
booleancontainsGrammar(XMLGrammarDescription desc)
Returns true if the grammar pool contains a grammar associated to the specified description.
GrammargetGrammar(XMLGrammarDescription desc)
Returns the grammar associated to the specified description.
GrammarretrieveGrammar(XMLGrammarDescription gDesc)
Retrieve a particular grammar.
Grammar[]retrieveInitialGrammarSet(String grammarType)
Retrieve the initial set of grammars for the validator to work with.

Constructor Detail

ShadowedGrammarPool

public ShadowedGrammarPool(XMLGrammarPool grammarPool)
Constructs a shadowed grammar pool.

Method Detail

cacheGrammars

public void cacheGrammars(String grammarType, Grammar[] grammars)
Give the grammarPool the option of caching these grammars. This certainly must be synchronized.

Parameters: grammarType The type of the grammars to be cached. grammars The Grammars that may be cached (unordered, Grammars previously given to the validator may be included).

containsGrammar

public boolean containsGrammar(XMLGrammarDescription desc)
Returns true if the grammar pool contains a grammar associated to the specified description.

Parameters: desc The description of the grammar.

getGrammar

public Grammar getGrammar(XMLGrammarDescription desc)
Returns the grammar associated to the specified description.

Parameters: desc The description of the grammar.

retrieveGrammar

public Grammar retrieveGrammar(XMLGrammarDescription gDesc)
Retrieve a particular grammar. REVISIT: does this need to be synchronized since it's just reading?

Parameters: gDesc Description of the grammar to be retrieved

Returns: Grammar corresponding to gDesc, or null if none exists.

retrieveInitialGrammarSet

public Grammar[] retrieveInitialGrammarSet(String grammarType)
Retrieve the initial set of grammars for the validator to work with. REVISIT: does this need to be synchronized since it's just reading?

Parameters: grammarType Type of the grammars to be retrieved.

Returns: The initial grammar set the validator may place in its "bucket"

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.