IBM WebSphere Extended Deployment (XD)TM, Release 6.1
ObjectGrid API Specification

Package com.ibm.websphere.objectgrid.plugins.index

This package contains the interfaces for the Map index related plugin framework.

See:
          Description

Interface Summary
DynamicIndexCallback This interface provides a callback mechanism for dynamic indexing process.
MapIndex This interface is an abstract index that can be created on a Map.
MapIndexInfo This interface is used to provide an index with detailed change information for a specific Map in a transaction.
MapIndexPlugin An index implementation must implement this interface to get modifications to the Map so it can maintain the index as transactions are committed.
MapRangeIndex This interface is an index that allows comparison type searches for a range of keys.
 

Class Summary
HashIndex This class is a built-in implementation of MapIndexPlugin.
 

Exception Summary
FinderException This exception is thrown when an index finder method encounters an error.
 

Package com.ibm.websphere.objectgrid.plugins.index Description

This package contains the interfaces for the Map index related plugin framework.

Overview

Map index plugin framework provides a way to index cached objects for non-key search.

Implementing an index

Make a class that implements the MapIndexPlugin interface. This class will need to return an object that implements the index specific interface (such as MapIndex or MapRangeIndex) when the application asks the ObjectMap for a reference to an index. The com.ibm.websphere.objectgrid.plugins.index.HashIndex class is the built-in MapIndexPlugin implementation that can be used to configure on maps.


IBM WebSphere Extended Deployment (XD)TM, Release 6.1
ObjectGrid API Specification

© Copyright International Business Machines Corp 2005-2007. All rights reserved.