Package adams.data.timeseries

Class AddMetaData

  • All Implemented Interfaces:
    CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractTimeseriesFeatureGenerator>, SizeOfHandler, Serializable, Comparable
    public class AddMetaData
extends AbstractMetaTimeseriesFeatureGenerator
    Meta-generator that can add database ID and container ID. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter)
    The feature converter to use to produce the output data.
    default: adams.data.featureconverter.SpreadSheetFeatureConverter -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet
 
    -field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default: 
 
    -notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default: 
 
    -generator <adams.data.timeseries.AbstractTimeseriesFeatureGenerator> (property: generator)
    The base generator to use.
    default: adams.data.timeseries.Values -converter \"adams.data.featureconverter.SpreadSheetFeatureConverter -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.SpreadSheet\"
 
    -add-database-id <boolean> (property: addDatabaseID)
    If enabled, the database ID of the container gets added to the data.
    default: false
 
    -add-id <boolean> (property: addID)
    If enabled, the ID of the container gets added to the data.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_AddDatabaseID

        protected boolean m_AddDatabaseID
        whether to add the database ID.

      • m_AddID

        protected boolean m_AddID
        whether to add the container ID.

    • Constructor Detail

      • AddMetaData

        public AddMetaData()

    • Method Detail

      • setAddDatabaseID

        public void setAddDatabaseID​(boolean value)
        Sets whether to add the database ID.
        Parameters:
        value - true if to add database ID

      • getAddDatabaseID

        public boolean getAddDatabaseID()
        Returns whether to add the database ID.
        Returns:
        true if to add database ID

      • addDatabaseIDTipText

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

      • setAddID

        public void setAddID​(boolean value)
        Sets whether to add the ID.
        Parameters:
        value - true if to add ID

      • getAddID

        public boolean getAddID()
        Returns whether to add the ID.
        Returns:
        true if to add ID

      • addIDTipText

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