Package adams.flow.transformer

Class SpreadSheetSetCell

  • 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 SpreadSheetSetCell
extends AbstractInPlaceSpreadSheetTransformer
    Sets the value of the specified cells in a spreadsheet.

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


    -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: SpreadSheetSetCell
 
    -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
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -row <adams.core.Range> (property: row)
    The row(s) of the cell(s) to set.
    default: 1
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -col <adams.data.spreadsheet.SpreadSheetColumnRange> (property: column)
    The column(s) of the cell(s) to set
    default: 1
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; 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.
 
    -use-finder <boolean> (property: useFinder)
    If enabled, the value is set at the locations that the specified finder
    scheme determined.
    default: false
 
    -finder <adams.data.spreadsheet.cellfinder.CellFinder> (property: finder)
    The column finder to use for identifying cells.
    default: adams.data.spreadsheet.cellfinder.CellRange
 
    -value <java.lang.String> (property: value)
    The value to set in the cell(s).
    default: 
 
    -force-string <boolean> (property: forceString)
    If enabled, the value is set as string, even if it resembles a number.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Row

        protected Range m_Row
        the row of the cell to obtain.

      • m_UseFinder

        protected boolean m_UseFinder
        whether to use a cell finder instead.

      • m_Finder

        protected CellFinder m_Finder
        the finder to use.

      • m_Value

        protected String m_Value
        the value to set.

      • m_ForceString

        protected boolean m_ForceString
        whether to set value as string.

    • Constructor Detail

      • SpreadSheetSetCell

        public SpreadSheetSetCell()

    • Method Detail

      • setRow

        public void setRow​(Range value)
        Sets the row(s) of the cell(s).
        Parameters:
        value - the row(s)

      • getRow

        public Range getRow()
        Returns the row(s) of the cell(s).
        Returns:
        the row(s)

      • rowTipText

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

      • setColumn

        public void setColumn​(SpreadSheetColumnRange value)
        Sets the column(s) of the cell.
        Parameters:
        value - the column(s)

      • getColumn

        public SpreadSheetColumnRange getColumn()
        Returns the column(s) of the cell.
        Returns:
        the column(s)

      • columnTipText

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

      • setUseFinder

        public void setUseFinder​(boolean value)
        Sets whether to the value is set at the locations that the specified finder scheme determined.
        Parameters:
        value - true if to use cell finder

      • getUseFinder

        public boolean getUseFinder()
        Returns whether to the value is set at the locations that the specified finder scheme determined.
        Returns:
        true if to use cell finder

      • useFinderTipText

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

      • setFinder

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

      • getFinder

        public CellFinder getFinder()
        Returns the finder in 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.

      • setValue

        public void setValue​(String value)
        Sets the value to set in the cell(s).
        Parameters:
        value - the value

      • getValue

        public String getValue()
        Returns the value to set in the cell(s).
        Returns:
        the value

      • valueTipText

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

      • setForceString

        public void setForceString​(boolean value)
        Sets whether to force setting the value as string even if it resembles a number.
        Parameters:
        value - true if to force string

      • getForceString

        public boolean getForceString()
        Returns whether to force setting the value as string even if it resembles a number.
        Returns:
        true if string type is enforced

      • forceStringTipText

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

      • doExecute

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