Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

IndexAwareExtractor Class Reference

#include <coherence/util/extractor/IndexAwareExtractor.hpp>

Inherits ValueExtractor.

Inherited by ConditionalExtractor [virtual].

List of all members.


Detailed Description

IndexAwareExtractor is an extension to the ValueExtractor interface that supports the creation and destruction of an MapIndex index.

Instances of this interface are intended to be used with the QueryMap's addIndex and removeIndex API to support the creation of custom indexes.

Author:
tb/lh 2010.08.31
Since:
Coherence 3.6
 

Public Types

typedef spec::Handle Handle
 IndexAwareExtractor Handle definition.
typedef spec::View View
 IndexAwareExtractor View definition.
typedef spec::Holder Holder
 IndexAwareExtractor Holder definition.

Public Member Functions

virtual MapIndex::Handle createIndex (bool fOrdered, Comparator::View vComparator, Map::Handle hMapIndex) const =0
 Create an index and associate it with the corresponding extractor.
virtual MapIndex::Handle destroyIndex (Map::Handle hMapIndex) const =0
 Destroy an existing index and remove it from the given map of indexes.

Member Function Documentation

virtual MapIndex::Handle createIndex ( bool  fOrdered,
    Comparator::View  vComparator,
    Map::Handle  hMapIndex 
  )    const [pure virtual]

Create an index and associate it with the corresponding extractor.

Important: 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
 vComparator the Comparator object which imposes an ordering of entries in the index contents; or NULL if the entries' values natural ordering should be used
 hMapIndex a Map of ValueExtractor to MapIndex to be updated with the created index
Returns:
the created index; NULL if the index has not been created

Implemented in ConditionalExtractor.

virtual MapIndex::Handle destroyIndex ( Map::Handle  hMapIndex  )  const [pure virtual]

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

Parameters:
 hMapIndex a Map of ValueExtractor to MapIndex to be updated by removing the index being destroyed
Returns:
the destroyed index; NULL if the index does not exist

Implemented in ConditionalExtractor.


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.