org.apache.uima.aae
Class InProcessCache

java.lang.Object
  extended by org.apache.uima.aae.InProcessCache
All Implemented Interfaces:
java.io.Serializable, InProcessCacheMBean

public class InProcessCache
extends java.lang.Object
implements InProcessCacheMBean

See Also:
Serialized Form

Nested Class Summary
static class InProcessCache.CacheEntry
           
 
Field Summary
static int NotifyWhenRegistering
           
 
Constructor Summary
InProcessCache()
           
 
Method Summary
 void addEndpoint(Endpoint anEndpoint, java.lang.String aCasReferenceId)
           
 void cancelTimers()
           
 void destroy()
           
 void dumpContents(java.lang.String aControllerName)
           
 boolean entryExists(java.lang.String aCasReferenceId)
           
 InProcessCache.CacheEntry[] getCacheEntriesForEndpoint(java.lang.String anEndpointName)
           
 InProcessCache.CacheEntry getCacheEntryForCAS(java.lang.String aCasReferenceId)
           
 org.apache.uima.cas.CAS getCasByReference(java.lang.String aCasReferenceId)
           
 java.lang.String getCasProducer(java.lang.String aCasReferenceId)
           
 Endpoint getEndpoint(java.lang.String anEndpointName, java.lang.String aCasReferenceId)
           
 MessageContext getMessageAccessorByReference(java.lang.String aCasReferenceId)
           
 java.lang.String getName()
           
 org.apache.uima.cas.impl.OutOfTypeSystemData getOutOfTypeSystemData(java.lang.String aCasReferenceId)
           
 java.lang.String getSerializedCAS(java.lang.String aCasReferenceId)
           
 int getSize()
           
 long getStartTime(java.lang.String aCasReferenceId)
           
 Endpoint getTopAncestorEndpoint(InProcessCache.CacheEntry anEntry)
           
 boolean hasNoSubordinates(java.lang.String aCasReferenceId)
           
 boolean isEmpty()
           
 boolean isInputCASPendingReply(java.lang.String anInputCASReferenceId)
          Checks if a given input CAS is in pending state.
 boolean producedCASesStillInPlay(java.lang.String anInputCASReferenceId, java.lang.String aSubordinateCASReferenceId)
           
 InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS, MessageContext aMessageContext, org.apache.uima.cas.impl.OutOfTypeSystemData otsd)
           
 InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS, MessageContext aMessageContext, org.apache.uima.cas.impl.OutOfTypeSystemData otsd, java.lang.String aCasReferenceId)
           
 InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS, MessageContext aMessageContext, org.apache.uima.cas.impl.XmiSerializationSharedData sharedData)
           
 InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS, MessageContext aMessageContext, org.apache.uima.cas.impl.XmiSerializationSharedData sharedData, java.lang.String aCasReferenceId)
           
 InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS, MessageContext aMessageContext, org.apache.uima.cas.impl.XmiSerializationSharedData sharedData, java.lang.String aCasReferenceId, org.apache.uima.cas.Marker marker, boolean acceptsDeltaCas)
           
 void registerCallbackWhenCacheEmpty(EventSubscriber aController)
           
 void registerCallbackWhenCacheEmpty(EventSubscriber aController, int notification)
           
 void releaseAllCASes()
           
 void releaseCASesProducedFromInputCAS(java.lang.String anInputCASReferenceId)
           
 void remove(java.lang.String aCasReferenceId)
           
 void removeCas(java.lang.String aCasReferenceId)
           
 void removeEndpoint(java.lang.String anEndpointName, java.lang.String aCasReferenceId)
           
 void reset()
           
 void saveSerializedCAS(java.lang.String aCasReferenceId, java.lang.String anXCAS)
           
 void setCasProducer(java.lang.String aCasReferenceId, java.lang.String aCasProducerKey)
           
 void setName(java.lang.String aName)
           
 void setSize(int i)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NotifyWhenRegistering

public static final int NotifyWhenRegistering
See Also:
Constant Field Values
Constructor Detail

InProcessCache

public InProcessCache()
Method Detail

registerCallbackWhenCacheEmpty

public void registerCallbackWhenCacheEmpty(EventSubscriber aController)

registerCallbackWhenCacheEmpty

public void registerCallbackWhenCacheEmpty(EventSubscriber aController,
                                           int notification)

destroy

public void destroy()

isInputCASPendingReply

public boolean isInputCASPendingReply(java.lang.String anInputCASReferenceId)
                               throws java.lang.Exception
Checks if a given input CAS is in pending state. CAS is in pending state if it has been fully processed, *but* its subordinate CASes are still in play. Input CAS is only returned back to the client if all if its subordinate CASes are fully processed.

