magpie.data.utilities.generators

Class BaseEntryGenerator

java.lang.Object

magpie.data.utilities.generators.BaseEntryGenerator

All Implemented Interfaces:

java.lang.Iterable<BaseEntry>, Options

Direct Known Subclasses:

AlloyingCompositionEntryGenerator, CombinatorialSubstitutionGenerator, CompositionRangeEntryGenerator, FixedStoichiometryCompositionEntryGenerator, GridBaseEntryGenerator, PhaseDiagramCompositionEntryGenerator, PrototypeEntryGenerator

public abstract class BaseEntryGenerator
extends java.lang.Object
implements Options, java.lang.Iterable<BaseEntry>

Base for classes that generate new entries.

How to use:

1. Define options for entry generation as desired
2. Call generateEntries() to create a list of new entries
3. Or, add them automatically to a dataset using generateEntries()

How to implement:

1. Create a class name that implies what kind of BaseEntry is generated
2. Define class variables that hold any user options
3. Create operations that allow the user to set those options
4. Implement the Options interface
5. Implement the generateEntries() command, which should take whatever settings the user defined into account

Constructor Summary

Constructors

Constructor and Description
BaseEntryGenerator()

Method Summary

Modifier and Type	Method and Description
void	addEntriesToDataset(Dataset data) Generate entries, and add them new a dataset.
java.util.List<BaseEntry>	generateEntries() Generate a list of new entries according to the currently-defined settings.
void	train(Dataset dataset) Define any settings based on a dataset

Methods inherited from class java.lang.Object

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

Methods inherited from interface magpie.utility.interfaces.Options

printUsage, setOptions

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

BaseEntryGenerator

public BaseEntryGenerator()

Method Detail

generateEntries

public final java.util.List<BaseEntry> generateEntries()

Generate a list of new entries according to the currently-defined settings.

Returns:

List of entries

train

public void train(Dataset dataset)

Define any settings based on a dataset

Parameters:

dataset - Dataset used to define entries

addEntriesToDataset

public void addEntriesToDataset(Dataset data)

Generate entries, and add them new a dataset. Takes care of tedious things like adding the appropriate number of properties.

Parameters:

data - Dataset to which to add entries