00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_INDEX_AWARE_EXTRACTOR_HPP 00008 #define COH_INDEX_AWARE_EXTRACTOR_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/Comparator.hpp" 00013 #include "coherence/util/Map.hpp" 00014 #include "coherence/util/MapIndex.hpp" 00015 #include "coherence/util/ValueExtractor.hpp" 00016 00017 COH_OPEN_NAMESPACE3(coherence,util,extractor) 00018 00019 00020 /** 00021 * IndexAwareExtractor is an extension to the ValueExtractor interface 00022 * that supports the creation and destruction of an MapIndex index. 00023 * Instances of this interface are intended to be used with the QueryMap's 00024 * addIndex and removeIndex API to support the creation of custom indexes. 00025 * 00026 * @author tb/lh 2010.08.31 00027 * @since Coherence 3.6 00028 */ 00029 class COH_EXPORT IndexAwareExtractor 00030 : public interface_spec<IndexAwareExtractor, 00031 implements<ValueExtractor> > 00032 { 00033 public: 00034 /** 00035 * Create an index and associate it with the corresponding extractor. 00036 * Important: it is a responsibility of this method's implementations 00037 * to place the necessary <ValueExtractor, MapIndex> entry into the 00038 * given map of indexes. 00039 * 00040 * @param fOrdered true iff the contents of the indexed information 00041 * should be ordered; false otherwise 00042 * @param vComparator the Comparator object which imposes an ordering 00043 * of entries in the index contents; or <tt>NULL</tt> 00044 * if the entries' values natural ordering should be 00045 * used 00046 * @param hMapIndex a Map of ValueExtractor to MapIndex to be updated with 00047 * the created index 00048 * 00049 * @return the created index; NULL if the index has not been created 00050 */ 00051 virtual MapIndex::Handle createIndex(bool fOrdered, 00052 Comparator::View vComparator, Map::Handle hMapIndex) const = 0; 00053 00054 /** 00055 * Destroy an existing index and remove it from the given map of indexes. 00056 * 00057 * @param hMapIndex a Map of ValueExtractor to MapIndex to be updated by 00058 * removing the index being destroyed 00059 * 00060 * @return the destroyed index; NULL if the index does not exist 00061 */ 00062 virtual MapIndex::Handle destroyIndex(Map::Handle hMapIndex) const = 0; 00063 }; 00064 00065 COH_CLOSE_NAMESPACE3 00066 00067 #endif // COH_INDEX_AWARE_EXTRACTOR_HPP