Package adams.data.conversion

Class SpreadSheetToTimeseries

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable
    public class SpreadSheetToTimeseries
extends AbstractConversion
    Turns a SpreadSheet object into a Timeseries.

    Valid options are: 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -date-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: dateColumn)
    The index of the date column in the spreadsheet to use a timestamp for the 
    timeseries data points.
    default: 1
    example: An index is a number starting with 1; apart from column names (case-sensitive), the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -value-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: valueColumn)
    The index of the column with the timeseries values in the dataset.
    default: 2
    example: An index is a number starting with 1; apart from column names (case-sensitive), the following placeholders can be used as well: first, second, third, last_2, last_1, last
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SpreadSheetToTimeseries

        public SpreadSheetToTimeseries()

    • Method Detail

      • setDateColumn

        public void setDateColumn​(SpreadSheetColumnIndex value)
        Sets the index of the date column to use as timestamp for timeseries.
        Parameters:
        value - the index

      • getDateColumn

        public SpreadSheetColumnIndex getDateColumn()
        Returns the index of the date column to use as timestamp for timeseries.
        Returns:
        the index

      • dateColumnTipText

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

      • setValueColumn

        public void setValueColumn​(SpreadSheetColumnIndex value)
        Sets the index of the column with the timeseries values.
        Parameters:
        value - the index

      • getValueColumn

        public SpreadSheetColumnIndex getValueColumn()
        Returns the index of the column with the timeseries values.
        Returns:
        the index

      • valueColumnTipText

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