Package org.apache.uima.flow.impl
Class AnalysisSequenceCapabilityNode
- java.lang.Object
-
- org.apache.uima.flow.impl.AnalysisSequenceCapabilityNode
-
- All Implemented Interfaces:
java.lang.Cloneable
public class AnalysisSequenceCapabilityNode extends java.lang.Object implements java.lang.Cloneable
AAnalysisSequenceCapabilityNode
is a node element of theCapabilityLanguageFlowObject
. AAnalysisSequenceCapabilityNode
has aAnalysisEngine
, aResultSpecification
which should be processed from theAnalysisEngine
. Also aAnalysisSequenceCapabilityNode
has aResultSpecification
which inculdes the capabilities of theAnalysisEngine
.
-
-
Field Summary
Fields Modifier and Type Field Description private ResultSpecification
mCapabilityContainer
The mCapabilityContainer hold the capabilities of the current AnalyseEngine.private CasObjectProcessor
mCasProcessor
The reference to the AnalysisEngine to be executed at this point in the sequence.private java.lang.String
mCasProcessorKey
The Key of the AnalysisEngine to be executed at this point in the sequence.private ResultSpecification
mResultSpec
The ResultSpecification to provide to the AnalysisEngine at this point in the sequence.private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description AnalysisSequenceCapabilityNode(java.lang.String aKey, CasObjectProcessor aCasProcessor, ResultSpecification aResultSpec)
Creates a new AnalysisSequenceCapabilityNode from an AnalysisEngine referenceAnalysisSequenceCapabilityNode(java.lang.String aCasProcessorKey, Capability[] aCasProcessorCapabilities, ResultSpecification aResultSpec)
Creates a new AnalysisSequenceCapabilityNode from a AnalysisEngine Key.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns a clone of thisAnalysisSequenceNode
.ResultSpecification
getCapabilityContainer()
Returns the capabilityContainer reference.CasObjectProcessor
getCasProcessor()
java.lang.String
getCasProcessorKey()
ResultSpecification
getResultSpec()
void
setResultSpec(ResultSpecification aResultSpec)
Sets this node's Result Specificatoin.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
mCasProcessor
private transient CasObjectProcessor mCasProcessor
The reference to the AnalysisEngine to be executed at this point in the sequence. If this is null, the Key should be used to find the AnalysisEngine. This field is transient and so does not persist when this AnalysisEngineSequence is serialized.
-
mCasProcessorKey
private java.lang.String mCasProcessorKey
The Key of the AnalysisEngine to be executed at this point in the sequence.
-
mResultSpec
private ResultSpecification mResultSpec
The ResultSpecification to provide to the AnalysisEngine at this point in the sequence. May be null, indicating that the AnalysisEngine should produce all possible results.
-
mCapabilityContainer
private ResultSpecification mCapabilityContainer
The mCapabilityContainer hold the capabilities of the current AnalyseEngine. The capabilities are held in a ResultSpecification for quick access to ToFs or languages
-
-
Constructor Detail
-
AnalysisSequenceCapabilityNode
public AnalysisSequenceCapabilityNode(java.lang.String aKey, CasObjectProcessor aCasProcessor, ResultSpecification aResultSpec)
Creates a new AnalysisSequenceCapabilityNode from an AnalysisEngine reference- Parameters:
aKey
- key for AnalysisEngine to be executed at this point in sequenceaCasProcessor
- reference to the AnalysisEngine instanceaResultSpec
- result specification to be passed to this AnalysisEngine
-
AnalysisSequenceCapabilityNode
public AnalysisSequenceCapabilityNode(java.lang.String aCasProcessorKey, Capability[] aCasProcessorCapabilities, ResultSpecification aResultSpec)
Creates a new AnalysisSequenceCapabilityNode from a AnalysisEngine Key. This is to be used when a direct reference to a AnalysisEngine is not available.- Parameters:
aCasProcessorKey
- Key of a AnalysisEngineaCasProcessorCapabilities
- Capabilities for this AnalysisEngineaResultSpec
- result specification to be passed to this AnalysisEngine
-
-
Method Detail
-
getCasProcessorKey
public java.lang.String getCasProcessorKey()
-
getCasProcessor
public CasObjectProcessor getCasProcessor()
-
getResultSpec
public ResultSpecification getResultSpec()
-
setResultSpec
public void setResultSpec(ResultSpecification aResultSpec)
Sets this node's Result Specificatoin.- Parameters:
aResultSpec
- -
-
clone
public java.lang.Object clone()
Returns a clone of thisAnalysisSequenceNode
.- Overrides:
clone
in classjava.lang.Object
- Returns:
- a new
AnalysisSequenceNode
object that is an exact clone of this one.
-
getCapabilityContainer
public ResultSpecification getCapabilityContainer()
Returns the capabilityContainer reference.- Returns:
- CapabilityContainer - returns the reference to the capability container
-
-