Package org.apache.xerces.util

Class XMLGrammarPoolImpl

java.lang.Object
org.apache.xerces.util.XMLGrammarPoolImpl
All Implemented Interfaces:
org.apache.xerces.xni.grammars.XMLGrammarPool
Direct Known Subclasses:
CachingParserPool.ShadowedGrammarPool, XSGrammarPool
public class XMLGrammarPoolImpl extends Object implements org.apache.xerces.xni.grammars.XMLGrammarPool
Stores grammars in a pool associated to a specific key. This grammar pool implementation stores two types of grammars: those keyed by the root element name, and those keyed by the grammar's target namespace. This is the default implementation of the GrammarPool interface. As we move forward, this will become more function-rich and robust.
Version:
$Id: XMLGrammarPoolImpl.java 447241 2006-09-18 05:12:57Z mrglavas $
Author:
Jeffrey Rodriguez, IBM, Andy Clark, IBM, Neil Graham, IBM, Pavani Mukthipudi, Sun Microsystems, Neeraj Bajaj, SUN Microsystems

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static final class 
    XMLGrammarPoolImpl.Entry
    This class is a grammar pool entry.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    fGrammarCount
     
    protected XMLGrammarPoolImpl.Entry[]
    fGrammars
    Grammars.
    protected boolean
    fPoolIsLocked
     
    protected static final int
    TABLE_SIZE
    Default size.

  • Constructor Summary

    Constructors
    Constructor
    Description
    XMLGrammarPoolImpl()
    Constructs a grammar pool with a default number of buckets.
    XMLGrammarPoolImpl(int initialCapacity)
    Constructs a grammar pool with a specified number of buckets.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cacheGrammars(String grammarType, org.apache.xerces.xni.grammars.Grammar[] grammars)
    return the final set of grammars that the validator ended up with.
    void
    clear()
    Removes all grammars from the pool.
    boolean
    containsGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
    Returns true if the grammar pool contains a grammar associated to the specified grammar description.
    boolean
    equals(org.apache.xerces.xni.grammars.XMLGrammarDescription desc1, org.apache.xerces.xni.grammars.XMLGrammarDescription desc2)
    This method checks whether two grammars are the same.
    org.apache.xerces.xni.grammars.Grammar
    getGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
    Returns the grammar associated to the specified grammar description.
    int
    hashCode(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
    Returns the hash code value for the given grammar description.
    void
    lockPool()
    Causes the XMLGrammarPool not to store any grammars when the cacheGrammars(String, Grammar[[]) method is called.
    void
    putGrammar(org.apache.xerces.xni.grammars.Grammar grammar)
    Puts the specified grammar into the grammar pool and associates it to its root element name or its target namespace.
    org.apache.xerces.xni.grammars.Grammar
    removeGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
    Removes the grammar associated to the specified grammar description from the grammar pool and returns the removed grammar.
    org.apache.xerces.xni.grammars.Grammar
    retrieveGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
    This method requests that the application retrieve a grammar corresponding to the given GrammarIdentifier from its cache.
    org.apache.xerces.xni.grammars.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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • TABLE_SIZE

      protected static final int TABLE_SIZE
      Default size.
      See Also:

    • fGrammars

      protected XMLGrammarPoolImpl.Entry[] fGrammars
      Grammars.

    • fPoolIsLocked

      protected boolean fPoolIsLocked

    • fGrammarCount

      protected int fGrammarCount

  • Constructor Details

    • XMLGrammarPoolImpl

      public XMLGrammarPoolImpl()
      Constructs a grammar pool with a default number of buckets.

    • XMLGrammarPoolImpl

      public XMLGrammarPoolImpl(int initialCapacity)
      Constructs a grammar pool with a specified number of buckets.

  • Method Details

    • retrieveInitialGrammarSet

      public org.apache.xerces.xni.grammars.Grammar[] retrieveInitialGrammarSet(String grammarType)
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool

      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.

      Specified by:
      retrieveInitialGrammarSet in interface org.apache.xerces.xni.grammars.XMLGrammarPool
      Parameters:
      grammarType - the type of the grammar, from the org.apache.xerces.xni.grammars.Grammar interface.
      Returns:
      the set of grammars the validator may put in its "bucket"

    • cacheGrammars

      public void cacheGrammars(String grammarType, org.apache.xerces.xni.grammars.Grammar[] grammars)
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool

      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.

      Specified by:
      cacheGrammars in interface org.apache.xerces.xni.grammars.XMLGrammarPool
      Parameters:
      grammarType - the type of the grammars being returned;
      grammars - an array containing the set of grammars being returned; order is not significant.

    • retrieveGrammar

      public org.apache.xerces.xni.grammars.Grammar retrieveGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool

      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.

      Specified by:
      retrieveGrammar in interface org.apache.xerces.xni.grammars.XMLGrammarPool
      Parameters:
      desc - The description of the Grammar being requested.
      Returns:
      the Grammar corresponding to this description or null if no such Grammar is known.

    • putGrammar

      public void putGrammar(org.apache.xerces.xni.grammars.Grammar grammar)
      Puts the specified grammar into the grammar pool and associates it to its root element name or its target namespace.
      Parameters:
      grammar - The Grammar.

    • getGrammar

      public org.apache.xerces.xni.grammars.Grammar getGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
      Returns the grammar associated to the specified grammar description. Currently, the root element name is used as the key for DTD grammars and the target namespace is used as the key for Schema grammars.
      Parameters:
      desc - The Grammar Description.

    • removeGrammar

      public org.apache.xerces.xni.grammars.Grammar removeGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
      Removes the grammar associated to the specified grammar description from the grammar pool and returns the removed grammar. Currently, the root element name is used as the key for DTD grammars and the target namespace is used as the key for Schema grammars.
      Parameters:
      desc - The Grammar Description.
      Returns:
      The removed grammar.

    • containsGrammar

      public boolean containsGrammar(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
      Returns true if the grammar pool contains a grammar associated to the specified grammar description. Currently, the root element name is used as the key for DTD grammars and the target namespace is used as the key for Schema grammars.
      Parameters:
      desc - The Grammar Description.

    • lockPool

      public void lockPool()
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool
      Causes the XMLGrammarPool not to store any grammars when the cacheGrammars(String, Grammar[[]) method is called.
      Specified by:
      lockPool in interface org.apache.xerces.xni.grammars.XMLGrammarPool

    • unlockPool

      public void unlockPool()
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool
      Allows the XMLGrammarPool to store grammars when its cacheGrammars(String, Grammar[]) method is called. This is the default state of the object.
      Specified by:
      unlockPool in interface org.apache.xerces.xni.grammars.XMLGrammarPool

    • clear

      public void clear()
      Description copied from interface: org.apache.xerces.xni.grammars.XMLGrammarPool
      Removes all grammars from the pool.
      Specified by:
      clear in interface org.apache.xerces.xni.grammars.XMLGrammarPool

    • equals

      public boolean equals(org.apache.xerces.xni.grammars.XMLGrammarDescription desc1, org.apache.xerces.xni.grammars.XMLGrammarDescription desc2)
      This method checks whether two grammars are the same. Currently, we compare the root element names for DTD grammars and the target namespaces for Schema grammars. The application can override this behaviour and add its own logic.
      Parameters:
      desc1 - The grammar description
      desc2 - The grammar description of the grammar to be compared to
      Returns:
      True if the grammars are equal, otherwise false

    • hashCode

      public int hashCode(org.apache.xerces.xni.grammars.XMLGrammarDescription desc)
      Returns the hash code value for the given grammar description.
      Parameters:
      desc - The grammar description
      Returns:
      The hash code value