Class COM.ibm.jaws.services.filepobc.FilepoBCImpl
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.ibm.jaws.services.filepobc.FilepoBCImpl

java.lang.Object
   |
   +----COM.ibm.jaws.motk.BaseAO
           |
           +----COM.ibm.jaws.services.filepobc.FilepoBCImpl

public class FilepoBCImpl
extends BaseAO
implements FilepoBC

FilepoBCImpl is an implementation of the FilepoBC interface.


Variable Index

 o delimiter
This is the delimiter that this BC puts between its Identifier key and the rest of Identifier.
 o dependentContext
This FilepoBCImpl's dependent context for itself.
 o homogeneousInterfaceName
When this FilepoBCImpl instance is homogeneous, this is its interface name.
 o interfaceKeyPrefix
 o key
 o rootBase
This BC instance's root BC.
 o self
This BC gives out references to itself.

Constructor Index

 o FilepoBCImpl()
Simple constructor.
 o FilepoBCImpl(String, long, String, String, long)
Parameterized constructor.
 o FilepoBCImpl(String, String)
Parameterized constructor for homogeneous case.

Method Index

 o createFromCopy(String, Manageable, String)
Implementation of the BaseCollection.createFromCopy() method.
 o createFromCopyWithKey(String, Manageable, String)
The createFromCopy() implemetation has already generated a key.
 o createFromData(String, InputEDStream, String)
Implementation of the BaseCollection.createFromData(String,Stream,String) method.
 o createFromDataWithKey(String, InputEDStream, String)
This is the real implementation of createFromXXX().
 o createFromDefault(String, Object, String)
This BC does not implement the following method.
 o dispatch(String, CommandOn)
 o dispatchAll(String, String, CommandOn)
 o evaluate(String, String)
Implementation of Collection evaluateQuery method.
 o exists(String)
Implementation of BaseCollectionDel.exists() method.
 o externalizeToStream(OutputEDStream)
Use this method to export the Manageable object's essential data (ED) to a "sink" represented by an OutputEDStream.
 o finalize()
Code to perform when this object is garbage collected.
 o getCacheManager()
 o getCleanInterval()
 o getDependentContext()
 o getKey()
 o getManagedClassName()
 o getManagedSuffix()
Implementation of FilepoBC.getInterfaceName() method.
 o getTransientIdentifier()
 o internalizeFromStream(InputEDStream)
Implementation of the Streamable interface.
 o kill(String)
 o reattachManagedDel(ManagedDel, String)
 o release()
 o remove()
This BC is not self-persistent, so it writes out none of its own state.
 o resolve(String)
 o setCacheManager(CacheManager)
Allows AA to set and get the CacheManager for this BC.
 o setCleanInterval(long)
Allows AA to set and get the clean interval dynamically.
 o setDependentContext(KeyedCollection)
Implementation of the Dependent interface.
 o setManagedClassName(String)
Implementation of FilepoBC.set/getManagedClassName() methods.
 o setSelf(Object)
Implementation of the IdentityDelegator interface.
 o sync()
Implementation of the Syncable.sync() method.
 o syncManaged(String)
Implementation of the BaseCollectionDel.syncManaged() method.
 o uncached(CacheEntry)
This BC's CacheManager calls this to notify the BC that one of its Cached objects has been uncached.

Variables

 o key
  protected String key
 o homogeneousInterfaceName
  protected String homogeneousInterfaceName
When this FilepoBCImpl instance is homogeneous, this is its interface name. When this FilepoBCImol instance is heterogeneous, this is null.
 o self
  protected FilepoBC self
This BC gives out references to itself. This is a Managed interface that allows an efficient implementation of isIdentical(), getConstantRandomId() and getIdentifier() that it supplies for its Managed objects. FilepoBCImpl does not call these Managed methods on itself.
 o rootBase
  protected BaseCollection rootBase
This BC instance's root BC.
 o delimiter
  protected String delimiter
This is the delimiter that this BC puts between its Identifier key and the rest of Identifier. The default is "/".
 o interfaceKeyPrefix
  protected String interfaceKeyPrefix
 o dependentContext
  protected KeyedCollection dependentContext
This FilepoBCImpl's dependent context for itself.

Constructors

 o FilepoBCImpl
  public FilepoBCImpl()
Simple constructor.
 o FilepoBCImpl
  public FilepoBCImpl(String initialDirectoryPath,
                      long initialCleanInterval,
                      String initialManagedSuffix,
                      String initialCachedSuffix,
                      long initialManagedKeyCount)
Parameterized constructor.
 o FilepoBCImpl
  public FilepoBCImpl(String directoryPath,
                      String managedClassName)
Parameterized constructor for homogeneous case.

Methods

 o getKey
  public String getKey()
 o setManagedClassName
  public void setManagedClassName(String managedClassName)
Implementation of FilepoBC.set/getManagedClassName() methods.
 o getManagedClassName
  public String getManagedClassName()
 o setDependentContext
  public void setDependentContext(KeyedCollection yourDependentContext)
