Package adams.flow.transformer

Class SetImageObjectMetaData

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SetImageObjectMetaData
extends AbstractTransformer
    Sets meta-data in the incoming adams.flow.transformer.locateobjects.LocatedObject object.

    Input/output:
    - accepts:
       adams.flow.transformer.locateobjects.LocatedObject
    - generates:
       adams.flow.transformer.locateobjects.LocatedObject


    -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: SetImageObjectMetaData
 
    -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
 
    -key <java.lang.String> (property: key)
    The meta-data key to store the value under.
    default:
 
    -value <java.lang.String> (property: value)
    The meta-data value to store.
    default:
 
    -type <STRING|NUMERIC|BOOLEAN|UNKNOWN> (property: type)
    How to parse the value string.
    default: STRING
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Key

        protected String m_Key
        the key to use.

      • m_Value

        protected String m_Value
        the value to set.

      • m_Type

        protected DataType m_Type
        the type of the value.

    • Constructor Detail

      • SetImageObjectMetaData

        public SetImageObjectMetaData()

    • Method Detail

      • setKey

        public void setKey​(String value)
        Sets the key.
        Parameters:
        value - the key

      • getKey

        public String getKey()
        Returns the key.
        Returns:
        the key

      • keyTipText

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

      • setValue

        public void setValue​(String value)
        Sets the value.
        Parameters:
        value - the value

      • getValue

        public String getValue()
        Returns the value.
        Returns:
        the value

      • valueTipText

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

      • setType

        public void setType​(DataType value)
        Sets how to parse the value string.
        Parameters:
        value - the type

      • getType

        public DataType getType()
        Returns how to parse the value string.
        Returns:
        the type

      • typeTipText

        public String typeTipText()
        Returns the tip text for this property.
        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.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        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