Package adams.flow.transformer

Class FilterMap

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, InPlaceProcessing, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class FilterMap
extends AbstractTransformer
implements InPlaceProcessing
    Applies the specified filter to the map object passing through.

    Input/output:
    - accepts:
       java.util.Map
    - generates:
       java.util.Map


    -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: FilterMap
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -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
    actors.
    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
 
    -filter <adams.flow.transformer.mapfilter.AbstractMapFilter> (property: filter)
    The filter to apply to the map.
    default: adams.flow.transformer.mapfilter.PassThrough
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the map is created before filtering.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_NoCopy

        protected boolean m_NoCopy
        whether to skip creating a copy of the container.

    • Constructor Detail

      • FilterMap

        public FilterMap()

    • Method Detail

      • setFilter

        public void setFilter​(AbstractMapFilter value)
        Sets the filter to apply.
        Parameters:
        value - the filter

      • getFilter

        public AbstractMapFilter getFilter()
        Returns the filter to apply.
        Returns:
        the filter

      • filterTipText

        public String filterTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNoCopy

        public void setNoCopy​(boolean value)
        Sets whether to skip creating a copy of the map before filtering.
        Specified by:
        setNoCopy in interface InPlaceProcessing
        Parameters:
        value - true if to skip creating copy

      • getNoCopy

        public boolean getNoCopy()
        Returns whether to skip creating a copy of the map before filtering.
        Specified by:
        getNoCopy in interface InPlaceProcessing
        Returns:
        true if copying is skipped

      • noCopyTipText

        public String noCopyTipText()
        Returns the tip text for this property.
        Specified by:
        noCopyTipText in interface InPlaceProcessing
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message