Package adams.data.conversion

Class SpreadSheetToThreeWayData

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, 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.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, Serializable
    public class SpreadSheetToThreeWayData
extends adams.data.conversion.AbstractConversion
    Converts a spreadsheet into a 3-way data structure.
    The sheet requires four columns: X, Y, Z and data.
    The Z column is optional, which, if not provided, is simply assumed to be 0. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -column-x <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnX)
    The column in the spreadsheet representing the X axis.
    default: 1
    example: 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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -column-y <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnY)
    The column in the spreadsheet representing the Y axis.
    default: 2
    example: 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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -column-z <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnZ)
    The column in the spreadsheet representing the (optional) Z axis.
    default:
    example: 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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -column-data <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnData)
    The column in the spreadsheet representing the data column.
    default: 3
    example: 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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnData
      the data column.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnX
      the X column.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnY
      the Y column.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnZ
      the Z column.

      • Fields inherited from class adams.data.conversion.AbstractConversion

        m_Input, m_Output, m_Owner, m_Stopped

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class accepts()
      Returns the class that is accepted as input.
      String columnDataTipText()
      Returns the tip text for this property.
      String columnXTipText()
      Returns the tip text for this property.
      String columnYTipText()
      Returns the tip text for this property.
      String columnZTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected Object doConvert()
      Performs the actual conversion.
      Class generates()
      Returns the class that is generated as output.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColumnData()
      Returns the data column.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColumnX()
      Returns the X column.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColumnY()
      Returns the Y column.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColumnZ()
      Returns the Z column.
      String globalInfo()
      Returns a string describing the object.
      void setColumnData​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the data column.
      void setColumnX​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the X column.
      void setColumnY​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the X column.
      void setColumnZ​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the Z column.

      • Methods inherited from class adams.data.conversion.AbstractConversion

        checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_ColumnX

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnX
        the X column.

      • m_ColumnY

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnY
        the Y column.

      • m_ColumnZ

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnZ
        the Z column.

      • m_ColumnData

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnData
        the data column.

    • Constructor Detail

      • SpreadSheetToThreeWayData

        public SpreadSheetToThreeWayData()

    • 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 adams.core.option.AbstractOptionHandler

      • setColumnX

        public void setColumnX​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the X column.
        Parameters:
        value - the column

      • getColumnX

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnX()
        Returns the X column.
        Returns:
        the column

      • columnXTipText

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

      • setColumnY

        public void setColumnY​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the X column.
        Parameters:
        value - the column

      • getColumnY

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnY()
        Returns the Y column.
        Returns:
        the column

      • columnYTipText

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

      • setColumnZ

        public void setColumnZ​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the Z column.
        Parameters:
        value - the column

      • getColumnZ

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnZ()
        Returns the Z column.
        Returns:
        the column

      • columnZTipText

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

      • setColumnData

        public void setColumnData​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the data column.
        Parameters:
        value - the column

      • getColumnData

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnData()
        Returns the data column.
        Returns:
        the column

      • columnDataTipText

        public String columnDataTipText()
        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 is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion