SearchCache (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.SearchCache

All Implemented Interfaces:

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

Direct Known Subclasses:

ConsistentSearchCache, TimeBasedSearchCache
```
public abstract class SearchCache
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Cache for Search API queries. Supports automatically
warming-up the cache with some queries

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`cacheQueries`
`static boolean`	`DEFAULT_CACHE_QUERIES`
`static java.lang.String`	`DEFAULT_IGNORE_FROM_CACHE_KEY`
`static int`	`DEFAULT_MAX_CACHED_QUERIES`
`static int`	`DEFAULT_WARMUP_THREADS`
`static double`	`DEFAULT_WARMUP_WORK_RATIO`
`java.lang.String`	`ignoreFromCacheKey`
`int`	`maxCachedQueries`
`java.lang.String`	`name`
`java.util.List<WarmUpQuery>`	`warmUpQuery`
`int`	`warmupThreads`
`double`	`warmupWorkRatio`

Constructor Summary

Constructors
Constructor and Description

SearchCache()

SearchCache(SearchCache o)
Copy constructor

Constructors
Constructor and Description
`SearchCache()`
`SearchCache(SearchCache o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this SearchCache.
`static SearchCache`	`fromString(java.lang.String s)` String representation of this SearchCache.
`java.lang.String`	`getIgnoreFromCacheKey()` List of url query parameters to ignore from the cache key construction. Separate each field with a come ",".
`int`	`getMaxCachedQueries()` Maximum number of queries to cache. Additional queries are evicted using a LRU algorithm.
`java.lang.String`	`getName()`
`java.util.List<WarmUpQuery>`	`getWarmUpQuery()` Queries that will be automatically cached
`int`	`getWarmupThreads()` Maximum number of threads for warmup
`double`	`getWarmupWorkRatio()` Maximum ratio of time each warm-up thread will work.
`boolean`	`isCacheQueries()` Should this cache handle caching of incoming queries.
`SearchCache`	`makeCopy()`
`static SearchCache`	`readFrom(java.io.InputStream is)` Read this SearchCache from an XML fragment.
`void`	`setCacheQueries(boolean cacheQueries)` Should this cache handle caching of incoming queries.
`void`	`setIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)` List of url query parameters to ignore from the cache key construction. Separate each field with a come ",".
`void`	`setMaxCachedQueries(int maxCachedQueries)` Maximum number of queries to cache. Additional queries are evicted using a LRU algorithm.
`void`	`setName(java.lang.String name)`
`void`	`setWarmupThreads(int warmupThreads)` Maximum number of threads for warmup
`void`	`setWarmupWorkRatio(double warmupWorkRatio)` Maximum ratio of time each warm-up thread will work.
`java.lang.String`	`toString()` String representation of this SearchCache.
`SearchCache`	`withCacheQueries(boolean cacheQueries)`
`SearchCache`	`withCacheQueries(java.lang.Boolean cacheQueries)`
`SearchCache`	`withIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)`
`SearchCache`	`withMaxCachedQueries(int maxCachedQueries)`
`SearchCache`	`withMaxCachedQueries(java.lang.Integer maxCachedQueries)`
`SearchCache`	`withName(java.lang.String name)`
`SearchCache`	`withWarmUpQuery(java.util.Collection<WarmUpQuery> __values)`
`SearchCache`	`withWarmUpQuery(WarmUpQuery... __values)` Queries that will be automatically cached
`SearchCache`	`withWarmupThreads(int warmupThreads)`
`SearchCache`	`withWarmupThreads(java.lang.Integer warmupThreads)`
`SearchCache`	`withWarmupWorkRatio(double warmupWorkRatio)`
`void`	`writeTo(java.io.OutputStream os)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public java.lang.String name
```
  - warmUpQuery
```
public java.util.List<WarmUpQuery> warmUpQuery
```
  - warmupWorkRatio
```
public double warmupWorkRatio
```
  - DEFAULT_WARMUP_WORK_RATIO
```
public static final double DEFAULT_WARMUP_WORK_RATIO
```
    See Also:
    
    Constant Field Values
  - warmupThreads
```
public int warmupThreads
```
  - DEFAULT_WARMUP_THREADS
```
public static final int DEFAULT_WARMUP_THREADS
```
    See Also:
    
    Constant Field Values
  - cacheQueries
```
public boolean cacheQueries
```
  - DEFAULT_CACHE_QUERIES
```
public static final boolean DEFAULT_CACHE_QUERIES
```
    See Also:
    
    Constant Field Values
  - maxCachedQueries
```
public int maxCachedQueries
```
  - DEFAULT_MAX_CACHED_QUERIES
```
public static final int DEFAULT_MAX_CACHED_QUERIES
```
    See Also:
    
    Constant Field Values
  - ignoreFromCacheKey
```
public java.lang.String ignoreFromCacheKey
```
  - DEFAULT_IGNORE_FROM_CACHE_KEY
```
public static final java.lang.String DEFAULT_IGNORE_FROM_CACHE_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchCache
```
public SearchCache()
```
  - SearchCache
```
public SearchCache(SearchCache o)
```
    Copy constructor
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
  - getName
```
public java.lang.String getName()
```
  - withName
```
public SearchCache withName(java.lang.String name)
```
  - getWarmUpQuery
```
public java.util.List<WarmUpQuery> getWarmUpQuery()
```
    Queries that will be automatically cached
  - withWarmUpQuery
```
public SearchCache withWarmUpQuery(WarmUpQuery... __values)
```
    Queries that will be automatically cached
  - withWarmUpQuery
```
public SearchCache withWarmUpQuery(java.util.Collection<WarmUpQuery> __values)
```
  - setWarmupWorkRatio
```
public void setWarmupWorkRatio(double warmupWorkRatio)
```
    Maximum ratio of time each warm-up thread will work.
  - getWarmupWorkRatio
```
public double getWarmupWorkRatio()
```
    Maximum ratio of time each warm-up thread will work.
  - withWarmupWorkRatio
```
public SearchCache withWarmupWorkRatio(double warmupWorkRatio)
```
  - setWarmupThreads
```
public void setWarmupThreads(int warmupThreads)
```
    Maximum number of threads for warmup
  - getWarmupThreads
```
public int getWarmupThreads()
```
    Maximum number of threads for warmup
  - withWarmupThreads
```
public SearchCache withWarmupThreads(int warmupThreads)
```
  - withWarmupThreads
```
public SearchCache withWarmupThreads(java.lang.Integer warmupThreads)
```
  - setCacheQueries
```
public void setCacheQueries(boolean cacheQueries)
```
    Should this cache handle caching of incoming queries. If this is false, only warmup queries will be cached. Incoming queries with the "cache=no" argument will never be cached.
    Incoming queries with the "cache=force:1" argument will override this setting.
    Incoming queries with the "cache=evict" argument will evict the query from all caches if possible.
  - isCacheQueries
```
public boolean isCacheQueries()
```
    Should this cache handle caching of incoming queries. If this is false, only warmup queries will be cached. Incoming queries with the "cache=no" argument will never be cached.
    Incoming queries with the "cache=force:1" argument will override this setting.
    Incoming queries with the "cache=evict" argument will evict the query from all caches if possible.
  - withCacheQueries
```
public SearchCache withCacheQueries(boolean cacheQueries)
```
  - withCacheQueries
```
public SearchCache withCacheQueries(java.lang.Boolean cacheQueries)
```
  - setMaxCachedQueries
```
public void setMaxCachedQueries(int maxCachedQueries)
```
    Maximum number of queries to cache.
    Additional queries are evicted using a LRU algorithm.
  - getMaxCachedQueries
```
public int getMaxCachedQueries()
```
    Maximum number of queries to cache.
    Additional queries are evicted using a LRU algorithm.
  - withMaxCachedQueries
```
public SearchCache withMaxCachedQueries(int maxCachedQueries)
```
  - withMaxCachedQueries
```
public SearchCache withMaxCachedQueries(java.lang.Integer maxCachedQueries)
```
  - setIgnoreFromCacheKey
```
public void setIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)
```
    List of url query parameters to ignore from the cache key construction.
    Separate each field with a come ",".
  - getIgnoreFromCacheKey
```
public java.lang.String getIgnoreFromCacheKey()
```
    List of url query parameters to ignore from the cache key construction.
    Separate each field with a come ",".
  - withIgnoreFromCacheKey
```
public SearchCache withIgnoreFromCacheKey(java.lang.String ignoreFromCacheKey)
```
  - makeCopy
```
public SearchCache makeCopy()
```
  - readFrom
```
public static SearchCache readFrom(java.io.InputStream is)
                            throws javax.xml.bind.JAXBException
```
    Read this SearchCache 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
```
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SearchCache fromString(java.lang.String s)
                              throws javax.xml.bind.JAXBException,
                                     java.io.UnsupportedEncodingException
```
    String representation of this SearchCache.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SearchCache.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SearchCache.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SearchCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

warmUpQuery

warmupWorkRatio

DEFAULT_WARMUP_WORK_RATIO

warmupThreads

DEFAULT_WARMUP_THREADS

cacheQueries

DEFAULT_CACHE_QUERIES

maxCachedQueries

DEFAULT_MAX_CACHED_QUERIES

ignoreFromCacheKey

DEFAULT_IGNORE_FROM_CACHE_KEY

Constructor Detail

SearchCache

SearchCache

Method Detail

setName

getName

withName

getWarmUpQuery

withWarmUpQuery

withWarmUpQuery

setWarmupWorkRatio

getWarmupWorkRatio

withWarmupWorkRatio

setWarmupThreads

getWarmupThreads

withWarmupThreads

withWarmupThreads

setCacheQueries

isCacheQueries

withCacheQueries

withCacheQueries

setMaxCachedQueries

getMaxCachedQueries

withMaxCachedQueries

withMaxCachedQueries

setIgnoreFromCacheKey

getIgnoreFromCacheKey

withIgnoreFromCacheKey

makeCopy

readFrom

writeTo

fromString

toString

check