|
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 |
java.lang.Object
com.tangosol.util.Base
com.tangosol.util.SimpleMapIndex
public class SimpleMapIndex
SimpleMapIndex is a MapIndex implemenation used to correlate property values extracted from resource map entries with corresponding keys using what is commonly known as an Inverted Index algorithm..
Field Summary | |
---|---|
protected Comparator |
m_comparator Comparator used to sort the index. |
protected ValueExtractor |
m_extractor ValueExtractor object that this MapIndex uses to extract an indexable property value from a [converted] value stored in the resource map. |
protected boolean |
m_fOrdered Specifies whether or not this MapIndex orders the contents of the indexed information. |
protected boolean |
m_fSplitCollection If a value extracted by the ValueExtractor is a Collection, this property specifies whether or not it should be treated as a Collection of contained attributes or indexed as a single composite attribute. |
protected Map |
m_mapForward Map that contains the index values (forward index). |
protected Map |
m_mapInverse Map that contains the index contents (inverse index). |
Fields inherited from interface com.tangosol.util.MapIndex |
---|
NO_VALUE |
Constructor Summary | |
---|---|
|
SimpleMapIndex(ValueExtractor extractor, boolean fOrdered, Comparator comparator) Construct an index for the given map. |
protected |
SimpleMapIndex(ValueExtractor extractor, boolean fOrdered, Comparator comparator, boolean fInit) Construct an index for the given map. |
Method Summary | |
---|---|
protected Object |
addInverseCollectionMapping(Map mapIndex, Object oIxValue, Object oKey) Add new mappings from the elements of the given value to the given key in the supplied index. |
protected Object |
addInverseMapping(Map mapIndex, Object oIxValue, Object oKey) Add a new mapping from the given indexed value to the given key in the supplied index. |
protected Object |
addInverseMapping(Object oIxValue, Object oKey) Add a new mapping from the given indexed value to the given key in the inverse index. |
void |
delete(Map.Entry entry) Update this index in response to a remove operation on a cache. |
protected void |
deleteInternal(Map.Entry entry) Update this index in response to a remove operation on a cache. |
boolean |
equals(Object o) Compares the specified object with this index for equality. |
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. |
protected Map.Entry |
getForwardEntry(Object oKey) Get the forward index entry associated with the specified key. |
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. |
int |
hashCode() Returns the hash code value for this MapIndex. |
protected void |
initialize() Initialize the index's data structures. |
void |
insert(Map.Entry entry) Update this index in response to a insert operation on a cache. |
protected void |
insertInternal(Map.Entry entry) Update this index in response to a insert operation on a cache. |
protected Map |
instantiateForwardIndex() Instantiate the forward index. |
protected Map |
instantiateInverseIndex(boolean fOrdered, Comparator comparator) Instantiate the inverse index. |
protected Set |
instantiateSet() Factory method used to create a new set containing the keys associated with a single value. |
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. |
protected void |
removeInverseMapping(Map mapIndex, Object oIxValue, Object oKey) Remove the mapping from the given indexed value to the given key from the supplied index. |
protected void |
removeInverseMapping(Object oIxValue, Object oKey) Remove the mapping from the given indexed value to the given key from the inverse index. |
String |
toString() Returns a string representation of this SimpleMapIndex. |
void |
update(Map.Entry entry) Update this index in response to an update operation on a cache. |
protected void |
updateInternal(Map.Entry entry) Update this index in response to an update operation on a cache. |
Field Detail |
---|
protected ValueExtractor m_extractor
protected Comparator m_comparator
protected boolean m_fOrdered
protected Map m_mapForward
protected Map m_mapInverse
protected boolean m_fSplitCollection
Constructor Detail |
---|
public SimpleMapIndex(ValueExtractor extractor, boolean fOrdered, Comparator comparator)
extractor
- the ValueExtractor that is used to extract an indexed value from a resource map entryfOrdered
- true iff the contents of the indexed information should be ordered; false otherwisecomparator
- the Comparator object which imposes an ordering on entries in the index map; or null if the entries' values natural ordering should be usedprotected SimpleMapIndex(ValueExtractor extractor, boolean fOrdered, Comparator comparator, boolean fInit)
extractor
- the ValueExtractor that is used to extract an indexed value from a resource map entryfOrdered
- true iff the contents of the indexed information should be ordered; false otherwisecomparator
- the Comparator object which imposes an ordering on entries in the index map; or null if the entries' values natural ordering should be usedfInit
- initialize the index if trueMethod Detail |
---|
public ValueExtractor getValueExtractor()
getValueExtractor
in interface MapIndex
public boolean isOrdered()
isOrdered
in interface MapIndex
public boolean isPartial()
IndexAwareFilter
implementations to determine the most optimal way to apply the index.isPartial
in interface MapIndex
public Comparator getComparator()
getComparator
in interface MapIndex
public 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.
getIndexContents
in interface MapIndex
public Object get(Object oKey)
get
in interface MapIndex
oKey
- the key that specifies the object to extract the value frompublic void insert(Map.Entry entry)
insert
in interface MapIndex
entry
- the entry representing the object being insertedpublic void update(Map.Entry entry)
update
in interface MapIndex
entry
- the entry representing the object being updatedpublic void delete(Map.Entry entry)
delete
in interface MapIndex
entry
- the entry representing the object being removedprotected void initialize()
protected Map.Entry getForwardEntry(Object oKey)
oKey
- the keyprotected Map instantiateForwardIndex()
getForwardEntry(Object)
method accordingly.protected Map instantiateInverseIndex(boolean fOrdered, Comparator comparator)
fOrdered
- true iff the contents of the indexed information should be ordered; false otherwisecomparator
- the Comparator object which imposes an ordering on entries in the index map; or null if the entries' values natural ordering should be usedprotected void insertInternal(Map.Entry entry)
entry
- the entry representing the object being insertedprotected void updateInternal(Map.Entry entry)
entry
- the entry representing the object being updatedprotected void deleteInternal(Map.Entry entry)
entry
- the entry representing the object being removedprotected Object addInverseMapping(Object oIxValue, Object oKey)
oIxValue
- the indexed value (serves as a key in the inverse index)oKey
- the key to insert into the inverse indexprotected Object addInverseMapping(Map mapIndex, Object oIxValue, Object oKey)
mapIndex
- the index to which to add the mappingoIxValue
- the indexed value (serves as a key in the inverse index)oKey
- the key to insert into the inverse indexprotected Object addInverseCollectionMapping(Map mapIndex, Object oIxValue, Object oKey)
mapIndex
- the index to which to add the mappingoIxValue
- the indexed Collection value (each element serves as a key in the inverse index)oKey
- the key to insert into the inverse indexprotected void removeInverseMapping(Object oIxValue, Object oKey)
oIxValue
- the indexed valueoKey
- the keyprotected void removeInverseMapping(Map mapIndex, Object oIxValue, Object oKey)
mapIndex
- the index from which to remove the mappingoIxValue
- the indexed valueoKey
- the keyprotected Set instantiateSet()
public String toString()
public boolean equals(Object o)
o
- object to be compared for equality with this MapIndexpublic int hashCode()
|
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 |