gate
Class DataStoreRegister

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractSet
              |
              +--java.util.HashSet
                    |
                    +--gate.DataStoreRegister
All Implemented Interfaces:
Cloneable, Collection, Serializable, Set

public class DataStoreRegister
extends HashSet

Records all the open DataStores.

See Also:
Serialized Form

Constructor Summary
DataStoreRegister()
           
 
Method Summary
 boolean add(Object o)
          Adds the specified element to this set if it is not already present.
static void addConfig(Map configData)
          Adds configuration data (e.g.
 void addCreoleListener(CreoleListener l)
          Registers a new CreoleListener with this DataStoreRegister.
static void addSecurityData(DataStore ds, Map secData)
          Adds security data for this datastore
 void clear()
          Removes all of the elements from this set.
static Map getConfigData()
          Get the configuration data map.
static Map getDataStoreClassNames()
          All the DataStore classes available.
static Map getSecurityData(DataStore ds)
          Returns the security data for this datastore
 boolean remove(Object o)
          Removes the given element from this set if it is present.
 void removeCreoleListener(CreoleListener l)
          Removes a previously registered CreoleListener from the list of listeners for this DataStoreRegister.
static void removeSecurityData(DataStore ds)
          Removes the security data for this datastore
 
Methods inherited from class java.util.HashSet
clone, contains, isEmpty, iterator, size
 
Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll
 
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray
 

Constructor Detail

DataStoreRegister

public DataStoreRegister()
Method Detail

getDataStoreClassNames

public static Map getDataStoreClassNames()
All the DataStore classes available. This is a map of class name to descriptive text.

add

public boolean add(Object o)
Adds the specified element to this set if it is not already present. Overriden here for event registration code.
Overrides:
add in class HashSet

remove

public boolean remove(Object o)
Removes the given element from this set if it is present. Overriden here for event registration code.
Overrides:
remove in class HashSet

clear

public void clear()
Removes all of the elements from this set. Overriden here for event registration code.
Overrides:
clear in class HashSet

getConfigData

public static Map getConfigData()
Get the configuration data map.

addConfig

public static void addConfig(Map configData)
Adds configuration data (e.g. from gate.xml files) to the register. New key/value pairs are added to the existing set (this will overwrite existing pairs whose keys match new ones).

getSecurityData

public static Map getSecurityData(DataStore ds)
Returns the security data for this datastore

addSecurityData

public static void addSecurityData(DataStore ds,
                                   Map secData)
Adds security data for this datastore

removeSecurityData

public static void removeSecurityData(DataStore ds)
Removes the security data for this datastore

removeCreoleListener

public void removeCreoleListener(CreoleListener l)
Removes a previously registered CreoleListener from the list of listeners for this DataStoreRegister. Normally the only listener that is registered with the DataStoreRegister is the CreoleRegister which can be obtained through Gate.getCreoleRegister()

addCreoleListener

public void addCreoleListener(CreoleListener l)
Registers a new CreoleListener with this DataStoreRegister. Normally the only listener that is registered with the DataStoreRegister is the CreoleRegister which can be obtained through Gate.getCreoleRegister()