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

All Superinterfaces:

MapIndex

public interface MapRangeIndex
extends MapIndex

This interface is an index that allows comparison type searches for a range of keys.

Since:

WAS XD 6.0.1

See Also:

ObjectMap.getIndex(String)

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.websphere.objectgrid.plugins.index.MapIndex

MapIndex.SpecialValue

Field Summary

Fields inherited from interface com.ibm.websphere.objectgrid.plugins.index.MapIndex

EMPTY_VALUE

Method Summary

Iterator	findGreater(Object attributeValue) Finds all keys with entries with an attribute value greater than the specified value.
Iterator	findGreaterEqual(Object attributeValue) Find all keys with entries with an attribute value greater than or equal to the specified value.
Iterator	findLess(Object attributeValue) Finds all keys with entries with an attribute value less than the specified value.
Iterator	findLessEqual(Object attributeValue) Finds all keys with entries with an attribute value less than or equal to the specified value.
Iterator	findMax() Returns the keys for the entries that have the maximum attribute value.
Iterator	findMin() Returns the keys for the entries that have the minimum attribute value.
Iterator	findRange(Object lowAttributeValue, Object highAttributeValue) Returns all keys for the entries with an attribute value inclusively within the specified range such that lowAttributeValue <= attribute value < highAttributeValue.
Iterator	findRange(Object lowAttributeValue, Object highAttributeValue, boolean includesLowAttributeValue, boolean includesHighAttributeValue) Returns all keys for the entries with an attribute value.

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.index.MapIndex

findAll, findAll

Method Detail

findGreater

Iterator findGreater(Object attributeValue)
                     throws FinderException

Finds all keys with entries with an attribute value greater than the specified value.

Parameters:

attributeValue - is the low endpoint of the range excluding the low attribute value.

Returns:

the set of keys for the entries with an attribute value greater than the specified attribute value.

Throws:

IllegalArgumentException - if attributeValue is null.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findGreater from completing.

findGreaterEqual

Iterator findGreaterEqual(Object attributeValue)
                          throws FinderException

Find all keys with entries with an attribute value greater than or equal to the specified value.

Parameters:

attributeValue - is the low endpoint of the range including the low attribute value.

Returns:

the set of keys for the entries with an attribute value greater than or equal to the specified attribute value.

Throws:

IllegalArgumentException - if attributeValue is null.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findGreaterEqual from completing.

findLess

Iterator findLess(Object attributeValue)
                  throws FinderException

Finds all keys with entries with an attribute value less than the specified value.

Parameters:

attributeValue - is the high endpoint of the range excluding the high attribute value.

Returns:

the set of keys for the entries with an attribute value less than the specified attribute value.

Throws:

IllegalArgumentException - if attributeValue is null.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findLess from completing.

findLessEqual

Iterator findLessEqual(Object attributeValue)
                       throws FinderException

Finds all keys with entries with an attribute value less than or equal to the specified value.

Parameters:

attributeValue - is the high endpoint of the range including the high attribute value.

Returns:

the set of keys for the entries with an attribute value less than or equals to the specified attribute value

Throws:

IllegalArgumentException - if attributeValue is null.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findLessEqual from completing.

findRange

Iterator findRange(Object lowAttributeValue,
                   Object highAttributeValue)
                   throws FinderException

Returns all keys for the entries with an attribute value inclusively within the specified range such that lowAttributeValue <= attribute value < highAttributeValue.

Parameters:

lowAttributeValue - is the low endpoint of the range including the low attribute value.

highAttributeValue - is the high endpoint of range excluding the high attribute value.

Returns:

the set of keys for the entries with an attribute value in specified range of attribute values.

Throws:

IllegalArgumentException - if either lowAttributeValue or highAttributeValue argument is null or lowAttributeValue > highAttributeValue.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findRange from completing.

findRange

Iterator findRange(Object lowAttributeValue,
                   Object highAttributeValue,
                   boolean includesLowAttributeValue,
                   boolean includesHighAttributeValue)
                   throws FinderException

Returns all keys for the entries with an attribute value. The includesLowAttributeValue parameter determines whether to include low attribute value. The includesHighAttributeValue parameter determines whether to include high attribute value.

Parameters:

lowAttributeValue - is the low endpoint of the range.

highAttributeValue - is the high endpoint of range.

includesLowAttributeValue - if true, include the low attribute value of the range.

includesHighAttributeValue - if true, include the high attribute value of the range.

Returns:

the set of keys for the entries with an attribute value in specified range of attribute values.

Throws:

IllegalArgumentException - if either lowAttributeValue or highAttributeValue argument is null or lowAttributeValue > highAttributeValue.

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findRange from completing.

findMin

Iterator findMin()
                 throws FinderException

Returns the keys for the entries that have the minimum attribute value.

Returns:

the list of the keys for the entries with the minimum attribute value

Throws:

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findMin from completing.

Since:

WAS XD 6.1

findMax

Iterator findMax()
                 throws FinderException

Returns the keys for the entries that have the maximum attribute value.

Returns:

the list of the keys for the entries with the maximum attribute value

Throws:

FinderException - if an exception or retry limit is reached when concurrent transactions updating the index prevent findMax from completing.

Since:

WAS XD 6.1