magpie.data.utilities.modifiers

Class AddPropertyModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.AddPropertyModifier

All Implemented Interfaces:

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

public class AddPropertyModifier
extends BaseDatasetModifier

Adds properties to a MultiPropertyDataset.

Usage: <properties to add...>
properties: List of properties to add to dataset

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddPropertyModifier()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getPropertiesToAdd() Retrieve list of properties that would be added to a dataset.
protected void	modifyDataset(Dataset Data) Apply changes to the Dataset.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setPropertiesToAdd(java.util.List<java.lang.String> ToAdd) Define list of properties to add to a dataset.

Methods inherited from class magpie.data.utilities.modifiers.BaseDatasetModifier

transform

Methods inherited from class java.lang.Object

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

Constructor Detail

AddPropertyModifier

public AddPropertyModifier()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setPropertiesToAdd

public void setPropertiesToAdd(java.util.List<java.lang.String> ToAdd)

Define list of properties to add to a dataset.

Parameters:

ToAdd - List of property names

getPropertiesToAdd

public java.util.List<java.lang.String> getPropertiesToAdd()

Retrieve list of properties that would be added to a dataset.

Returns:

List of property names

modifyDataset

protected void modifyDataset(Dataset Data)

Description copied from class: BaseDatasetModifier

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

Specified by:

modifyDataset in class BaseDatasetModifier

Parameters:

Data - Dataset to be modified