Package adams.flow.transformer.indexedsplitsrunsgenerator

Class AbstractInstancesIndexedSplitsRunsGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

adams.flow.transformer.indexedsplitsrunsgenerator.AbstractInstancesIndexedSplitsRunsGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, FlowContextHandler, IndexedSplitsRunsGenerator, InstancesIndexedSplitsRunsGenerator, Serializable

Direct Known Subclasses:

InstancesCrossValidationFoldGenerator, InstancesGroupedCrossValidationFoldGenerator, InstancesGroupedRandomSplitGenerator, InstancesRandomSplitGenerator

public abstract class AbstractInstancesIndexedSplitsRunsGenerator
extends AbstractIndexedSplitsRunsGenerator
implements InstancesIndexedSplitsRunsGenerator

Ancestor for generators that process Instances objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AddAttributeInformation	whether to added attribute information to the meta-data as well.
protected boolean	m_AddDatasetInformation	whether to added basic dataset information to the meta-data as well.

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

Fields inherited from interface adams.flow.transformer.indexedsplitsrunsgenerator.InstancesIndexedSplitsRunsGenerator

DATASET_NAME, DATASET_NUMATTRIBUTES, DATASET_NUMINSTANCES, PREFIX_DATASET_ATTRIBUTE, SUFFIX_NAME, SUFFIX_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractInstancesIndexedSplitsRunsGenerator()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of classes that are accepted as input.
String	addAttributeInformationTipText()	Returns the tip text for this property.
String	addDatasetInformationTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
boolean	getAddAttributeInformation()	Returns whether to add attribute information to the metadata.
boolean	getAddDatasetInformation()	Returns whether to add dataset information to the metadata.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
protected IndexedSplitsRuns	postGenerate(Object data, IndexedSplitsRuns runs, MessageCollection errors)	For post-processing successfully generated splits.
void	setAddAttributeInformation(boolean value)	Sets whether to add attribute information to the metadata.
void	setAddDatasetInformation(boolean value)	Sets whether to add dataset information to the metadata.

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_AddDatasetInformation

protected boolean m_AddDatasetInformation

whether to added basic dataset information to the meta-data as well.

m_AddAttributeInformation

protected boolean m_AddAttributeInformation

whether to added attribute information to the meta-data as well.

Constructor Detail

AbstractInstancesIndexedSplitsRunsGenerator

public AbstractInstancesIndexedSplitsRunsGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractIndexedSplitsRunsGenerator

setAddDatasetInformation

public void setAddDatasetInformation(boolean value)

Sets whether to add dataset information to the metadata.

Parameters:

value - true if to add

getAddDatasetInformation

public boolean getAddDatasetInformation()

Returns whether to add dataset information to the metadata.

Returns:

true if to add

addDatasetInformationTipText

public String addDatasetInformationTipText()

Returns the tip text for this property.

Returns:

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

setAddAttributeInformation

public void setAddAttributeInformation(boolean value)

Sets whether to add attribute information to the metadata.

Parameters:

value - true if to add

getAddAttributeInformation

public boolean getAddAttributeInformation()

Returns whether to add attribute information to the metadata.

Returns:

true if to add

addAttributeInformationTipText

public String addAttributeInformationTipText()

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 actor, which will 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

accepts

public Class[] accepts()

Returns the type of classes that are accepted as input.

Specified by:

accepts in interface IndexedSplitsRunsGenerator

Specified by:

accepts in class AbstractIndexedSplitsRunsGenerator

Returns:

the classes

postGenerate

protected IndexedSplitsRuns postGenerate(Object data,
                                         IndexedSplitsRuns runs,
                                         MessageCollection errors)

For post-processing successfully generated splits.

Overrides:

postGenerate in class AbstractIndexedSplitsRunsGenerator

Parameters:

data - the input data

runs - the generated runs

errors - for storing errors

Returns:

the runs, null if failed to post-process