Package adams.flow.transformer.plotgenerator

Class RowWisePlotGenerator

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable
    public class RowWisePlotGenerator
extends AbstractPlotGenerator
    Generates a separate plot per row in the spreadsheet, using the specified columns as data points. Additional meta-data columns can be specified as well. The optional ID column can be used to name the row plots. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -default-cell-value <double> (property: defaultCellValue)
    The default value for missing or non-numeric cells.
    default: -1.0
 
    -plot-name-range <java.lang.String> (property: plotNameRange)
    The range of columns to use for generating the plot name (overrides any 
    plot generator specific names); A range is a comma-separated list of single 
    1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts 
    the range '...'; column names (case-sensitive) as well as the following 
    placeholders can be used: first, second, third, last_2, last_1, last
    default: 
 
    -plot-name-separator <java.lang.String> (property: plotNameSeparator)
    The separator to use when constructing the plot name from cell values.
    default: 
 
    -id-column <java.lang.String> (property: IDColumn)
    The (optional) column to use for naming the row plot; An index is a number 
    starting with 1; column names (case-sensitive) as well as the following 
    placeholders can be used: first, second, third, last_2, last_1, last
    default: 
 
    -data-columns <java.lang.String> (property: dataColumns)
    The range of columns to include in the plot; A range is a comma-separated 
    list of single 1-based indices or sub-ranges of indices ('start-end'); '
    inv(...)' inverts the range '...'; column names (case-sensitive) as well 
    as the following placeholders can be used: first, second, third, last_2, 
    last_1, last
    default: 
 
    -meta-data-columns <java.lang.String> (property: metaDataColumns)
    The range of columns to add as meta-data in the plot; A range is a comma-separated 
    list of single 1-based indices or sub-ranges of indices ('start-end'); '
    inv(...)' inverts the range '...'; column names (case-sensitive) as well 
    as the following placeholders can be used: first, second, third, last_2, 
    last_1, last
    default: 
 
    -add-column-name <boolean> (property: addColumnName)
    If enabled, the column name gets added to the meta-data.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_IDColumn

        protected SpreadSheetColumnIndex m_IDColumn
        the (optional) column that identifies a row, uses as plot name.

      • m_AddColumnName

        protected boolean m_AddColumnName
        whether to add the column name as meta-data.

    • Constructor Detail

      • RowWisePlotGenerator

        public RowWisePlotGenerator()

    • Method Detail

      • setIDColumn

        public void setIDColumn​(String value)
        Sets the (optional) column to use for naming the row plots.
        Parameters:
        value - the column

      • getIDColumn

        public String getIDColumn()
        Returns the (optional) column to use for naming the row plots.
        Returns:
        the column

      • IDColumnTipText

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

      • setDataColumns

        public void setDataColumns​(String value)
        Sets the column range to use in the plot.
        Parameters:
        value - the column range

      • getDataColumns

        public String getDataColumns()
        Returns the current column range to use in the plot.
        Returns:
        the column range

      • dataColumnsTipText

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

      • setMetaDataColumns

        public void setMetaDataColumns​(String value)
        Sets the column range to add as meta-data in the plot.
        Parameters:
        value - the column range

      • getMetaDataColumns

        public String getMetaDataColumns()
        Returns the current column range to add as meta-data in the plot.
        Returns:
        the column range

      • metaDataColumnsTipText

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

      • setAddColumnName

        public void setAddColumnName​(boolean value)
        Sets whether to add the column name to the meta-data.
        Parameters:
        value - true if to add column name

      • getAddColumnName

        public boolean getAddColumnName()
        Returns whether to add the column name to the meta-data.
        Returns:
        true if to add column name

      • addColumnNameTipText

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