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

This package contains the interfaces for the Map index related plug-in framework.

See:
Description

Interface Summary

DynamicIndexCallback	This interface provides a callback mechanism for dynamic indexing process.
MapGlobalIndex<KeyType,ValueType,AttributeType>	This interface is an abstract index that can be created on a Map.
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	HashIndex is a built-in index implementation of a MapIndexPlugin and can be used for typical indexing operations.
InverseRangeIndex	InverseRangeIndex is a built-in index implementation of MapIndexPlugin for storing range data and could be used for looking up single item with in a range.
MapIndex.SpecialValue	This class represents directives for finding types of values in an index.

Exception Summary

FinderException	This exception is thrown when an index finder method encounters an error.
GlobalIndexException	Used when global index operation run into error.

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

This package contains the interfaces for the Map index related plug-in framework.

Overview

Map index plug-in framework provides a way to index cached objects for non-key search. In most cases, the supplied, built-in implementation can be used: HashIndex.

Implementing an index

Custom map index implementations can also be created by implementing 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 using the ObjectMap.getIndex(String) method.