Package adams.flow.transformer.preparefilebaseddataset

Class Selected

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.preparefilebaseddataset.AbstractFileBasedDatasetPreparation<String[][]>

adams.flow.transformer.preparefilebaseddataset.Selected

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class Selected
extends AbstractFileBasedDatasetPreparation<String[][]>

Generates a container from the selected elements of the array.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Index	m_Negative	the index for the negative set.
protected Index	m_Test	the index for the test set.
protected Index	m_Train	the index for the training set.
protected Index	m_Validation	the index for the validation set.

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

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that the preparation scheme accepts as input.
protected String	check(String[][] data)	Hook method for checking the data.
void	defineOptions()	Adds options to the internal list of options.
protected List<FileBasedDatasetContainer>	doPrepare(String[][] data)	Prepares the data.
Index	getNegative()	Returns the index for the negative set.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Index	getTest()	Returns the index for the test set.
Index	getTrain()	Returns the index for the training set.
Index	getValidation()	Returns the index for the validation set.
String	globalInfo()	Returns a string describing the object.
String	negativeTipText()	Returns the tip text for this property.
void	setNegative(Index value)	Sets the index for the negative set.
void	setTest(Index value)	Sets the index for the test set.
void	setTrain(Index value)	Sets the index for the training set.
void	setValidation(Index value)	Sets the index for the validation set.
String	testTipText()	Returns the tip text for this property.
String	trainTipText()	Returns the tip text for this property.
String	validationTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.preparefilebaseddataset.AbstractFileBasedDatasetPreparation

prepare

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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Train

protected Index m_Train

the index for the training set.

m_Test

protected Index m_Test

the index for the test set.

m_Validation

protected Index m_Validation

the index for the validation set.

m_Negative

protected Index m_Negative

the index for the negative set.

Constructor Detail

Selected

public Selected()

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

setTrain

public void setTrain(Index value)

Sets the index for the training set.

Parameters:

value - the index

getTrain

public Index getTrain()

Returns the index for the training set.

Returns:

the index

trainTipText

public String trainTipText()

Returns the tip text for this property.

Returns:

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

setTest

public void setTest(Index value)

Sets the index for the test set.

Parameters:

value - the index

getTest

public Index getTest()

Returns the index for the test set.

Returns:

the index

testTipText

public String testTipText()

Returns the tip text for this property.

Returns:

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

setValidation

public void setValidation(Index value)

Sets the index for the validation set.

Parameters:

value - the index

getValidation

public Index getValidation()

Returns the index for the validation set.

Returns:

the index

validationTipText

public String validationTipText()

Returns the tip text for this property.

Returns:

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

setNegative

public void setNegative(Index value)

Sets the index for the negative set.

Parameters:

value - the index

getNegative

public Index getNegative()

Returns the index for the negative set.

Returns:

the index

negativeTipText

public String negativeTipText()

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 AbstractFileBasedDatasetPreparation<String[][]>

Returns:

null if no info available, otherwise short string

accepts

public Class accepts()

Returns the class that the preparation scheme accepts as input.

Specified by:

accepts in class AbstractFileBasedDatasetPreparation<String[][]>

Returns:

the class

check

protected String check(String[][] data)

Hook method for checking the data.

Overrides:

check in class AbstractFileBasedDatasetPreparation<String[][]>

Parameters:

data - the data to check

Returns:

null if succesful, otherwise error message

doPrepare

protected List<FileBasedDatasetContainer> doPrepare(String[][] data)

Prepares the data.

Specified by:

doPrepare in class AbstractFileBasedDatasetPreparation<String[][]>

Parameters:

data - the data to use

Returns:

the generated container