Package adams.flow.condition.bool

Class HasRows

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.HasRows

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<BooleanCondition>, SizeOfHandler, Stoppable, BooleanCondition, Serializable

public class HasRows
extends AbstractBooleanCondition

Checks whether the spreadsheet passing through has the required number of rows.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-min-rows <int> (property: minRows)
    The minimum number of rows that the spreadsheet needs to have, no lower
    bound if -1.
    default: 1
    minimum: -1
 

-max-rows <int> (property: maxRows)
    The maximum number of rows that the spreadsheet can have, no upper bound
    if -1.
    default: -1
    minimum: -1
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MaxRows	the maximum number of rows.
protected int	m_MinRows	the minimum number of rows.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
HasRows()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doEvaluate(Actor owner, Token token)	Performs the actual evaluation.
int	getMaxRows()	Returns the maximum number of rows the spreadsheet can have.
int	getMinRows()	Returns the minimum number of rows the spreadsheet has to have
String	getQuickInfo()	Returns the quick info string to be displayed in the flow editor.
String	globalInfo()	Returns a string describing the object.
String	maxRowsTipText()	Returns the tip text for this property.
String	minRowsTipText()	Returns the tip text for this property.
void	setMaxRows(int value)	Sets the maximum number of rows the spreadsheet can have.
void	setMinRows(int value)	Sets the minimum number of rows the spreadsheet has to have.

Methods inherited from class adams.flow.condition.bool.AbstractBooleanCondition

evaluate, preEvaluate, setUp, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_MinRows

protected int m_MinRows

the minimum number of rows.

m_MaxRows

protected int m_MaxRows

the maximum number of rows.

Constructor Detail

HasRows

public HasRows()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setMinRows

public void setMinRows(int value)

Sets the minimum number of rows the spreadsheet has to have.

Parameters:

value - the number of rows (-1: no lower bound)

getMinRows

public int getMinRows()

Returns the minimum number of rows the spreadsheet has to have

Returns:

the number of rows (-1: no lower bound)

minRowsTipText

public String minRowsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setMaxRows

public void setMaxRows(int value)

Sets the maximum number of rows the spreadsheet can have.

Parameters:

value - the number of rows (-1: no upper bound)

getMaxRows

public int getMaxRows()

Returns the maximum number of rows the spreadsheet can have.

Returns:

the number of rows (-1: no upper bound)

maxRowsTipText

public String maxRowsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns the quick info string to be displayed in the flow editor.

Specified by:

getQuickInfo in interface BooleanCondition

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in class AbstractBooleanCondition

Returns:

the info or null if no info to be displayed

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface BooleanCondition

Specified by:

accepts in class AbstractBooleanCondition

Returns:

adams.flow.core.Unknown.class

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