Package adams.flow.transformer

Class SpreadSheetSetHeaderCell

  • 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 SpreadSheetSetHeaderCell
extends AbstractInPlaceSpreadSheetTransformer
    Sets a single header cell value in a spreadsheet.

    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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetSetHeaderCell
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -col <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: column)
    The column of the header cell to set; 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: 1
    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.
 
    -value <java.lang.String> (property: value)
    The value to set in the header cell.
    default:
 
    -force-string <boolean> (property: forceString)
    If enabled, the value is set as string, even if it resembles a number.
    default: false
 
    -expand-variables <boolean> (property: expandVariables)
    If enabled, any variables in the value get expanded first before setting
    it.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Value

        protected String m_Value
        the value to return if cell is empty.

      • m_ForceString

        protected boolean m_ForceString
        whether to set value as string.

      • m_ExpandVariables

        protected boolean m_ExpandVariables
        whether to expand variables.

    • Constructor Detail

      • SpreadSheetSetHeaderCell

        public SpreadSheetSetHeaderCell()

    • Method Detail

      • setColumn

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

      • getColumn

        public SpreadSheetColumnIndex getColumn()
        Returns the column of the header cell.
        Returns:
        the column

      • 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.

      • setValue

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

      • getValue

        public String getValue()
        Returns the value to set in the cell.
        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.

      • setExpandVariables

        public void setExpandVariables​(boolean value)
        Sets whether to expand any variable first before setting the value.
        Parameters:
        value - true if to expand first

      • getExpandVariables

        public boolean getExpandVariables()
        Returns whether to expand any variable first before setting the value.
        Returns:
        true if to expand first

      • expandVariablesTipText

        public String expandVariablesTipText()
        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