gov.va.vinci.leo.ae

Class LeoCachingAnnotator

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

gov.va.vinci.leo.ae.LeoBaseAnnotator

gov.va.vinci.leo.ae.LeoCachingAnnotator

All Implemented Interfaces:

LeoAnnotator, org.apache.uima.analysis_component.AnalysisComponent

public abstract class LeoCachingAnnotator
extends LeoBaseAnnotator

Base annotator with methods that implement caching via EHCache.

Usage:

In the simplest case, extend this annotator, then in the new annotator caching can be used via:

if (getResultFromCache(myKey)!= null) { return getResultFromCache(myKey); } else { // do a bunch of work; addResultToCache(myKey, myResult); return myResult;}

The cache name will be set as the full classname of the annotator. In this way, each annotator can have its cache configured differently via an ehcache.xml file in the classpath with:

Field Summary

Fields

Modifier and Type	Field and Description
protected net.sf.ehcache.CacheManager	cacheManager Cache manager for getting a cache.

Fields inherited from class gov.va.vinci.leo.ae.LeoBaseAnnotator

excludeTypesFilter, includeTypesFilter, inputTypes, logger, name, numberOfCASesProcessed, numberOfFilteredCASesProcessed, numInstances, outputType, typeSystemDescription

Constructor Summary

Constructors

Constructor and Description
LeoCachingAnnotator() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addResultToCache(Serializable key, Serializable value) Add a key/value to the cache.
protected void	createCache() Create the cache to be used for storing results.
net.sf.ehcache.Cache	getCache() Get the cache.
String	getCacheName() Returns the ehcache name for this annotator.
protected Object	getResultFromCache(Serializable key) Look in the cache for input and return the result.

Methods inherited from class gov.va.vinci.leo.ae.LeoBaseAnnotator

addLeoTypeSystemDescription, addOutputAnnotation, addOutputAnnotation, annotate, collectionProcessComplete, containsAnnotationInList, getAnnotationListForType, getDescriptor, getExcludeTypesFilter, getIncludeTypesFilter, getInputTypes, getLeoAEDescriptor, getLeoTypeSystemDescription, getName, getNumberOfCASesProcessed, getNumberOfFilteredCASesProcessed, getNumInstances, getOutputType, getResourceAsInputStream, getResourceFileAsString, hasFilteredAnnotation, hasInputTypesAnnotation, initialize, process, resetNumberOfCASesProcessed, resetNumberOfFilteredCASesProcessed, setExcludeTypesFilter, setIncludeTypesFilter, setInputTypes, setLeoTypeSystemDescription, setName, setNumInstances, setOutputType

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

cacheManager

protected net.sf.ehcache.CacheManager cacheManager

Cache manager for getting a cache.

Constructor Detail

LeoCachingAnnotator

public LeoCachingAnnotator()

Default constructor.

Method Detail

getCacheName

public final String getCacheName()

Returns the ehcache name for this annotator. This, by default, is the full classname to prevent collisions.

Returns:

the name of the ehcache.

getCache

public final net.sf.ehcache.Cache getCache()

Get the cache.

Returns:

the ehcache for this annotator.

createCache

protected void createCache()

Create the cache to be used for storing results.

addResultToCache

protected final void addResultToCache(Serializable key,
                                      Serializable value)

Add a key/value to the cache.

Parameters:

key - the key of the result to be cached.

value - the value of the result to be cached.

getResultFromCache

protected final Object getResultFromCache(Serializable key)

Look in the cache for input and return the result.

Parameters:

key - the get to get result for.

Returns:

the result, if the input has a cached result, or null if no result could be found.