|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MapIndex
MapIndex is used to correlate values stored in an indexed Map (or attributes of those values) to the corresponding keys in the indexed Map.
Field Summary | |
---|---|
static Object |
NO_VALUE Constant used to indicate that the index does not contain requested value. |
Method Summary | |
---|---|
void |
delete(Map.Entry entry) Update this index in response to a remove operation on a cache. |
Object |
get(Object oKey) Using the index information if possible, get the value associated with the specified key. |
Comparator |
getComparator() Get the Comparator used to sort the index. |
Map |
getIndexContents() Get the Map that contains the index contents. |
ValueExtractor |
getValueExtractor() Obtain the ValueExtractor object that the MapIndex uses to extract an indexable Object from a value stored in the indexed Map. |
void |
insert(Map.Entry entry) Update this index in response to a insert operation on a cache. |
boolean |
isOrdered() Determine if the MapIndex orders the contents of the indexed information. |
boolean |
isPartial() Determine if indexed information for any entry in the indexed Map has been excluded from this index. |
void |
update(Map.Entry entry) Update this index in response to an update operation on a cache. |
Field Detail |
---|
static final Object NO_VALUE
Method Detail |
---|
ValueExtractor getValueExtractor()
boolean isOrdered()
boolean isPartial()
IndexAwareFilter
implementations to determine the most optimal way to apply the index.Map getIndexContents()
The keys of the Map are the return values from the ValueExtractor operating against the indexed Map's values, and for each key, the corresponding value stored in the Map is a Set of keys to the indexed Map.
If the MapIndex is known to be ordered, then the returned Map object will be an instance of SortedMap
. The SortedMap may or may not have a Comparator
object associated with it; see SortedMap.comparator()
.
A client should assume that the returned Map object is read-only and must not attempt to modify it.
Object get(Object oKey)
oKey
- the key that specifies the object to extract the value fromComparator getComparator()
void insert(Map.Entry entry)
entry
- the entry representing the object being insertedvoid update(Map.Entry entry)
entry
- the entry representing the object being updatedvoid delete(Map.Entry entry)
entry
- the entry representing the object being removed
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |