Package adams.flow.source

Class NewSpreadSheet

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DataRowTypeHandler, SpreadSheetTypeHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class NewSpreadSheet
extends AbstractSimpleSource
implements SpreadSheetTypeHandler
    Generates an empty spreadsheet.

    Input/output:
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: NewSpreadSheet
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -spreadsheet-name <java.lang.String> (property: sheetName)
    The name for the spreadsheet.
    default:
 
    -columns <adams.core.base.BaseText> (property: columns)
    The comma-separated list of column names.
    default: A,B,C
 
    -columns-array <adams.core.base.BaseString> [-columns-array ...] (property: columnsArray)
    The array of column names to use (takes precedence over comma-separated
    list).
    default:
 
    -data-row-type <adams.data.spreadsheet.DataRow> (property: dataRowType)
    The type of row to use for the data.
    default: adams.data.spreadsheet.DenseDataRow
 
    -spreadsheet-type <adams.data.spreadsheet.SpreadSheet> (property: spreadSheetType)
    The type of spreadsheet to use for the data.
    default: adams.data.spreadsheet.DefaultSpreadSheet
 
    -comments <adams.core.base.BaseText> (property: comments)
    The comments to use.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_SheetName

        protected String m_SheetName
        the spreadsheet name.

      • m_Columns

        protected BaseText m_Columns
        the comma-separated list of column headers.

      • m_ColumnsArray

        protected BaseString[] m_ColumnsArray
        the array of column headers to use.

      • m_DataRowType

        protected DataRow m_DataRowType
        the data row type to use.

      • m_SpreadSheetType

        protected SpreadSheet m_SpreadSheetType
        the type of spreadsheet to use.

      • m_Comments

        protected BaseText m_Comments
        the initial comments to use.

    • Constructor Detail

      • NewSpreadSheet

        public NewSpreadSheet()

    • Method Detail

      • setSheetName

        public void setSheetName​(String value)
        Sets the name for the spreadsheet.
        Parameters:
        value - the name

      • getSheetName

        public String getSheetName()
        Returns the name for the spreadsheet
        Returns:
        the name

      • sheetNameTipText

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

      • setColumns

        public void setColumns​(BaseText value)
        Sets the comma-separated list of column names.
        Parameters:
        value - the list

      • getColumns

        public BaseText getColumns()
        Returns the comma-separated list of column names.
        Returns:
        the list

      • columnsTipText

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

      • setColumnsArray

        public void setColumnsArray​(BaseString[] value)
        Sets the array of column names (takes precedence over comma-separated list).
        Parameters:
        value - the array

      • getColumnsArray

        public BaseString[] getColumnsArray()
        Returns the array of column names (takes precedence over comma-separated list).
        Returns:
        the array

      • columnsArrayTipText

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

      • dataRowTypeTipText

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

      • spreadSheetTypeTipText

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

      • setComments

        public void setComments​(BaseText value)
        Sets the comments to use.
        Parameters:
        value - the comments

      • getComments

        public BaseText getComments()
        Returns the comments to use.
        Returns:
        the comments

      • commentsTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message