Interface IIndexAwareExtractor

IIndexAwareExtractor is an extension to the IValueExtractor interface that supports the creation and destruction of an ICacheIndex index. Instances of this interface are intended to be used with the AddIndex(IValueExtractor, bool, IComparer) and RemoveIndex(IValueExtractor) API to support the creation of custom indexes.

Inherited Members

IValueExtractor.Extract(object)

IValueExtractor.Equals(object)

IValueExtractor.GetHashCode()

IValueExtractor.ToString()

Namespace: Tangosol.Util.Extractor

Assembly: Coherence.dll

Syntax

public interface IIndexAwareExtractor : IValueExtractor

Methods

CreateIndex(bool, IComparer, IDictionary)

Create an index and associate it with the corresponding extractor.

Important: it is a responsibility of this method's implementations to place the necessary <IValueExtractor, ICacheEntry> entry into the given map of indexes.

Declaration

ICacheIndex CreateIndex(bool ordered, IComparer comparer, IDictionary dict)

Parameters

Type	Name	Description
bool	ordered	true iff the contents of the indexed information should be ordered; false otherwise.
IComparer	comparer	The IComparator object which imposes an ordering of entries in the index contents; or null if the entries' values natural ordering should be used.
IDictionary	dict	IDictionary to be updated with the created index.

Returns

Type	Description
ICacheIndex	The created index; null if the index has not been created.

DestroyIndex(IDictionary)

Destroy an existing index and remove it from the given dictionary of indexes.

Declaration

ICacheIndex DestroyIndex(IDictionary dict)

Parameters

Type	Name	Description
IDictionary	dict	IDictionary to be updated by removing the index being destroyed.

Returns

Type	Description
ICacheIndex	The destroyed index; null if the index does not exist.