Package adams.data.twitter

Class SpreadSheetConverter

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, adams.data.spreadsheet.DataRowTypeHandler, adams.data.spreadsheet.SpreadSheetTypeHandler, Serializable
    public class SpreadSheetConverter
extends AbstractTwitterStatusConverter<adams.data.spreadsheet.SpreadSheet>
implements adams.data.spreadsheet.SpreadSheetTypeHandler
    Turns a status update into a spreadsheet object containing a single row. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -field <ID|USER_ID|USER_NAME|SOURCE|TEXT|CREATED|FAVORITED|RETWEET|RETWEET_COUNT|RETWEET_BY_ME|POSSIBLY_SENSITIVE|GEO_LATITUDE|GEO_LONGITUDE|LANGUAGE_CODE|PLACE|PLACE_TYPE|PLACE_URL|STREET_ADDRESS|COUNTRY|COUNTRY_CODE> [-field ...] (property: fields)
    The fields to use for generating the output.
    default: TEXT
    Version:
    $Revision$
    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.DataRow m_DataRowType
      the data row type to use.
      protected adams.data.spreadsheet.SpreadSheet m_Header
      the current header.
      protected adams.data.spreadsheet.SpreadSheet m_SpreadSheetType
      the type of spreadsheet to use.

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Field Detail

      • m_DataRowType

        protected adams.data.spreadsheet.DataRow m_DataRowType
        the data row type to use.

      • m_SpreadSheetType

        protected adams.data.spreadsheet.SpreadSheet m_SpreadSheetType
        the type of spreadsheet to use.

      • m_Header

        protected adams.data.spreadsheet.SpreadSheet m_Header
        the current header.

    • Constructor Detail

      • SpreadSheetConverter

        public SpreadSheetConverter()

    • 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 AbstractTwitterStatusConverter<adams.data.spreadsheet.SpreadSheet>

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setDataRowType

        public void setDataRowType​(adams.data.spreadsheet.DataRow value)
        Sets the type of data row to use.
        Specified by:
        setDataRowType in interface adams.data.spreadsheet.DataRowTypeHandler
        Parameters:
        value - the type

      • getDataRowType

        public adams.data.spreadsheet.DataRow getDataRowType()
        Returns the type of data row to use.
        Specified by:
        getDataRowType in interface adams.data.spreadsheet.DataRowTypeHandler
        Returns:
        the type

      • dataRowTypeTipText

        public String dataRowTypeTipText()
        Returns the tip text for this property.
        Specified by:
        dataRowTypeTipText in interface adams.data.spreadsheet.DataRowTypeHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setSpreadSheetType

        public void setSpreadSheetType​(adams.data.spreadsheet.SpreadSheet value)
        Sets the type of spreadsheet to use.
        Specified by:
        setSpreadSheetType in interface adams.data.spreadsheet.SpreadSheetTypeHandler
        Parameters:
        value - the type

      • getSpreadSheetType

        public adams.data.spreadsheet.SpreadSheet getSpreadSheetType()
        Returns the type of spreadsheet to use.
        Specified by:
        getSpreadSheetType in interface adams.data.spreadsheet.SpreadSheetTypeHandler
        Returns:
        the type

      • spreadSheetTypeTipText

        public String spreadSheetTypeTipText()
        Returns the tip text for this property.
        Specified by:
        spreadSheetTypeTipText in interface adams.data.spreadsheet.SpreadSheetTypeHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generateHeader

        protected void generateHeader()
        Generates the dataset header.

      • doConvert

        protected adams.data.spreadsheet.SpreadSheet doConvert​(Hashtable fields)
        Performs the actual conversion.
        Specified by:
        doConvert in class AbstractTwitterStatusConverter<adams.data.spreadsheet.SpreadSheet>
        Parameters:
        fields - the status data to convert
        Returns:
        the generated output