Implementation of the Dependent interface.
Overrides:
setDependentContext in class BaseAO
 o getDependentContext
  public KeyedCollection getDependentContext()
 o setSelf
  public void setSelf(Object yourSelf)
Implementation of the IdentityDelegator interface. This BC hands out references to itself.
Overrides:
setSelf in class BaseAO
 o setCacheManager
  public void setCacheManager(CacheManager yourCacheManager)
Allows AA to set and get the CacheManager for this BC. Because it is part of the EssentialData, it can also be set at creation time.
 o getCacheManager
  public CacheManager getCacheManager()
 o setCleanInterval
  public void setCleanInterval(long newCleanInterval)
Allows AA to set and get the clean interval dynamically. Because it is part of the EssentialData, it can also be set at creation time.
 o getCleanInterval
  public long getCleanInterval()
 o internalizeFromStream
  public void internalizeFromStream(InputEDStream stream) throws EDStreamFormatError
Implementation of the Streamable interface.
Overrides:
internalizeFromStream in class BaseAO
 o externalizeToStream
  public void externalizeToStream(OutputEDStream stream) throws EDStreamFormatError
Use this method to export the Manageable object's essential data (ED) to a "sink" represented by an OutputEDStream.
Overrides:
externalizeToStream in class BaseAO
 o release
  public void release()
Overrides:
release in class BaseAO
 o finalize
  public void finalize()
Code to perform when this object is garbage collected.
Overrides:
finalize in class Object
 o remove
  public void remove()
This BC is not self-persistent, so it writes out none of its own state. This BC does provide persistence to its Managed objects, so remove all Managed objects.
Overrides:
remove in class BaseAO
 o createFromCopy
  public Managed createFromCopy(String identifierKey,
                                Manageable manageable,
                                String interfaceKey) throws InvalidKeyError
Implementation of the BaseCollection.createFromCopy() method. The Manageable parameter provides the initial data for the Managed object. If the key is null, one is generated by via the managedKeyCount. The interface for the returned Managed object is obtained from the dependentContext using the interfaceKey.
 o createFromData
  public Managed createFromData(String identifierKey,
                                InputEDStream initialData,
                                String interfaceKey) throws InvalidKeyError, EDStreamFormatError
Implementation of the BaseCollection.createFromData(String,Stream,String) method. The initialData parameter provides the initial data for the Managed object. If the key is null, one is generated by via the managedKeyCount. The interface for the returned Managed object is obtained from the dependentContext using the interfaceKey.
 o createFromCopyWithKey
  protected Managed createFromCopyWithKey(String key,
                                          Manageable manageable,
                                          String interfaceKey) throws InvalidKeyError
The createFromCopy() implemetation has already generated a key. This just converts the Manageable into a stream and calls createFromData().
 o createFromDataWithKey
  public Managed createFromDataWithKey(String key,
                                       InputEDStream initialData,
                                       String interfaceKey) throws InvalidKeyError, EDStreamFormatError
This is the real implementation of createFromXXX(). The key parameter is the key for the new Managed object. The initialData parameter includes the initial EssentialData of the new Managed object. The interface name for the created Managed object is obtained from the dependentContext using the interfaceKey.
 o createFromDefault
  public Managed createFromDefault(String identifierKey,
                                   Object creator,
                                   String interfaceKey)
This BC does not implement the following method.
 o resolve
  public Object resolve(String keyPath) throws InvalidKeyError
 o kill
  public void kill(String key) throws InvalidReferenceException
 o exists
  public boolean exists(String key)
Implementation of BaseCollectionDel.exists() method.
 o getManagedSuffix
  public String getManagedSuffix()
Implementation of FilepoBC.getInterfaceName() method.
 o reattachManagedDel
  public CacheEntry reattachManagedDel(ManagedDel managed,
                                       String key)
 o uncached
  public void uncached(CacheEntry uncachedEntry)
This BC's CacheManager calls this to notify the BC that one of its Cached objects has been uncached.
 o evaluate
  public Iterator evaluate(String queryArguments,
                           String queryKey) throws InvalidQueryError
Implementation of Collection evaluateQuery method. This only handles two simple query strings: - evaluate(null, "MOFW::objects") which returns all of the objects in this FilepoBCImpl instance. - evaluate(null, "MOFW::keys") which returns the keys of all of the objects in this FilepoBCImpl instance. A more advanced version would use query technology developed by STL and Rochester.
 o dispatch
  public CommandOn dispatch(String key,
                            CommandOn command)
 o dispatchAll
  public Iterator dispatchAll(String queryArguments,
                              String queryKey,
                              CommandOn command)
 o sync
  public void sync()
Implementation of the Syncable.sync() method.
 o syncManaged
  public void syncManaged(String key)
Implementation of the BaseCollectionDel.syncManaged() method.
 o getTransientIdentifier
  public Object getTransientIdentifier()

All Packages  Class Hierarchy  This Package  Previous  Next  Index