Package org.apache.uima.flow.impl
Class AnalysisSequenceCapabilityNode
java.lang.Object
org.apache.uima.flow.impl.AnalysisSequenceCapabilityNode
- All Implemented Interfaces:
Cloneable
A
AnalysisSequenceCapabilityNode
is a node element of the
CapabilityLanguageFlowObject
. A AnalysisSequenceCapabilityNode
has a
AnalysisEngine
, a ResultSpecification
which should be processed
from the AnalysisEngine
. Also a AnalysisSequenceCapabilityNode
has
a ResultSpecification
which inculdes the capabilities of the AnalysisEngine
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ResultSpecification
The mCapabilityContainer hold the capabilities of the current AnalyseEngine.private CasObjectProcessor
The reference to the AnalysisEngine to be executed at this point in the sequence.private String
The Key of the AnalysisEngine to be executed at this point in the sequence.private ResultSpecification
The ResultSpecification to provide to the AnalysisEngine at this point in the sequence.private static final long
-
Constructor Summary
ConstructorsConstructorDescriptionAnalysisSequenceCapabilityNode
(String aKey, CasObjectProcessor aCasProcessor, ResultSpecification aResultSpec) Creates a new AnalysisSequenceCapabilityNode from an AnalysisEngine referenceAnalysisSequenceCapabilityNode
(String aCasProcessorKey, Capability[] aCasProcessorCapabilities, ResultSpecification aResultSpec) Creates a new AnalysisSequenceCapabilityNode from a AnalysisEngine Key. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of thisAnalysisSequenceNode
.Returns the capabilityContainer reference.void
setResultSpec
(ResultSpecification aResultSpec) Sets this node's Result Specificatoin.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
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
The Key of the AnalysisEngine to be executed at this point in the sequence. -
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
The mCapabilityContainer hold the capabilities of the current AnalyseEngine. The capabilities are held in a ResultSpecification for quick access to ToFs or languages
-
-
Constructor Details
-
AnalysisSequenceCapabilityNode
public AnalysisSequenceCapabilityNode(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(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 Details
-
getCasProcessorKey
-
getCasProcessor
-
getResultSpec
-
setResultSpec
Sets this node's Result Specificatoin.- Parameters:
aResultSpec
- -
-
clone
Returns a clone of thisAnalysisSequenceNode
. -
getCapabilityContainer
Returns the capabilityContainer reference.- Returns:
- CapabilityContainer - returns the reference to the capability container
-