magpie.data.utilities.modifiers

Class BaseDatasetModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Options

Direct Known Subclasses:

AddPropertyModifier, BaseDuplicateResolver, ClassEliminationModifier, ClassIntervalModifier, CompositionSetDistanceModifier, DiscreteToContinuousModifier, ErrorSignalModifier, HHICalculationModifier, NaNToMeanModifier, NonZeroClassModifier, PartitionToClassModifier, SetClassNamesModifier, SetPropertyValueModifier, StabilityCalculationModifier, VolumeToLatticeParamModifier

public abstract class BaseDatasetModifier
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, Options

Perform some kind of manipulation on a Dataset, and all of the entries.

Implementations of this class must provide:

• modifyDataset(magpie.data.Dataset) - Make changes to the dataset as whole and each entry
• Object.clone() - Ensure clones of this class do not share references
• Options.setOptions(java.util.List<java.lang.Object>) and Options.printUsage() - Handle user options

Note, you may want to make special considerations for MultiPropertyDatasets if you are adjusting the class variables. See example in NonZeroClassModifier.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseDatasetModifier()

Method Summary

Modifier and Type	Method and Description
protected abstract void	modifyDataset(Dataset Data) Apply changes to the Dataset.
void	transform(Dataset Data) Apply some change to the dataset and all of its entries

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

Constructor Detail

BaseDatasetModifier

public BaseDatasetModifier()

Method Detail

transform

public void transform(Dataset Data)

Apply some change to the dataset and all of its entries

Parameters:

Data - Dataset to be modified

modifyDataset

protected abstract void modifyDataset(Dataset Data)

Apply changes to the Dataset. Should modify both each entries and the dataset as a whole.

Parameters:

Data - Dataset to be modified