Package adams.flow.transformer

Class SpreadSheetConvertCells

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, InPlaceProcessing, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetConvertCells
extends AbstractInPlaceSpreadSheetTransformer
    Finds cells in a spreadsheet and converts them with a conversion scheme.
    If the conversion scheme generates a adams.data.spreadsheet.SpreadSheet object itself, this will get merged with the enclosing one: any additional columns get added and the content of the first row gets added to the row the converted cell belongs to.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - 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: SpreadSheetConvertCells
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -finder <adams.data.spreadsheet.cellfinder.CellFinder> (property: finder)
    The cell finder to use.
    default: adams.data.spreadsheet.cellfinder.CellRange
 
    -skip-missing <boolean> (property: skipMissing)
    If enabled, missing cells are skipped.
    default: true
 
    -missing-replacement-value <java.lang.String> (property: missingReplacementValue)
    The string representation of the value to use for replacing missing values.
    default: 
 
    -missing-replacement-type <MISSING|STRING|BOOLEAN|LONG|DOUBLE|DATE|DATETIME|DATETIMEMSEC|TIME|OBJECT> (property: missingReplacementType)
    The data type to use for the replacement value for missing values.
    default: STRING
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The conversion to apply to the located cells.
    default: adams.data.conversion.ObjectToObject
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Finder

        protected CellFinder m_Finder
        for locating the cells.

      • m_SkipMissing

        protected boolean m_SkipMissing
        whether to skip missing cells.

      • m_MissingReplacementValue

        protected String m_MissingReplacementValue
        the value to use instead of missing.

      • m_MissingReplacementType

        protected Cell.ContentType m_MissingReplacementType
        the data type of the replacement value.

      • m_Conversion

        protected Conversion m_Conversion
        the conversion to apply to the cells.

      • m_Cell

        protected Cell m_Cell
        used for parsing missing value replacement strings.

    • Constructor Detail

      • SpreadSheetConvertCells

        public SpreadSheetConvertCells()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setFinder

        public void setFinder​(CellFinder value)
        Sets the cell finder to use.
        Parameters:
        value - the finder

      • getFinder

        public CellFinder getFinder()
        Returns the cell finder to use.
        Returns:
        the finder

      • finderTipText

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

      • setSkipMissing

        public void setSkipMissing​(boolean value)
        Sets whether to skip missing cells.
        Parameters:
        value - true if to skip missing cells

      • getSkipMissing

        public boolean getSkipMissing()
        Returns whether missing cells are skipped.
        Returns:
        true if missing cells are skipped

      • skipMissingTipText

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

      • setMissingReplacementValue

        public void setMissingReplacementValue​(String value)
        Sets the replacement value for missing values.
        Parameters:
        value - the replacement value

      • getMissingReplacementValue

        public String getMissingReplacementValue()
        Returns the replacement value for missing values.
        Returns:
        the replacement value

      • missingReplacementValueTipText

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

      • setMissingReplacementType

        public void setMissingReplacementType​(Cell.ContentType value)
        Sets the data type of the replacement value.
        Parameters:
        value - the replacement type

      • getMissingReplacementType

        public Cell.ContentType getMissingReplacementType()
        Returns the data type of the replacement value.
        Returns:
        the replacement type

      • missingReplacementTypeTipText

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

      • setConversion

        public void setConversion​(Conversion value)
        Sets the conversion scheme to apply to the located cells.
        Parameters:
        value - the conversion

      • getConversion

        public Conversion getConversion()
        Returns the conversion scheme to apply to the located cells.
        Returns:
        the conversion

      • conversionTipText

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

      • transfer

        protected void transfer​(SpreadSheet source,
                        Cell cell)
        Transfers the spreadsheet content as new columns to the spreadsheet the row belongs to.
        Parameters:
        source - the content to transfer
        cell - the cell where the spreadsheet data originated from

      • convertCell

        protected String convertCell​(CellLocation location,
                             SpreadSheet sheet)
        Applies the conversion to the cell.
        Parameters:
        location - the cell location to convert
        sheet - the sheet to process
        Returns:
        null if successful, otherwise error message

      • doExecute

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