Package adams.flow.container

Class FileBasedDatasetContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.FileBasedDatasetContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class FileBasedDatasetContainer
extends AbstractContainer

Container for storing file names for file-based dataset generation.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_NEGATIVE	the identifier for the negative files.
static String	VALUE_TEST	the identifier for the test files.
static String	VALUE_TRAIN	the identifier for the training files.
static String	VALUE_VALIDATION	the identifier for the validation files.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
FileBasedDatasetContainer()	Initializes the container.
FileBasedDatasetContainer(String[] train, String[] test)	Initializes the container with the specified file names.
FileBasedDatasetContainer(String[] train, String[] test, String[] validation, String[] negative)	Initializes the container with the specified file names.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_TRAIN

public static final String VALUE_TRAIN

the identifier for the training files.

See Also:

Constant Field Values

VALUE_TEST

public static final String VALUE_TEST

the identifier for the test files.

See Also:

Constant Field Values

VALUE_VALIDATION

public static final String VALUE_VALIDATION

the identifier for the validation files.

See Also:

Constant Field Values

VALUE_NEGATIVE

public static final String VALUE_NEGATIVE

the identifier for the negative files.

See Also:

Constant Field Values

Constructor Detail

FileBasedDatasetContainer

public FileBasedDatasetContainer()

Initializes the container.

FileBasedDatasetContainer

public FileBasedDatasetContainer(String[] train,
                                 String[] test)

Initializes the container with the specified file names.

Parameters:

train - the training files

test - the test files (optional)

FileBasedDatasetContainer

public FileBasedDatasetContainer(String[] train,
                                 String[] test,
                                 String[] validation,
                                 String[] negative)

Initializes the container with the specified file names.

Parameters:

train - the training files

test - the test files (optional)

validation - the validation files (optional)

negative - the negative files (optional)

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

iterator over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available