com.exalead.mercury.mami.search.v20

Class TimeBasedSearchCache

java.lang.Object

com.exalead.mercury.mami.search.v20.SearchCache

com.exalead.mercury.mami.search.v20.TimeBasedSearchCache

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class TimeBasedSearchCache
extends SearchCache
implements com.exalead.util.Checkable, java.io.Serializable

The elements of this cache are evicted based on time policy.
They are not evicted each time a new generation of the index is available. Therefore, this cache can contain stale data. Warmup queries are refreshed before their cache expiry

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXPIRY_TIME_S
int	expiryTimeS

Fields inherited from class com.exalead.mercury.mami.search.v20.SearchCache

cacheQueries, DEFAULT_CACHE_QUERIES, DEFAULT_IGNORE_FROM_CACHE_KEY, DEFAULT_MAX_CACHED_QUERIES, DEFAULT_WARMUP_THREADS, DEFAULT_WARMUP_WORK_RATIO, ignoreFromCacheKey, maxCachedQueries, name, warmUpQuery, warmupThreads, warmupWorkRatio

Constructor Summary

Constructors

Constructor and Description
TimeBasedSearchCache()
TimeBasedSearchCache(TimeBasedSearchCache o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this TimeBasedSearchCache.
static TimeBasedSearchCache	fromString(java.lang.String s) String representation of this TimeBasedSearchCache.
int	getExpiryTimeS() Expiry time for queries in the cache
TimeBasedSearchCache	makeCopy() Creates and returns a deep copy of this TimeBasedSearchCache.
static TimeBasedSearchCache	readFrom(java.io.InputStream is) Read this TimeBasedSearchCache from an XML fragment.
void	setExpiryTimeS(int expiryTimeS) Expiry time for queries in the cache
java.lang.String	toString() String representation of this TimeBasedSearchCache.
TimeBasedSearchCache	withCacheQueries(boolean cacheQueries)
TimeBasedSearchCache	withCacheQueries(java.lang.Boolean cacheQueries)
TimeBasedSearchCache	withExpiryTimeS(int expiryTimeS)
TimeBasedSearchCache	withExpiryTimeS(java.lang.Integer expiryTimeS)
TimeBasedSearchCache	withIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)
TimeBasedSearchCache	withMaxCachedQueries(int maxCachedQueries)
TimeBasedSearchCache	withMaxCachedQueries(java.lang.Integer maxCachedQueries)
TimeBasedSearchCache	withName(java.lang.String name)
TimeBasedSearchCache	withWarmUpQuery(java.util.Collection<WarmUpQuery> __values)
TimeBasedSearchCache	withWarmUpQuery(WarmUpQuery... __values) Queries that will be automatically cached
TimeBasedSearchCache	withWarmupThreads(int warmupThreads)
TimeBasedSearchCache	withWarmupThreads(java.lang.Integer warmupThreads)
TimeBasedSearchCache	withWarmupWorkRatio(double warmupWorkRatio)
void	writeTo(java.io.OutputStream os) Write this TimeBasedSearchCache as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.SearchCache

getIgnoreFromCacheKey, getMaxCachedQueries, getName, getWarmUpQuery, getWarmupThreads, getWarmupWorkRatio, isCacheQueries, setCacheQueries, setIgnoreFromCacheKey, setMaxCachedQueries, setName, setWarmupThreads, setWarmupWorkRatio

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

expiryTimeS

public int expiryTimeS

DEFAULT_EXPIRY_TIME_S

public static final int DEFAULT_EXPIRY_TIME_S

See Also:

Constant Field Values

Constructor Detail

TimeBasedSearchCache

public TimeBasedSearchCache()

TimeBasedSearchCache

public TimeBasedSearchCache(TimeBasedSearchCache o)

Copy constructor

Method Detail

withName

public TimeBasedSearchCache withName(java.lang.String name)

Overrides:

withName in class SearchCache

withWarmUpQuery

public TimeBasedSearchCache withWarmUpQuery(WarmUpQuery... __values)

Queries that will be automatically cached

Overrides:

withWarmUpQuery in class SearchCache

withWarmUpQuery

public TimeBasedSearchCache withWarmUpQuery(java.util.Collection<WarmUpQuery> __values)

Overrides:

withWarmUpQuery in class SearchCache

withWarmupWorkRatio

public TimeBasedSearchCache withWarmupWorkRatio(double warmupWorkRatio)

Overrides:

withWarmupWorkRatio in class SearchCache

withWarmupThreads

public TimeBasedSearchCache withWarmupThreads(int warmupThreads)

Overrides:

withWarmupThreads in class SearchCache

withWarmupThreads

public TimeBasedSearchCache withWarmupThreads(java.lang.Integer warmupThreads)

Overrides:

withWarmupThreads in class SearchCache

withCacheQueries

public TimeBasedSearchCache withCacheQueries(boolean cacheQueries)

Overrides:

withCacheQueries in class SearchCache

withCacheQueries

public TimeBasedSearchCache withCacheQueries(java.lang.Boolean cacheQueries)

Overrides:

withCacheQueries in class SearchCache

withMaxCachedQueries

public TimeBasedSearchCache withMaxCachedQueries(int maxCachedQueries)

Overrides:

withMaxCachedQueries in class SearchCache

withMaxCachedQueries

public TimeBasedSearchCache withMaxCachedQueries(java.lang.Integer maxCachedQueries)

Overrides:

withMaxCachedQueries in class SearchCache

withIgnoreFromCacheKey

public TimeBasedSearchCache withIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)

Overrides:

withIgnoreFromCacheKey in class SearchCache

setExpiryTimeS

public void setExpiryTimeS(int expiryTimeS)

Expiry time for queries in the cache

getExpiryTimeS

public int getExpiryTimeS()

Expiry time for queries in the cache

withExpiryTimeS

public TimeBasedSearchCache withExpiryTimeS(int expiryTimeS)

withExpiryTimeS

public TimeBasedSearchCache withExpiryTimeS(java.lang.Integer expiryTimeS)

makeCopy

public TimeBasedSearchCache makeCopy()

Creates and returns a deep copy of this TimeBasedSearchCache.

Overrides:

makeCopy in class SearchCache

readFrom

public static TimeBasedSearchCache readFrom(java.io.InputStream is)
                                     throws javax.xml.bind.JAXBException

Read this TimeBasedSearchCache from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this TimeBasedSearchCache as an XML fragment

Overrides:

writeTo in class SearchCache

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static TimeBasedSearchCache fromString(java.lang.String s)
                                       throws javax.xml.bind.JAXBException,
                                              java.io.UnsupportedEncodingException

String representation of this TimeBasedSearchCache.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TimeBasedSearchCache.

Overrides:

toString in class SearchCache

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this TimeBasedSearchCache.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SearchCache

Throws:

com.exalead.util.TypedException