public interface XMLGrammarPool
This interface specifies how the parser and the application interact with respect to Grammar objects that the application possesses--either by having precompiled them or by having stored them from a previous validation of an instance document. It makes no assumptions about the kind of Grammar involved, or about how the application's storage mechanism works.
The interaction works as follows:
retrieveInitialGrammarSet
method. retrieveGrammar
method. cacheGrammars
method; for ease of implementation it may make other Grammars it holds references to as well (i.e.,
it may return some grammars that were retrieved from the GrammarPool in earlier operations). Modifier and Type | Method and Description |
---|---|
void |
cacheGrammars(String grammarType,
Grammar[] grammars)
return the final set of grammars that the validator ended up
with.
|
void |
clear()
Removes all grammars from the pool.
|
void |
lockPool()
Causes the XMLGrammarPool not to store any grammars when
the cacheGrammars(String, Grammar[[]) method is called.
|
Grammar |
retrieveGrammar(XMLGrammarDescription desc)
This method requests that the application retrieve a grammar
corresponding to the given GrammarIdentifier from its cache.
|
Grammar[] |
retrieveInitialGrammarSet(String grammarType)
retrieve the initial known set of grammars.
|
void |
unlockPool()
Allows the XMLGrammarPool to store grammars when its cacheGrammars(String, Grammar[])
method is called.
|
Grammar[] retrieveInitialGrammarSet(String grammarType)
retrieve the initial known set of grammars. this method is called by a validator before the validation starts. the application can provide an initial set of grammars available to the current validation attempt.
grammarType
- the type of the grammar, from the
org.apache.xerces.xni.grammars.Grammar
interface.void cacheGrammars(String grammarType, Grammar[] grammars)
return the final set of grammars that the validator ended up with. This method is called after the validation finishes. The application may then choose to cache some of the returned grammars.
grammarType
- the type of the grammars being returned;grammars
- an array containing the set of grammars being
returned; order is not significant.Grammar retrieveGrammar(XMLGrammarDescription desc)
This method requests that the application retrieve a grammar corresponding to the given GrammarIdentifier from its cache. If it cannot do so it must return null; the parser will then call the EntityResolver. An application must not call its EntityResolver itself from this method; this may result in infinite recursions.
desc
- The description of the Grammar being requested.void lockPool()
void unlockPool()
void clear()
Copyright © 2017 JBoss by Red Hat. All rights reserved.