IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

com.ibm.websphere.objectgrid.plugins.index
Interface MapIndexInfo


public interface MapIndexInfo

This interface is used to provide an index with detailed change information for a specific Map in a transaction.

Since:
WAS XD 6.0.1
See Also:
MapIndexPlugin.getIndexProxy(MapIndexInfo)

Method Summary
 BackingMap getBackingMap()
          Returns the BackingMap the index is associated with.
 ObjectMap getMap()
          Returns the ObjectMap the index is associated with.
 List getTransactionChanges(boolean includeRemoved)
          Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
 List getTransactionChanges(List keys)
          Returns the set of changes as they apply to a particular set of keys in the current transaction for the ObjectMap that is returned by the getMap() method.
 LogSequence getTransactionLogSequence()
          Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
 

Method Detail

getMap

ObjectMap getMap()
Returns the ObjectMap the index is associated with.

Returns:
the ObjectMap this index is associated with.
See Also:
ObjectMap

getTransactionChanges

List getTransactionChanges(boolean includeRemoved)
                           throws ObjectGridRuntimeException
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.

Parameters:
includeRemoved - must be set to true to include LogElement.DELETE types in the list returned by this method.
Returns:
a List of LogElements created for each ObjectMap entry that was either inserted, updated, or removed by the current transaction.
Throws:
ObjectGridRuntimeException - if an error occurs during processing
See Also:
getMap(), LogElement.DELETE

getTransactionChanges

List getTransactionChanges(List keys)
                           throws ObjectGridRuntimeException
Returns the set of changes as they apply to a particular set of keys in the current transaction for the ObjectMap that is returned by the getMap() method. If a key has not been referenced in the transaction then null is returned.

Parameters:
keys - The list of keys for which the data is required.
Returns:
A List of LogElements corresponding to the keys specified. A null entry in the list indicates the key was not referenced.
Throws:
ObjectGridRuntimeException - if an error occurs during processing
See Also:
getMap(), LogElement, ObjectMap

getBackingMap

BackingMap getBackingMap()
Returns the BackingMap the index is associated with.

Returns:
the BackingMap this index is associated with.
Since:
WAS XD 6.1
See Also:
BackingMap

getTransactionLogSequence

LogSequence getTransactionLogSequence()
                                      throws ObjectGridRuntimeException
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.

Throws:
ObjectGridRuntimeException - if an error occurs during processing
Since:
WAS XD 6.1
See Also:
getMap(), LogElement.DELETE

IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.