Parameters:
anInputCASReferenceId -
Returns:
Throws:
java.lang.Exception

producedCASesStillInPlay

public boolean producedCASesStillInPlay(java.lang.String anInputCASReferenceId,
                                        java.lang.String aSubordinateCASReferenceId)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

releaseCASesProducedFromInputCAS

public void releaseCASesProducedFromInputCAS(java.lang.String anInputCASReferenceId)

releaseAllCASes

public void releaseAllCASes()

setName

public void setName(java.lang.String aName)
Specified by:
setName in interface InProcessCacheMBean

getName

public java.lang.String getName()
Specified by:
getName in interface InProcessCacheMBean

cancelTimers

public void cancelTimers()

isEmpty

public boolean isEmpty()

reset

public void reset()
Specified by:
reset in interface InProcessCacheMBean

getSize

public int getSize()
Specified by:
getSize in interface InProcessCacheMBean

setSize

public void setSize(int i)
Specified by:
setSize in interface InProcessCacheMBean

dumpContents

public void dumpContents(java.lang.String aControllerName)

remove

public void remove(java.lang.String aCasReferenceId)

removeCas

public void removeCas(java.lang.String aCasReferenceId)

getCacheEntriesForEndpoint

public InProcessCache.CacheEntry[] getCacheEntriesForEndpoint(java.lang.String anEndpointName)

saveSerializedCAS

public void saveSerializedCAS(java.lang.String aCasReferenceId,
                              java.lang.String anXCAS)

getSerializedCAS

public java.lang.String getSerializedCAS(java.lang.String aCasReferenceId)

setCasProducer

public void setCasProducer(java.lang.String aCasReferenceId,
                           java.lang.String aCasProducerKey)

getCasProducer

public java.lang.String getCasProducer(java.lang.String aCasReferenceId)

getCasByReference

public org.apache.uima.cas.CAS getCasByReference(java.lang.String aCasReferenceId)

getMessageAccessorByReference

public MessageContext getMessageAccessorByReference(java.lang.String aCasReferenceId)

getOutOfTypeSystemData

public org.apache.uima.cas.impl.OutOfTypeSystemData getOutOfTypeSystemData(java.lang.String aCasReferenceId)

addEndpoint

public void addEndpoint(Endpoint anEndpoint,
                        java.lang.String aCasReferenceId)

getEndpoint

public Endpoint getEndpoint(java.lang.String anEndpointName,
                            java.lang.String aCasReferenceId)

removeEndpoint

public void removeEndpoint(java.lang.String anEndpointName,
                           java.lang.String aCasReferenceId)

getStartTime

public long getStartTime(java.lang.String aCasReferenceId)

entryExists

public boolean entryExists(java.lang.String aCasReferenceId)

register

public InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS,
                                          MessageContext aMessageContext,
                                          org.apache.uima.cas.impl.OutOfTypeSystemData otsd)
                                   throws AsynchAEException
Throws:
AsynchAEException

register

public InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS,
                                          MessageContext aMessageContext,
                                          org.apache.uima.cas.impl.XmiSerializationSharedData sharedData)
                                   throws AsynchAEException
Throws:
AsynchAEException

register

public InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS,
                                          MessageContext aMessageContext,
                                          org.apache.uima.cas.impl.OutOfTypeSystemData otsd,
                                          java.lang.String aCasReferenceId)
                                   throws AsynchAEException
Throws:
AsynchAEException

register

public InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS,
                                          MessageContext aMessageContext,
                                          org.apache.uima.cas.impl.XmiSerializationSharedData sharedData,
                                          java.lang.String aCasReferenceId)
                                   throws AsynchAEException
Throws:
AsynchAEException

register

public InProcessCache.CacheEntry register(org.apache.uima.cas.CAS aCAS,
                                          MessageContext aMessageContext,
                                          org.apache.uima.cas.impl.XmiSerializationSharedData sharedData,
                                          java.lang.String aCasReferenceId,
                                          org.apache.uima.cas.Marker marker,
                                          boolean acceptsDeltaCas)
                                   throws AsynchAEException
Throws:
AsynchAEException

hasNoSubordinates

public boolean hasNoSubordinates(java.lang.String aCasReferenceId)

getTopAncestorEndpoint

public Endpoint getTopAncestorEndpoint(InProcessCache.CacheEntry anEntry)
                                throws java.lang.Exception
Throws:
java.lang.Exception

getCacheEntryForCAS

public InProcessCache.CacheEntry getCacheEntryForCAS(java.lang.String aCasReferenceId)
                                              throws AsynchAEException
Throws:
AsynchAEException


Copyright © 2011. All Rights Reserved.