Class JCasMultiplier_ImplBase

  • All Implemented Interfaces:
    AnalysisComponent

    public abstract class JCasMultiplier_ImplBase
    extends AnalysisComponent_ImplBase
    Base class to be extended by CAS Multipliers that use the CAS interface. A CAS Multiplier can produce multiplie output CASes while processing an input CAS. See AnalysisComponent for a description of how the framework calls the methods on this interface.
    • Constructor Detail

      • JCasMultiplier_ImplBase

        public JCasMultiplier_ImplBase()
    • Method Detail

      • getRequiredCasInterface

        public final java.lang.Class<JCas> getRequiredCasInterface()
        Description copied from interface: AnalysisComponent
        Returns the specific CAS interface that this AnalysisComponent requires the framework to pass to its AnalysisComponent.process(AbstractCas) method.
        Returns:
        the required CAS interface. This must specify a subtype of AbstractCas.
      • getCasInstancesRequired

        public int getCasInstancesRequired()
        Returns the maximum number of CAS instances that this CAS Multiplier expects to use at the same time. Returns a default value of 1, which will be sufficient for most CAS Multipliers. Only if there is a clear need should this be overridden to return something greater than 1.
        Returns:
        the number of CAS instances required by this AnalysisComponent.
      • getEmptyJCas

        protected final JCas getEmptyJCas()
        Gets an empty JCas that this CAS Multiplier can then populate.
        Returns:
        an empty JCas