Package adams.flow.transformer

Class SpreadSheetInfo

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, DataInfoActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetInfo
extends AbstractArrayProvider
implements DataInfoActor
    Outputs statistics of a SpreadSheet object.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       java.lang.Integer


    -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: SpreadSheetInfo
 
    -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
 
    -output-array <boolean> (property: outputArray)
    If enabled, the info items get output as array rather than one-by-one.
    default: false
 
    -type <NAME|COMMENTS|TIMEZONE|LOCALE|NUM_COLUMNS|NUM_ROWS|COLUMN_NAME|COLUMN_NAMES|COLUMN_TYPE|CELL_TYPES|CELL_VALUES|COLUMN_VALUES|SHEET_VALUES|FIELD_SPEC|FIELD_SPECS|FIELD_TYPE|FIELD_TYPES> (property: type)
    The type of information to generate.
    default: NUM_ROWS
 
    -column-index <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnIndex)
    The column index to use for generating column-specific information. 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.
    default: last
    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.
 
    -sort <boolean> (property: sort)
    If enabled, lists (eg names, values) are sorted.
    default: true
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ColumnIndex

        protected SpreadSheetColumnIndex m_ColumnIndex
        the index of the column to get the information for.

      • m_Sort

        protected boolean m_Sort
        whether to sort lists.

    • Constructor Detail

      • SpreadSheetInfo

        public SpreadSheetInfo()

    • Method Detail

      • setType

        public void setType​(SpreadSheetInfo.InfoType value)
        Sets the type of information to generate.
        Parameters:
        value - the type

      • typeTipText

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

      • setColumnIndex

        public void setColumnIndex​(SpreadSheetColumnIndex value)
        Sets the column index to use for column specific information.
        Parameters:
        value - the 1-based index

      • getColumnIndex

        public SpreadSheetColumnIndex getColumnIndex()
        Returns the column index to use for column specific information.
        Returns:
        the 1-based index

      • columnIndexTipText

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

      • setSort

        public void setSort​(boolean value)
        Sets whether to sort lists (eg names, values).
        Parameters:
        value - true if to sort

      • getSort

        public boolean getSort()
        Returns whether lists (eg names, values) are sorted.
        Returns:
        true if to sort

      • sortTipText

        public String sortTipText()
        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 the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        adams.data.spreadsheet.SpreadSheet.class

      • toField

        protected Field toField​(SpreadSheet sheet,
                        int col)
        Turns the column into a field.
        Parameters:
        sheet - the spreadsheet to use
        col - the column index
        Returns:
        the field

      • doExecute

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