Package adams.data.objectfinder

Class Size

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfinder.AbstractObjectFinder

adams.data.objectfinder.Size

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFinder, ObjectPrefixHandler, Serializable

public class Size
extends AbstractObjectFinder

Applies the minimum/maximum constraints to width/height (according to the chosen type).

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Size.CheckType	how to apply the checks.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Maximum	the maximum value.
protected boolean	m_MaximumIncluded	whether the maximum value is included.
protected double	m_Minimum	the minimum value.
protected boolean	m_MinimumIncluded	whether the minimum value is included.
protected Size.CheckType	m_Type	what to apply the constraints to.
static String	NAN	the placeholder for NaN.

Fields inherited from class adams.data.objectfinder.AbstractObjectFinder

m_Lenient, m_Prefix, m_ResetIndicesIfNecessary

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
Size()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFind(LocatedObjects objects)	Performs the actual finding of the objects in the list.
double	getMaximum()	Returns the maximum.
boolean	getMaximumIncluded()	Returns whether the maximum is included.
double	getMinimum()	Returns the minimum.
boolean	getMinimumIncluded()	Returns whether the minimum is included.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Size.CheckType	getType()	Returns what to apply the constraints to.
String	globalInfo()	Returns a string describing the object.
protected boolean	keep(int value)	Checks whether the value fits the constraints.
String	maximumIncludedTipText()	Returns the tip text for this property.
String	maximumTipText()	Returns the tip text for this property.
String	minimumIncludedTipText()	Returns the tip text for this property.
String	minimumTipText()	Returns the tip text for this property.
void	setMaximum(double value)	Sets the maximum.
void	setMaximumIncluded(boolean value)	Sets whether to exclude the maximum.
void	setMinimum(double value)	Sets the minimum.
void	setMinimumIncluded(boolean value)	Sets whether to exclude the minimum.
void	setType(Size.CheckType value)	Sets what to apply the constraints to.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.objectfinder.AbstractObjectFinder

check, filter, find, find, findObjects, findObjects, getLenient, getPrefix, getResetIndicesIfNecessary, lenientTipText, prefixTipText, resetIndicesIfNecessaryTipText, setLenient, setPrefix, setResetIndicesIfNecessary

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

NAN

public static final String NAN

the placeholder for NaN.

See Also:

Constant Field Values

m_Minimum

protected double m_Minimum

the minimum value.

m_MinimumIncluded

protected boolean m_MinimumIncluded

whether the minimum value is included.

m_Maximum

protected double m_Maximum

the maximum value.

m_MaximumIncluded

protected boolean m_MaximumIncluded

whether the maximum value is included.

m_Type

protected Size.CheckType m_Type

what to apply the constraints to.

Constructor Detail

Size

public Size()

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 AbstractObjectFinder

setMinimum

public void setMinimum(double value)

Sets the minimum.

Parameters:

value - the minimum

getMinimum

public double getMinimum()

Returns the minimum.

Returns:

the minimum

minimumTipText

public String minimumTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMinimumIncluded

public void setMinimumIncluded(boolean value)

Sets whether to exclude the minimum.

Parameters:

value - true to exclude minimum

getMinimumIncluded

public boolean getMinimumIncluded()

Returns whether the minimum is included.

Returns:

true if minimum included

minimumIncludedTipText

public String minimumIncludedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMaximum

public void setMaximum(double value)

Sets the maximum.

Parameters:

value - the maximum

getMaximum

public double getMaximum()

Returns the maximum.

Returns:

the maximum

maximumTipText

public String maximumTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMaximumIncluded

public void setMaximumIncluded(boolean value)

Sets whether to exclude the maximum.

Parameters:

value - true to exclude maximum

getMaximumIncluded

public boolean getMaximumIncluded()

Returns whether the maximum is included.

Returns:

true if maximum included

maximumIncludedTipText

public String maximumIncludedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setType

public void setType(Size.CheckType value)

Sets what to apply the constraints to.

Parameters:

value - the type

getType

public Size.CheckType getType()

Returns what to apply the constraints to.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractObjectFinder

Returns:

null if no info available, otherwise short string

keep

protected boolean keep(int value)

Checks whether the value fits the constraints.

Parameters:

value - the value to check

Returns:

falls within constraints

doFind

protected int[] doFind(LocatedObjects objects)

Performs the actual finding of the objects in the list.

Specified by:

doFind in class AbstractObjectFinder

Parameters:

objects - the list of objects to process

Returns:

the indices