|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CasProcessor
Base interface for a component that can process a CAS. This includes both components that modify
the CAS (such as an AnalysisEngine as well as those that
do not (such as a CasConsumer). Whether the CasProcessor
modifies the CAS can be determined by calling its isReadOnly() method.
CasProcessors can be "plugged into" the
CollectionProcessingManager.
CAS Processors should not directly implement this interface; instead they should implement one of its subinterfaces:
CasDataProcessor - for CAS processors that want to interact directly with the
CasData. This works best for simple processors that do not need
the indexing or strong typing features provided by the CAS container.CasObjectProcessor - for CAS processors that want to use the full
CAS implementation.CasObjectProcessor.
All CAS processors must publish their metadata via the getProcessingResourceMetaData()
method.
| Method Summary | |
|---|---|
void |
batchProcessComplete(ProcessTrace aTrace)
Completes the processing of a batch. |
void |
collectionProcessComplete(ProcessTrace aTrace)
Completes the processing of an entire collection. |
ProcessingResourceMetaData |
getProcessingResourceMetaData()
Gets the metadata that describes this CasProcesor. |
boolean |
isReadOnly()
Gets whether this is a read-only CAS Processor, which does not modify the CAS. |
boolean |
isStateless()
Gets whether this is a stateless CAS Processor. |
| Method Detail |
|---|
boolean isStateless()
boolean isReadOnly()
ProcessingResourceMetaData getProcessingResourceMetaData()
CasProcesor.
void batchProcessComplete(ProcessTrace aTrace)
throws ResourceProcessException,
IOException
aTrace - an object that records information, such as timing, about this method's execution.
ResourceProcessException - if an exception occurs during processing
IOException - if an I/O failure occurs
void collectionProcessComplete(ProcessTrace aTrace)
throws ResourceProcessException,
IOException
aTrace - an object that records information, such as timing, about this method's execution.
ResourceProcessException - if an exception occurs during processing
IOException - if an I/O failure occurs
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||