Package adams.data.conversion

Class SpreadSheetToMap

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable
    public class SpreadSheetToMap
extends AbstractConversion
    Turns two columns (key and value) of a spreadsheet into a map object of the specified type. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -key-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: keyColumn)
    The column in the spreadsheet to act as the 'key' for the values.
    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.
 
    -value-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: valueColumn)
    The column in the spreadsheet to stores the 'values'.
    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.
 
    -map-class <adams.core.base.BaseClassname> (property: mapClass)
    The type of map to instantiate and fill.
    default: java.util.HashMap
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SpreadSheetToMap

        public SpreadSheetToMap()

    • Method Detail

      • setKeyColumn

        public void setKeyColumn​(SpreadSheetColumnIndex value)
        Sets the key column.
        Parameters:
        value - the column

      • keyColumnTipText

        public String keyColumnTipText()
        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 value column.
        Parameters:
        value - the column

      • getValueColumn

        public SpreadSheetColumnIndex getValueColumn()
        Returns the value column.
        Returns:
        the column

      • 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.

      • setMapClass

        public void setMapClass​(BaseClassname value)
        Sets the map class.
        Parameters:
        value - the map class

      • getMapClass

        public BaseClassname getMapClass()
        Returns the map class.
        Returns:
        the map class

      • mapClassTipText

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