SimpleCacheIndex Class |
14c (14.1.1.0)
F23534-02
SimpleCacheIndex is an ICacheIndex implementation used to
correlate property values extracted from resource cache entries with
corresponding keys using what is commonly known as an Inverted Index
algorithm..
Inheritance HierarchyNamespace: Tangosol.Net.Cache
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
public class SimpleCacheIndex : ICacheIndex
The SimpleCacheIndex type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SimpleCacheIndex(IValueExtractor, Boolean, IComparer) |
Construct an index.
|
| SimpleCacheIndex(IValueExtractor, Boolean, IComparer, Boolean) |
Construct an index.
|
Properties| Name | Description | |
|---|---|---|
 | Comparer |
IComparer used to sort the index. Used iff Ordered is true.
Could be null, which implicates a natural order.
|
| IndexContents |
The IDictionary that contains the index contents.
|
 | IndexForward |
IDictionary that contains the index values (forward index). The
keys of the IDictionary are the keys to the indexed cache and the
values are the extracted values. This map is used by
IIndexAwareFilter implementations
to avoid conversion and value extraction steps.
|
| IsOrdered |
Specifies whether or not this ICacheIndex orders the contents of
the indexed information.
|
| IsPartial |
Determine if indexed information for any entry in the indexed
ICache has been excluded from this index. This information is used
by IIndexAwareFilter
implementations to determine the most optimal way to apply the
index.
|
| ValueExtractor |
IValueExtractor object that this ICacheIndex uses to extract an
indexable Object from a [converted] value stored in the Storage.
This property is never null.
|
Methods| Name | Description | |
|---|---|---|
 | AddInverseCollectionMapping |
Add new mappings from the elements of the given value to the given
key in the supplied index.
|
| AddInverseMapping(Object, Object) |
Add a new mapping from the given indexed value to the given key in
the inverse index.
|
| AddInverseMapping(IDictionary, Object, Object) |
Add a new mapping from the given indexed value to the given key in
the supplied index.
|
| CollectRemoved |
Given that the old value is known to be a Collection or an array,
collect all the enclosed elements that are not part of the new value.
|
| Delete |
Update this index in response to a remove operation on a cache.
|
| DeleteInternal |
Update this index in response to a remove operation on a cache.
|
 | EnsureCollection |
Return a Collection representation of the specified value, which could be
a Collection, Object[], scalar, or NO_VALUE.
|
| Equals(Object) |
Determines whether the specified object is equal to this object.
(Overrides ObjectEquals(Object).) |
| Equals(SimpleCacheIndex) |
Compares this index with another index for equality.
|
| ExtractNewValue |
Extract the "new" value from the specified entry.
|
| ExtractOldValue |
Extract the "old" value from the specified entry.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get |
Using the index information if possible, get the value associated
with the specified key. This is expected to be more efficient than
using the IValueExtractor against an object containing the value,
because the index should already have the necessary information at
hand.
|
| GetForwardValue |
Get the forward index value associated with the specified key.
|
| GetHashCode |
Returns a hash code for this object.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize |
Initialize the index's data structures.
|
| Insert |
Update this index in response to a insert operation on a cache.
|
| InsertInternal |
Update this index in response to a insert operation on a cache.
|
| InstantiateForwardIndex |
Instantiate the forward index.
|
| InstatiateInverseIndex |
Instantiate the inverse index.
|
| IsKeyExcluded |
Check if the entry with the given key is excluded from the index.
|
| LogMissingIdx |
Log messages for missing inverse index.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RemoveForwardEntry |
Remove the forward index entry for the specified key.
|
| RemoveInverseMapping(Object, Object) |
Remove the mapping from the given indexed value to the given key
from the inverse index.
|
| RemoveInverseMapping(IDictionary, Object, Object) |
Remove the mapping from the given indexed value to the given key
from the supplied index.
|
| RemoveInverseMapping(Object, Object, ICollection) |
Remove the mapping from the given indexed value to the given key
from the inverse index.
|
| ToString |
Returns string representation of this instance.
(Overrides ObjectToString.) |
| Update |
Update this index in response to a update operation on a cache.
|
| UpdateExcludedKeys |
Check the entry against the set of entries not included in the
index and update the set if necessary.
|
| UpdateInternal |
Update this index in response to a update operation on a cache.
|
Fields| Name | Description | |
|---|---|---|
 | m_cLogMissingIdx |
The number of "missing inverse index" messages that have been logged.
|
| m_fImmutableValues |
Specifies whether or not the index is based on the immutable values (e.g. keys).
|
| m_keysExcluded |
A set of keys for the entries, which could not be included in the index.
|
| m_ldtLogMissingIdx |
The time at which the most recent logging of "missing inverse index"
messages started.
|
| m_splitCollection |
If a value extracted by the IValueExtractor is an ICollection, this
property specifies whether or not it should be treated as a
collection of contained attributes or indexed as a single composite
attribute.
|
| NO_VALUE |
Marker object used to represent extractor failure.
|
See Also