Package adams.data.featureconverter
Class CountValues
-
- All Implemented Interfaces:
Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,QuickInfoSupporter,SizeOfHandler,Serializable
public class CountValues extends AbstractMetaFeatureConverter
Meta-feature-converter that counts numeric values that satisfy the specified min/max range.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-dataset <java.lang.String> (property: dataset) The dataset name to use. default: Dataset
-converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter) The base feature converter to use for processing the counts. default: adams.data.featureconverter.Text
-minimum <double> (property: minimum) The minimum value that the values must satisfy; use NaN (not a number) to ignore minimum. default: NaN
-minimum-included <boolean> (property: minimumIncluded) If enabled, then the minimum value gets included (testing '<=' rather than '<'). default: false
-maximum <double> (property: maximum) The maximum value that the values must satisfy; use NaN (not a number) to ignore maximum. default: NaN
-maximum-included <boolean> (property: maximumIncluded) If enabled, then the maximum value gets included (testing '>=' rather than '>'). default: false
-label <java.lang.String> (property: label) The optional label to use; otherwise min/max are used to construct label. default:
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringm_Labelthe optional label for the generated feature.protected doublem_Maximumthe maximum value.protected booleanm_MaximumIncludedwhether the maximum value is included.protected doublem_Minimumthe minimum value.protected booleanm_MinimumIncludedwhether the minimum value is included.static StringNANthe placeholder for NaN.-
Fields inherited from class adams.data.featureconverter.AbstractMetaFeatureConverter
m_Converter
-
Fields inherited from class adams.data.featureconverter.AbstractFeatureConverter
m_Dataset, m_Header, m_HeaderDefinition
-
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 CountValues()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringconverterTipText()Returns the tip text for this property.voiddefineOptions()Adds options to the internal list of options.protected ObjectdoGenerateHeader(HeaderDefinition header)Performs the actual generation of the header data structure using the supplied header definition.protected ObjectdoGenerateRow(List data)Performs the actual generation of a row from the raw data.ObjectgenerateRow(List data)Generates a row from the raw data.ClassgetDatasetFormat()Returns the class of the dataset that the converter generates.protected AbstractFeatureConvertergetDefaultConverter()Returns the default converter to use.StringgetLabel()Returns the custom label to use.doublegetMaximum()Returns the maximum.booleangetMaximumIncluded()Returns whether the maximum is included.doublegetMinimum()Returns the minimum.booleangetMinimumIncluded()Returns whether the minimum is included.StringgetQuickInfo()Returns a quick info about the object, which can be displayed in the GUI.ClassgetRowFormat()Returns the class of the row that the converter generates.StringglobalInfo()Returns a string describing the object.StringlabelTipText()Returns the tip text for this property.StringmaximumIncludedTipText()Returns the tip text for this property.StringmaximumTipText()Returns the tip text for this property.StringminimumIncludedTipText()Returns the tip text for this property.StringminimumTipText()Returns the tip text for this property.voidsetLabel(String value)Sets the custom label to use.voidsetMaximum(double value)Sets the maximum.voidsetMaximumIncluded(boolean value)Sets whether to exclude the maximum.voidsetMinimum(double value)Sets the minimum.voidsetMinimumIncluded(boolean value)Sets whether to exclude the minimum.-
Methods inherited from class adams.data.featureconverter.AbstractMetaFeatureConverter
getConverter, setConverter
-
Methods inherited from class adams.data.featureconverter.AbstractFeatureConverter
datasetTipText, generateHeader, getDataset, getHeader, getHeaderDefinition, isInitialized, reset, setDataset
-
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
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_Label
protected String m_Label
the optional label for the generated feature.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractMetaFeatureConverter
-
getDefaultConverter
protected AbstractFeatureConverter getDefaultConverter()
Returns the default converter to use.- Specified by:
getDefaultConverterin classAbstractMetaFeatureConverter- Returns:
- the converter
-
converterTipText
public String converterTipText()
Returns the tip text for this property.- Specified by:
converterTipTextin classAbstractMetaFeatureConverter- 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
-
setLabel
public void setLabel(String value)
Sets the custom label to use.- Parameters:
value- the label to use
-
getLabel
public String getLabel()
Returns the custom label to use.- Returns:
- the label to use
-
labelTipText
public String labelTipText()
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:
getQuickInfoin interfaceQuickInfoSupporter- Overrides:
getQuickInfoin classAbstractMetaFeatureConverter- Returns:
- null if no info available, otherwise short string
-
getDatasetFormat
public Class getDatasetFormat()
Returns the class of the dataset that the converter generates.- Specified by:
getDatasetFormatin classAbstractFeatureConverter- Returns:
- the format
-
getRowFormat
public Class getRowFormat()
Returns the class of the row that the converter generates.- Specified by:
getRowFormatin classAbstractFeatureConverter- Returns:
- the format
-
doGenerateHeader
protected Object doGenerateHeader(HeaderDefinition header)
Performs the actual generation of the header data structure using the supplied header definition.- Specified by:
doGenerateHeaderin classAbstractFeatureConverter- Parameters:
header- the header definition- Returns:
- the dataset structure
-
doGenerateRow
protected Object doGenerateRow(List data)
Performs the actual generation of a row from the raw data.- Specified by:
doGenerateRowin classAbstractFeatureConverter- Parameters:
data- the data of the row, elements can be null (= missing)- Returns:
- the dataset structure
-
generateRow
public Object generateRow(List data)
Generates a row from the raw data.- Overrides:
generateRowin classAbstractFeatureConverter- Parameters:
data- the data of the row, elements can be null (= missing)- Returns:
- the dataset structure
- See Also:
#generateHeader(List, List)
-
-