Package adams.data.heatmapfeatures

Class Scripted

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.scripting.FileBasedScripting, adams.core.scripting.FileBasedScriptingWithOptions, adams.core.ShallowCopySupporter<AbstractHeatmapFeatureGenerator>, adams.core.SizeOfHandler, Serializable, Comparable
    public class Scripted
extends AbstractScriptedFeatureGenerator
    A feature generator that uses any scripting handler for processing the data with a script located in the specified file. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter)
    The feature converter to use to produce the output data.
    default: adams.data.featureconverter.SpreadSheet -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet
 
    -field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default: 
 
    -notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default: 
 
    -script <adams.core.io.PlaceholderFile> (property: scriptFile)
    The script file to load and execute.
    default: ${CWD}
 
    -options <adams.core.base.BaseText> (property: scriptOptions)
    The options for the script; must consist of 'key=value' pairs separated 
    by blanks; the value of 'key' can be accessed via the 'getAdditionalOptions
    ().getXYZ("key")' method in the script actor.
    default: 
 
    -handler <adams.core.scripting.AbstractScriptingHandler> (property: handler)
    The handler to use for scripting.
    default: adams.core.scripting.Dummy
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Handler

        protected adams.core.scripting.AbstractScriptingHandler m_Handler
        the scripting handler to use.

    • Constructor Detail

      • Scripted

        public Scripted()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractScriptedFeatureGenerator

      • scriptOptionsTipText

        public String scriptOptionsTipText()
        Returns the tip text for this property.
        Specified by:
        scriptOptionsTipText in interface adams.core.scripting.FileBasedScriptingWithOptions
        Overrides:
        scriptOptionsTipText in class AbstractScriptedFeatureGenerator
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setHandler

        public void setHandler​(adams.core.scripting.AbstractScriptingHandler value)
        Sets the handler to use for scripting.
        Parameters:
        value - the handler

      • getHandler

        public adams.core.scripting.AbstractScriptingHandler getHandler()
        Gets the handler to use for scripting.
        Returns:
        the handler

      • handlerTipText

        public String handlerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • createHeader

        public adams.data.featureconverter.HeaderDefinition createHeader​(Heatmap map)
        Creates the header from a template heatmap.
        Specified by:
        createHeader in class AbstractHeatmapFeatureGenerator
        Parameters:
        map - the heatmap to act as a template
        Returns:
        the generated header

      • destroy

        public void destroy()
        Frees up memory in a "destructive" non-reversible way.
        Specified by:
        destroy in interface adams.core.Destroyable
        Overrides:
        destroy in class AbstractScriptedFeatureGenerator