Package adams.flow.transformer.indexedsplitsrunsgenerator

Class SpreadSheetRandomSplitGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

adams.flow.transformer.indexedsplitsrunsgenerator.AbstractSpreadSheetIndexedSplitsRunsGenerator

adams.flow.transformer.indexedsplitsrunsgenerator.SpreadSheetRandomSplitGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Randomizable, SizeOfHandler, FlowContextHandler, IndexedSplitsRunsGenerator, SpreadSheetIndexedSplitsRunsGenerator, Serializable

public class SpreadSheetRandomSplitGenerator
extends AbstractSpreadSheetIndexedSplitsRunsGenerator
implements Randomizable

Random split generator that works on spreadsheets.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Percentage	the percentage.
protected boolean	m_PreserveOrder	whether to preserve the order.
protected long	m_Seed	the seed value.

Fields inherited from class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

m_FlowContext, m_MetaData

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected IndexedSplitsRuns	doGenerate(Object data, MessageCollection errors)	Generates the indexed splits.
double	getPercentage()	Returns the split percentage.
boolean	getPreserveOrder()	Returns whether to preserve the order.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
long	getSeed()	Returns the seed value.
String	globalInfo()	Returns a string describing the object.
String	percentageTipText()	Returns the tip text for this property.
String	preserveOrderTipText()	Returns the tip text for this property.
String	seedTipText()	Returns the tip text for this property.
void	setPercentage(double value)	Sets the split percentage.
void	setPreserveOrder(boolean value)	Sets whether to preserve the order.
void	setSeed(long value)	Sets the seed value.

Methods inherited from class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractSpreadSheetIndexedSplitsRunsGenerator

accepts

Methods inherited from class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

check, generate, getFlowContext, getMetaData, metaDataTipText, postGenerate, setFlowContext, setMetaData

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.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.flow.transformer.indexedsplitsrunsgenerator.IndexedSplitsRunsGenerator

generate

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Percentage

protected double m_Percentage

the percentage.

m_Seed

protected long m_Seed

the seed value.

m_PreserveOrder

protected boolean m_PreserveOrder

whether to preserve the order.

Constructor Detail

SpreadSheetRandomSplitGenerator

public SpreadSheetRandomSplitGenerator()

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 AbstractIndexedSplitsRunsGenerator

setPercentage

public void setPercentage(double value)

Sets the split percentage.

Parameters:

value - the percentage (0-1)

getPercentage

public double getPercentage()

Returns the split percentage.

Returns:

the percentage (0-1)

percentageTipText

public String percentageTipText()

Returns the tip text for this property.

Returns:

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

setSeed

public void setSeed(long value)

Sets the seed value.

Specified by:

setSeed in interface Randomizable

Parameters:

value - the seed

getSeed

public long getSeed()

Returns the seed value.

Specified by:

getSeed in interface Randomizable

Returns:

the seed

seedTipText

public String seedTipText()

Returns the tip text for this property.

Specified by:

seedTipText in interface Randomizable

Returns:

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

setPreserveOrder

public void setPreserveOrder(boolean value)

Sets whether to preserve the order.

Parameters:

value - true if to preserve order

getPreserveOrder

public boolean getPreserveOrder()

Returns whether to preserve the order.

Returns:

true if to preserve order

preserveOrderTipText

public String preserveOrderTipText()

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 AbstractIndexedSplitsRunsGenerator

Returns:

null if no info available, otherwise short string

doGenerate

protected IndexedSplitsRuns doGenerate(Object data,
                                       MessageCollection errors)

Generates the indexed splits.

Specified by:

doGenerate in class AbstractIndexedSplitsRunsGenerator

Parameters:

data - the data to use for generating the splits

errors - for storing any errors occurring during processing

Returns:

the splits or null in case of error