Class ProcessActor

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, InteractiveActor, OutputProducer, StopModeSupporter, Serializable, Comparable

    public class ProcessActor
    extends AbstractInteractiveTransformerDialog
    Applies the specified processor to the incoming actor and forwards the result.
    For processors implementing adams.flow.processor.ModifyingProcessor the modified actor is forwarded (or, if not modified, the original one), all others just forward the incoming actor.
    If the processor should implement adams.flow.processor.ListingProcessor then any generated list gets stored as string array in the outgoing container as well.
    Processors implementing adams.flow.processor.GraphicalOutputProducingProcessor can optionall display the graphical output as well (off by default).

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -name <java.lang.String> (property: name)
        The name of the actor.
        default: ProcessActor
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -skip <boolean> (property: skip)
        If set to true, transformation is skipped and the input token is just forwarded
        as it is.
        default: false
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
        If set to true, the flow execution at this level gets stopped in case this
        actor encounters an error; the error gets propagated; useful for critical
        default: false
    -silent <boolean> (property: silent)
        If enabled, then no errors are output in the console; Note: the enclosing
        actor handler must have this enabled as well.
        default: false
    -short-title <boolean> (property: shortTitle)
        If enabled uses just the name for the title instead of the actor's full
        default: false
    -width <int> (property: width)
        The width of the dialog.
        default: 800
        minimum: 1
    -height <int> (property: height)
        The height of the dialog.
        default: 600
        minimum: 1
    -x <int> (property: x)
        The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
        default: -1
        minimum: -3
    -y <int> (property: y)
        The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
        default: -1
        minimum: -3
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
        If enabled, the flow gets stopped in case the user cancels the dialog.
        default: false
    -custom-stop-message <java.lang.String> (property: customStopMessage)
        The custom stop message to use in case a user cancelation stops the flow
        (default is the full name of the actor)
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
        The stop mode to use.
        default: GLOBAL
    -processor <adams.flow.processor.ActorProcessor> (property: processor)
        The actor processor to apply to the incoming actor.
        default: adams.flow.processor.MultiProcessor
    -show-graphical-output <boolean> (property: showGraphicalOutput)
        If enabled, any Swing components generated by a adams.flow.processor.GraphicalOutputProducingProcessor
        processor will get displayed.
        default: false
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Processor

        protected ActorProcessor m_Processor
        the processor to apply.
      • m_ShowGraphicalOutput

        protected boolean m_ShowGraphicalOutput
        whether to display any graphical output.
      • m_Component

        protected transient Component m_Component
        the graphical component (if any).
    • Constructor Detail

      • ProcessActor

        public ProcessActor()
    • Method Detail

      • setProcessor

        public void setProcessor​(ActorProcessor value)
        Sets the processor to use.
        value - the processor
      • getProcessor

        public ActorProcessor getProcessor()
        Returns the processor to use.
        the processor
      • processorTipText

        public String processorTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the gui
      • setShowGraphicalOutput

        public void setShowGraphicalOutput​(boolean value)
        Sets whether to show any graphical output generated by the processor.
        value - true if to show
      • getShowGraphicalOutput

        public boolean getShowGraphicalOutput()
        Returns whether to show any graphical output generated by the processor.
        true if to show
      • showGraphicalOutputTipText

        public String showGraphicalOutputTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the gui
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        the Class of objects that can be processed
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        the Class of the generated tokens