Package adams.flow.transformer

Class ImageObjectFilter

  • 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 ImageObjectFilter
extends AbstractTransformer
implements InPlaceProcessing
    Uses the specified object finder to locate objects and then applies the object filter to the located objects. Modifies the report/report handler unless the 'no-copy' is flag is unset.

    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.report.MutableReportHandler
    - generates:
       adams.data.report.Report
       adams.data.report.MutableReportHandler


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ImageObjectFilter
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -finder <adams.data.objectfinder.ObjectFinder> (property: finder)
    The object finder to use.
    default: adams.data.objectfinder.AllFinder
 
    -filter <adams.data.objectfilter.ObjectFilter> (property: filter)
    The object filter to apply to the located objects.
    default: adams.data.objectfilter.PassThrough
 
    -keep-all-objects <boolean> (property: keepAllObjects)
    If enabled, all objects are kept, ie the ones that weren't located by the
    object finder and the filtered ones.
    default: false
 
    -clean-indices <boolean> (property: cleanIndices)
    If enabled, all potential index entries get removed from the meta-data.
    default: false
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the report/report handler is created before processing
    the report.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Finder

        protected ObjectFinder m_Finder
        the object finder to use.

      • m_Filter

        protected ObjectFilter m_Filter
        the object filter to apply to the located objects.

      • m_KeepAllObjects

        protected boolean m_KeepAllObjects
        whether to keep all objects.

      • m_CleanIndices

        protected boolean m_CleanIndices
        whether to clean the object indices.

      • m_NoCopy

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

    • Constructor Detail

      • ImageObjectFilter

        public ImageObjectFilter()

    • Method Detail

      • setFinder

        public void setFinder​(ObjectFinder value)
        Sets the finder to use for locating the objects.
        Parameters:
        value - the finder

      • getFinder

        public ObjectFinder getFinder()
        Returns the finder to use for locating the objects.
        Returns:
        the finder

      • finderTipText

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

      • setFilter

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

      • getFilter

        public ObjectFilter getFilter()
        Returns the filter to apply to the located objects.
        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.

      • setKeepAllObjects

        public void setKeepAllObjects​(boolean value)
        Sets whether to keep all objects, i.e., the ones that weren't located by the object finder and the filtered ones.
        Parameters:
        value - true if to keep all objects

      • getKeepAllObjects

        public boolean getKeepAllObjects()
        Returns whether to keep all objects, i.e., the ones that weren't located by the object finder and the filtered ones.
        Returns:
        true if to keep all objects

      • keepAllObjectsTipText

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

      • setCleanIndices

        public void setCleanIndices​(boolean value)
        Sets whether to remove index entries from the meta-data.
        Parameters:
        value - true if to clean

      • getCleanIndices

        public boolean getCleanIndices()
        Returns whether to remove index entries from the meta-data.
        Returns:
        true if to clean

      • cleanIndicesTipText

        public String cleanIndicesTipText()
        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 report/report handler before updating the report.
        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 report/report handler before updating the report.
        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