Package adams.flow.transformer.plotgenerator

Class XYPlotGenerator

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable
    public class XYPlotGenerator
extends AbstractPlotGenerator
    Uses one column for the X value and one or more other columns as Y to plot against. 

    -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: 
 
    -columns <java.lang.String> (property: plotColumns)
    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: 
 
    -x-column <java.lang.String> (property: XColumn)
    The (optional) index of the column which values to use as X values in the 
    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: 
 
    -prefix-columns <adams.data.spreadsheet.SpreadSheetColumnRange> (property: prefixColumns)
    The range of columns to prefix the plot name with; 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: 
    example: 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
 
    -separator <java.lang.String> (property: separator)
    The separator to use between columns.
    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:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • XYPlotGenerator

        public XYPlotGenerator()

    • Method Detail

      • setPlotColumns

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

      • getPlotColumns

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

      • plotColumnsTipText

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

      • setXColumn

        public void setXColumn​(String value)
        Sets the index of the column which values to use as X values.
        Parameters:
        value - the column index

      • getXColumn

        public String getXColumn()
        Returns the index of the column which values to use as X values.
        Returns:
        the column index

      • XColumnTipText

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

      • setPrefixColumns

        public void setPrefixColumns​(SpreadSheetColumnRange value)
        Sets the column range to generate the prefix of the plot with.
        Parameters:
        value - the column range

      • getPrefixColumns

        public SpreadSheetColumnRange getPrefixColumns()
        Returns the current column range to generate the prefix of the plot with.
        Returns:
        the column range

      • prefixColumnsTipText

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

      • setSeparator

        public void setSeparator​(String value)
        Sets the separator to use between columns.
        Parameters:
        value - the separator

      • getSeparator

        public String getSeparator()
        Returns the separator in use between columns.
        Returns:
        the separator

      • separatorTipText

        public String separatorTipText()
        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.