net.sf.ehcache.search.impl

Interface SearchManager

All Known Implementing Classes:

BruteForceSearchManager

public interface SearchManager

Interface for ehcache search engine implementations

Author:

teck

Method Summary

Modifier and Type	Method and Description
void	clear(String cacheName, int segmentId) Clear a segment of the given cache
Results	executeQuery(StoreQuery query, Map<String,AttributeExtractor> attributeExtractors, DynamicAttributesExtractor dynamicIndexer) Execute a query against the given cache
Set<Attribute>	getSearchAttributes(String cacheName) Returns all known search attributes for cache with given name
void	put(String cacheName, int segmentId, Element element, byte[] serializedKey, Map<String,AttributeExtractor> extractors, DynamicAttributesExtractor dynamicIndexer) Notify an element added to a segment of a given cache
void	remove(String cacheName, Object uniqueKey, int segmentId, boolean isRemoval) Notify an element removed from a segment of a given cache

Method Detail

executeQuery

Results executeQuery(StoreQuery query,
                     Map<String,AttributeExtractor> attributeExtractors,
                     DynamicAttributesExtractor dynamicIndexer)

Execute a query against the given cache

Parameters:

query - query to execute

attributeExtractors - defined attribute extractors for the cache

dynamicIndexer - dynamic attribute extractor (if any)

Returns:

search results

put

void put(String cacheName,
         int segmentId,
         Element element,
         byte[] serializedKey,
         Map<String,AttributeExtractor> extractors,
         DynamicAttributesExtractor dynamicIndexer)

Notify an element added to a segment of a given cache

Parameters:

cacheName - cache name

segmentId - segment of cache

element - element being added to cache

serializedKey - serialized form of the element key

extractors - the attribute extractors for the cache

dynamicIndexer - dynamic attribute extractor (if any)

remove

void remove(String cacheName,
            Object uniqueKey,
            int segmentId,
            boolean isRemoval)

Notify an element removed from a segment of a given cache

Parameters:

cacheName - cache name

uniqueKey - unique key of element

segmentId - segment of cache

isRemoval - true if called as a result of actual storage engine removal (as opposed to move), false otherwise

clear

void clear(String cacheName,
           int segmentId)

Clear a segment of the given cache

Parameters:

cacheName - cache name to clear

segmentId - segment of cache

getSearchAttributes

Set<Attribute> getSearchAttributes(String cacheName)

Returns all known search attributes for cache with given name

Parameters:

cacheName -

Returns: