Class AnalysisSequenceCapabilityNode

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class AnalysisSequenceCapabilityNode
    extends java.lang.Object
    implements java.lang.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 Detail

      • 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 sequence
        aCasProcessor - reference to the AnalysisEngine instance
        aResultSpec - 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 AnalysisEngine
        aCasProcessorCapabilities - Capabilities for this AnalysisEngine
        aResultSpec - result specification to be passed to this AnalysisEngine
    • Method Detail

      • getCasProcessorKey

        public java.lang.String getCasProcessorKey()
      • setResultSpec

        public void setResultSpec​(ResultSpecification aResultSpec)
        Sets this node's Result Specificatoin.
        Parameters:
        aResultSpec - -
      • clone

        public java.lang.Object clone()
        Returns a clone of this AnalysisSequenceNode.
        Overrides:
        clone in class java.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