Package adams.data.objectfinder
Class ByMetaDataNumericValue
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.objectfinder.AbstractObjectFinder
-
- adams.data.objectfinder.ByMetaDataNumericValue
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LenientModeSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,SizeOfHandler
,ObjectFinder
,ObjectPrefixHandler
,Serializable
public class ByMetaDataNumericValue extends AbstractObjectFinder
Returns indices of objects which numeric meta-data value match the min/max.- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
m_Key
the meta-data key to inspect.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.static String
NAN
the placeholder for NaN.-
Fields inherited from class adams.data.objectfinder.AbstractObjectFinder
m_Lenient, m_Prefix, m_Quiet, 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 ByMetaDataNumericValue()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.String
getKey()
Returns the meta-data key to check.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.String
globalInfo()
Returns a string describing the object.String
keyTipText()
Returns the tip text for this property.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
setKey(String value)
Sets the meta-data key to check.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.-
Methods inherited from class adams.data.objectfinder.AbstractObjectFinder
check, filter, find, find, findObjects, findObjects, getLenient, getPrefix, getQuiet, getResetIndicesIfNecessary, lenientTipText, prefixTipText, quietTipText, resetIndicesIfNecessaryTipText, setLenient, setPrefix, setQuiet, 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_Key
protected String m_Key
the meta-data key to inspect.
-
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.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractObjectFinder
-
setKey
public void setKey(String value)
Sets the meta-data key to check.- Parameters:
value
- the key
-
getKey
public String getKey()
Returns the meta-data key to check.- Returns:
- the key
-
keyTipText
public String keyTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
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
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractObjectFinder
- Returns:
- null if no info available, otherwise short string
-
doFind
protected int[] doFind(LocatedObjects objects)
Performs the actual finding of the objects in the list.- Specified by:
doFind
in classAbstractObjectFinder
- Parameters:
objects
- the list of objects to process- Returns:
- the indices
-
-