Package adams.data.conversion

Class SpreadSheetToWordFrequencies

  • 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 SpreadSheetToWordFrequencies
extends adams.data.conversion.AbstractConversion
    Turns a spreadsheet with two columns for words and frequencies into an array of word frequency objects. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -column-word <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnWord)
    The column containing the words.
    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-frequency <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnFrequency)
    The column containing the frequencies.
    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.
    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_ColumnFrequency
      the column with the frequencies.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnWord
      the column with the words.

      • 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 columnFrequencyTipText()
      Returns the tip text for this property.
      String columnWordTipText()
      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 getColumnFrequency()
      Returns the column containing the frequencies.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColumnWord()
      Returns the column containing the words.
      String globalInfo()  
      void setColumnFrequency​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the column containing the frequencies.
      void setColumnWord​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the column containing the words.

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

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnWord
        the column with the words.

      • m_ColumnFrequency

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColumnFrequency
        the column with the frequencies.

    • Constructor Detail

      • SpreadSheetToWordFrequencies

        public SpreadSheetToWordFrequencies()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler

      • 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

      • setColumnWord

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

      • getColumnWord

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnWord()
        Returns the column containing the words.
        Returns:
        the column

      • columnWordTipText

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

      • setColumnFrequency

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

      • getColumnFrequency

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColumnFrequency()
        Returns the column containing the frequencies.
        Returns:
        the column

      • columnFrequencyTipText

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