Package adams.data.spreadsheet.rowfinder
Class ByDateValue
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.spreadsheet.rowfinder.AbstractRowFinder
-
- adams.data.spreadsheet.rowfinder.ByDateValue
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<RowFinder>
,SizeOfHandler
,RowFinder
,Serializable
public class ByDateValue extends AbstractRowFinder
Returns indices of rows which date/time type falls between the min/max.- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SpreadSheetColumnIndex
m_AttributeIndex
the attribute index to work on.protected Date
m_DateMax
the parsed maximum date.protected Date
m_DateMin
the parsed minimum date.protected DateFormatString
m_Format
the format string.protected String
m_Maximum
the maximum value.protected boolean
m_MaximumIncluded
whether the maximum value is included.protected String
m_Minimum
the minimum value.protected boolean
m_MinimumIncluded
whether the minimum value is included.-
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 ByDateValue()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
attributeIndexTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected int[]
doFindRows(SpreadSheet data)
Returns the rows of interest in the spreadsheet.String
formatTipText()
Returns the tip text for this property.SpreadSheetColumnIndex
getAttributeIndex()
Returns the index of the column to perform the matching on.DateFormatString
getFormat()
Returns the format string for parsing min/max.String
getMaximum()
Returns the maximum.boolean
getMaximumIncluded()
Returns whether the maximum is included.String
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
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.protected void
reset()
Resets the scheme.void
setAttributeIndex(SpreadSheetColumnIndex value)
Sets the index of the column to perform the matching on.void
setFormat(DateFormatString value)
Sets the format string for parsing min/max.void
setMaximum(String value)
Sets the maximum.void
setMaximumIncluded(boolean value)
Sets whether to exclude the maximum.void
setMinimum(String value)
Sets the minimum.void
setMinimumIncluded(boolean value)
Sets whether to exclude the minimum.-
Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractRowFinder
arrayToHashSet, check, compareTo, equals, filter, findRows, forCommandLine, forName, getRowFinders, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Field Detail
-
m_AttributeIndex
protected SpreadSheetColumnIndex m_AttributeIndex
the attribute index to work on.
-
m_Format
protected DateFormatString m_Format
the format string.
-
m_Minimum
protected String m_Minimum
the minimum value.
-
m_MinimumIncluded
protected boolean m_MinimumIncluded
whether the minimum value is included.
-
m_Maximum
protected String m_Maximum
the maximum value.
-
m_MaximumIncluded
protected boolean m_MaximumIncluded
whether the maximum value is included.
-
m_DateMin
protected Date m_DateMin
the parsed minimum date.
-
m_DateMax
protected Date m_DateMax
the parsed maximum date.
-
-
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 classAbstractOptionHandler
-
reset
protected void reset()
Resets the scheme.- Overrides:
reset
in classAbstractOptionHandler
-
setAttributeIndex
public void setAttributeIndex(SpreadSheetColumnIndex value)
Sets the index of the column to perform the matching on.- Parameters:
value
- the index
-
getAttributeIndex
public SpreadSheetColumnIndex getAttributeIndex()
Returns the index of the column to perform the matching on.- Returns:
- the index
-
attributeIndexTipText
public String attributeIndexTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the gui
-
setFormat
public void setFormat(DateFormatString value)
Sets the format string for parsing min/max.- Parameters:
value
- the format
-
getFormat
public DateFormatString getFormat()
Returns the format string for parsing min/max.- Returns:
- the format
-
formatTipText
public String formatTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the gui
-
setMinimum
public void setMinimum(String value)
Sets the minimum.- Parameters:
value
- the minimum
-
getMinimum
public String 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(String value)
Sets the maximum.- Parameters:
value
- the maximum
-
getMaximum
public String 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 classAbstractRowFinder
- Returns:
- null if no info available, otherwise short string
-
doFindRows
protected int[] doFindRows(SpreadSheet data)
Returns the rows of interest in the spreadsheet.- Specified by:
doFindRows
in classAbstractRowFinder
- Parameters:
data
- the spreadsheet to inspect- Returns:
- the rows of interest
-
-