CoherenceTM v3.1.3
Copyright© 2000-2006 by Tangosol, Inc.

com.tangosol.util
Interface QueryMap

All Superinterfaces:
Map
All Known Subinterfaces:
NamedCache
All Known Implementing Classes:
ContinuousQueryCache, ConverterCollections.ConverterMap, ConverterCollections.ConverterObservableMap, ConverterCollections.ConverterSortedMap, NearCache, VersionedNearCache, WrapperNamedCache

public interface QueryMap
extends Map

Map with additional query features.

Author:
gg 2002.09.24

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry
 
Method Summary
 void addIndex(ValueExtractor extractor, boolean fOrdered, Comparator comparator)
          Add an index to this QueryMap.
 Set entrySet(Filter filter)
          Return a set view of the entries contained in this map that satisfy the criteria expressed by the filter.
 Set entrySet(Filter filter, Comparator comparator)
          Return a set view of the entries contained in this map that satisfy the criteria expressed by the filter.
 Set keySet(Filter filter)
          Return a set view of the keys contained in this map for entries that satisfy the criteria expressed by the filter.
 void removeIndex(ValueExtractor extractor)
          Remove an index from this QueryMap.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

keySet

Set keySet(Filter filter)
Return a set view of the keys contained in this map for entries that satisfy the criteria expressed by the filter.

Unlike the Map.keySet() method, the set returned by this method may not be backed by the map, so changes to the set may not reflected in the map, and vice-versa.

Note: The Partitioned Cache implements this method using the Parallel Query feature, which is only available in the Coherence Enterprise Edition. When working with a Partitioned Cache in the Coherence Clustered Edition, this method will throw an exception.

Parameters:
filter - the Filter object representing the criteria that the entries of this map should satisfy
Returns:
a set of keys for entries that satisfy the specified criteria

entrySet

Set entrySet(Filter filter)
Return a set view of the entries contained in this map that satisfy the criteria expressed by the filter. Each element in the returned set is a Map.Entry.

Unlike the Map.entrySet() method, the set returned by this method may not be backed by the map, so changes to the set may not reflected in the map, and vice-versa.

Note: The Partitioned Cache implements this method using the Parallel Query feature, which is only available in the Coherence Enterprise Edition. When working with a Partitioned Cache in the Coherence Clustered Edition, this method will throw an exception.

Parameters:
filter - the Filter object representing the criteria that the entries of this map should satisfy
Returns:
a set of entries that satisfy the specified criteria

entrySet

Set entrySet(Filter filter,
             Comparator comparator)
Return a set view of the entries contained in this map that satisfy the criteria expressed by the filter. Each element in the returned set is a Map.Entry. It is further guaranteed that its iterator will traverse the set in such a way that the entry values come up in ascending order, sorted by the specified Comparator or according to the natural ordering (see Comparable).

Unlike the Map.entrySet() method, the set returned by this method may not be backed by the map, so changes to the set may not reflected in the map, and vice-versa.

Note: The Partitioned Cache implements this method using the Parallel Query feature, which is only available in the Coherence Enterprise Edition. When working with a Partitioned Cache in the Coherence Clustered Edition, this method will throw an exception.

Parameters:
filter - the Filter object representing the criteria that the entries of this map should satisfy
comparator - the Comparator object which imposes an ordering on entries in the resulting set; or null if the entries' values natural ordering should be used
Returns:
a set of entries that satisfy the specified criteria
See Also:
ChainedComparator

addIndex

void addIndex(ValueExtractor extractor,
              boolean fOrdered,
              Comparator comparator)
Add an index to this QueryMap. This allows to correlate values stored in this indexed Map (or attributes of those values) to the corresponding keys in the indexed Map and increase the performance of keySet and entrySet methods.

This method is only intended as a hint to the cache implementation, and as such it may be ignored by the cache if indexes are not supported or if the desired index (or a similar index) already exists. It is expected that an application will call this method to suggest an index even if the index may already exist, just so that the application is certain that index has been suggested. For example in a distributed environment, each server will likely suggest the same set of indexes when it starts, and there is no downside to the application blindly requesting those indexes regardless of whether another server has already requested the same indexes.

Note: Indexes are a Coherence Enterprise Edition feature. This method will have no effect when using Coherence Clustered Edition.

Parameters:
extractor - the ValueExtractor object that is used to extract an indexable Object from a value stored in the indexed Map. Must not be null.
fOrdered - true iff the contents of the indexed information should be ordered; false otherwise
comparator - the Comparator object which imposes an ordering on entries in the indexed map; or null if the entries' values natural ordering should be used
See Also:
ReflectionExtractor, ChainedComparator

removeIndex

void removeIndex(ValueExtractor extractor)
Remove an index from this QueryMap.

Parameters:
extractor - the ValueExtractor object that is used to extract an indexable Object from a value stored in the Map.

CoherenceTM v3.1.3
Copyright© 2000-2006 by Tangosol, Inc.