Package adams.flow.transformer

Class WekaGetInstanceValue

  • 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 WekaGetInstanceValue
extends AbstractTransformer
    Retrieves a value from a WEKA Instance object.
    Notes:
    - date and relational values are forwarded as strings
    - missing values are output as '?' (without the single quotes)
    - the 'attribute name' option overrides the 'index' option

    Input/output:
    - accepts:
       weka.core.Instance
    - generates:
       java.lang.Double
       java.lang.String


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaGetInstanceValue
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -index <java.lang.String> (property: index)
    The 1-based index of the attribute value to retrieve from the WEKA Instance.
    default: first
 
    -attribute-name <java.lang.String> (property: attributeName)
    The name of the attribute to get the value for.
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Index

        protected Index m_Index
        the index of the attribute to get the value from the Instance.

      • m_AttributeName

        protected String m_AttributeName
        the name of the attribute to get the value from the Instance.

    • Constructor Detail

      • WekaGetInstanceValue

        public WekaGetInstanceValue()

    • Method Detail

      • setIndex

        public void setIndex​(Index value)
        Sets the 1-based index of the attribute value to retrieve from the Instance.
        Parameters:
        value - the 1-based index

      • getIndex

        public Index getIndex()
        Returns the 1-based index of the attribuate value to retrieve from the Instance.
        Returns:
        the 1-based index

      • indexTipText

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

      • setAttributeName

        public void setAttributeName​(String value)
        Sets the name of the attribute to get the value for.
        Parameters:
        value - the name

      • getAttributeName

        public String getAttributeName()
        Returns the name of the attribute to get the value for.
        Returns:
        the name

      • attributeNameTipText

        public String attributeNameTipText()
        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:
        weka.core.Instance.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.Double.class, java.lang.String.class

      • doExecute

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