com.ibm.websphere.objectgrid.plugins.index
Interface MapGlobalIndex<KeyType,ValueType,AttributeType>

Type Parameters:

KeyType - The map key type.

ValueType - The map value type.

AttributeType - The indexed attribute type.

public interface MapGlobalIndex<KeyType,ValueType,AttributeType>

This interface is an abstract index that can be created on a Map. The index can be used to perform efficient look ups on attributes in a Map.

Since:

WXS 8.6

Method Summary

Map<KeyType,ValueType>	findEntries(AttributeType... attributes) Returns the keys and entries that have the specified attribute values.
Map<AttributeType,Map<KeyType,ValueType>>	findEntriesByAttribute(AttributeType... attributes) Returns a map of the keys and entries for the specified attribute values.
Set<KeyType>	findKeys(AttributeType... attributes) Returns the keys for the entries that have the specified attribute values.
Map<AttributeType,Set<KeyType>>	findKeysByAttribute(AttributeType... attributes) Returns a map of the keys of the entries for the specified attribute values.
Collection<Integer>	findPartitions(AttributeType... attributes) Returns the partitions contain the entries that have the specified attribute values.
Map<AttributeType,Collection<Integer>>	findPartitionsByAttribute(AttributeType... attributes) Returns a map of partitions contain the entries for specified attribute values.
int	findSize(AttributeType... attributes) Returns the number of entries that have the specified attribute values.
Map<AttributeType,Integer>	findSizesByAttribute(AttributeType... attributes) Returns a map of the number of entries for specified attribute values.
Set<ValueType>	findValues(AttributeType... attributes) Returns the entries that have the specified attribute values.
Map<AttributeType,Set<ValueType>>	findValuesByAttribute(AttributeType... attributes) Returns a map of the entries for the specified attribute values.

Method Detail

findPartitions

Collection<Integer> findPartitions(AttributeType... attributes)

Returns the partitions contain the entries that have the specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

the partitions contain the entries that have the specified attribute values.

Throws:

GlobalIndexException

findPartitionsByAttribute

Map<AttributeType,Collection<Integer>> findPartitionsByAttribute(AttributeType... attributes)

Returns a map of partitions contain the entries for specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

A map of partitions contain the entries for the specified attribute values.

Throws:

GlobalIndexException

findKeys

Set<KeyType> findKeys(AttributeType... attributes)

Returns the keys for the entries that have the specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

Returns the keys for the entries that have the specified attribute values.

Throws:

GlobalIndexException

findKeysByAttribute

Map<AttributeType,Set<KeyType>> findKeysByAttribute(AttributeType... attributes)

Returns a map of the keys of the entries for the specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

a map of the keys of the entries for the specified attribute

Throws:

GlobalIndexException

findValues

Set<ValueType> findValues(AttributeType... attributes)

Returns the entries that have the specified attribute values.

Parameters:

attributes - the attribute values to search for.

Returns:

the entries that have the specified attribute values.

Throws:

GlobalIndexException

findValuesByAttribute

Map<AttributeType,Set<ValueType>> findValuesByAttribute(AttributeType... attributes)

Returns a map of the entries for the specified attribute values.

Parameters:

attributes - the attribute values to search for.

Returns:

a map of the entries for the specified attribute values.

Throws:

GlobalIndexException

findEntries

Map<KeyType,ValueType> findEntries(AttributeType... attributes)

Returns the keys and entries that have the specified attribute values.

Parameters:

attributes - the attribute values to search for.

Returns:

the keys and entries that have the specified attribute values.

Throws:

GlobalIndexException

findEntriesByAttribute

Map<AttributeType,Map<KeyType,ValueType>> findEntriesByAttribute(AttributeType... attributes)

Returns a map of the keys and entries for the specified attribute values.

Parameters:

attributes - the attribute values to search for.

Returns:

the keys and entries that have the specified attribute values.

Throws:

GlobalIndexException

findSize

int findSize(AttributeType... attributes)

Returns the number of entries that have the specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

the number of entries that have the specified attribute values.

Throws:

GlobalIndexException

findSizesByAttribute

Map<AttributeType,Integer> findSizesByAttribute(AttributeType... attributes)

Returns a map of the number of entries for specified attribute values.

Parameters:

attributeValues - a reference to the attribute values to search for.

Returns:

a map of the number of entries for specified attribute values.

Throws:

GlobalIndexException