Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.1.0

E18814-01


com.tangosol.util.extractor
Interface IndexAwareExtractor

All Superinterfaces:
ValueExtractor
All Known Implementing Classes:
ConditionalExtractor

public interface IndexAwareExtractor
extends ValueExtractor

IndexAwareExtractor is an extension to the ValueExtractor interface that supports the creation and destruction of an index. Instances of this interface are intended to be used with the QueryMap.addIndex(com.tangosol.util.ValueExtractor, boolean, java.util.Comparator) and QueryMap.removeIndex(com.tangosol.util.ValueExtractor) API to support the creation of custom indexes.

Since:
Coherence 3.6
Author:
tb 2010.02.08

Method Summary
 MapIndex createIndex(boolean fOrdered, java.util.Comparator comparator, java.util.Map mapIndex)
          Create an index and associate it with the corresponding extractor.
 MapIndex destroyIndex(java.util.Map mapIndex)
          Destroy an existing index and remove it from the given map of indexes.

 

Methods inherited from interface com.tangosol.util.ValueExtractor
equals, extract, hashCode, toString

 

Method Detail

createIndex

MapIndex createIndex(boolean fOrdered,
                     java.util.Comparator comparator,
                     java.util.Map mapIndex)
Create an index and associate it with the corresponding extractor. Important note: it is a responsibility of this method's implementations to place the necessary <ValueExtractor, MapIndex> entry into the given map of indexes.
Parameters:
fOrdered - true iff the contents of the indexed information should be ordered; false otherwise
comparator - the Comparator object which imposes an ordering of entries in the index contents; or null if the entries' values natural ordering should be used
mapIndex - Map<ValueExtractor, MapIndex> to be updated with the created index
Returns:
the created index; null if the index has not been created

destroyIndex

MapIndex destroyIndex(java.util.Map mapIndex)
Destroy an existing index and remove it from the given map of indexes.
Parameters:
mapIndex - map<ValueExtractor, MapIndex> to be updated by removing the index being destroyed
Returns:
the destroyed index; null if the index does not exist

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.1.0

E18814-01


Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.