Class HasCell

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<BooleanCondition>, SizeOfHandler, Stoppable, BooleanCondition, Serializable

    public class HasCell
    extends AbstractBooleanCondition
    Checks whether the specified cell is present in the spreadsheet and has a value. If a value is specified, it also checks whether the cell value is the same.

    -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
     
    -row <adams.data.spreadsheet.SpreadSheetRowIndex> (property: row)
        The row to check.
        default: 1
        example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
     
    -column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: column)
        The column to check.
        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 optional value to check against, ignored if empty.
        default:
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Constructor Detail

      • HasCell

        public HasCell()
    • Method Detail

      • setRow

        public void setRow​(SpreadSheetRowIndex value)
        Sets the row to check.
        Parameters:
        value - the row
      • 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​(SpreadSheetColumnIndex value)
        Sets the column to check.
        Parameters:
        value - 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 optional value to check, ignored if empty.
        Parameters:
        value - the value
      • getValue

        public String getValue()
        Returns the optional value to check, ignored if empty.
        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.
      • doEvaluate

        protected boolean doEvaluate​(Actor owner,
                                     Token token)
        Performs the actual evaluation.
        Specified by:
        doEvaluate in class AbstractBooleanCondition
        Parameters:
        owner - the owning actor
        token - the current token passing through
        Returns:
        the result of the evaluation