Package adams.data.spreadsheet.rowfinder

Class SubSample

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowfinder.AbstractRowFinder

adams.data.spreadsheet.rowfinder.SubSample

All Implemented Interfaces:

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

public class SubSample
extends AbstractRowFinder

Returns the indices of a subsample of rows.

Version:

$Revision: 8096 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RandomIntegerRangeGenerator	m_Generator	the random number generator.
protected boolean	m_Invert	whether to invert the selection.
protected double	m_Size	the size of the sample (0-1: percent, >1: absolute number).

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindRows(SpreadSheet data)	Returns the rows of interest in the spreadsheet.
String	generatorTipText()	Returns the tip text for this property.
RandomIntegerRangeGenerator	getGenerator()	Returns the random number generator.
boolean	getInvert()	Returns whether to invert the matching.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
double	getSize()	Returns the size of the sample (0-1: percentage, >1: absolute number).
String	globalInfo()	Returns a string describing the object.
String	invertTipText()	Returns the tip text for this property.
void	setGenerator(RandomIntegerRangeGenerator value)	Sets the random number generator.
void	setInvert(boolean value)	Sets whether to invert the matching.
void	setSize(double value)	Sets the size of the sample (0-1: percentage, >1: absolute number).
String	sizeTipText()	Returns the tip text for this property.

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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Size

protected double m_Size

the size of the sample (0-1: percent, >1: absolute number).

m_Generator

protected RandomIntegerRangeGenerator m_Generator

the random number generator.

m_Invert

protected boolean m_Invert

whether to invert the selection.

Constructor Detail

SubSample

public SubSample()

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

setSize

public void setSize(double value)

Sets the size of the sample (0-1: percentage, >1: absolute number).

Parameters:

value - the size

getSize

public double getSize()

Returns the size of the sample (0-1: percentage, >1: absolute number).

Returns:

the size

sizeTipText

public String sizeTipText()

Returns the tip text for this property.

Returns:

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

setGenerator

public void setGenerator(RandomIntegerRangeGenerator value)

Sets the random number generator.

Parameters:

value - the generator

getGenerator

public RandomIntegerRangeGenerator getGenerator()

Returns the random number generator.

Returns:

the generator

generatorTipText

public String generatorTipText()

Returns the tip text for this property.

Returns:

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

setInvert

public void setInvert(boolean value)

Sets whether to invert the matching.

Parameters:

value - true if to invert

getInvert

public boolean getInvert()

Returns whether to invert the matching.

Returns:

true if to invert

invertTipText

public String invertTipText()

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 a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRowFinder

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 class AbstractRowFinder

Parameters:

data - the spreadsheet to inspect

Returns:

the rows of interest