magpie.data.utilities.modifiers

Class SetPropertyValueModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.SetPropertyValueModifier

All Implemented Interfaces:

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

public class SetPropertyValueModifier
extends BaseDatasetModifier

Set the value of a certain property of each entry. Sets both the measured and predicted value for that property.

Usage: <name> <value>
name: Name of property to be set
value: Value to be set for all entries

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	PropertyName Name of property to be set
protected java.lang.String	PropertyValue Value to set for property.

Constructor Summary

Constructors

Constructor and Description
SetPropertyValueModifier()

Method Summary

Modifier and Type	Method and Description
protected void	modifyDataset(Dataset dataPtr) 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	setPropertyValue(java.lang.String name, double value) Set the name and value of property to be set
void	setPropertyValue(java.lang.String name, java.lang.String value) Set the name and value of property to be set

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

Field Detail

PropertyName

protected java.lang.String PropertyName

Name of property to be set

PropertyValue

protected java.lang.String PropertyValue

Value to set for property. Can be numeric or name of a class, will be stored as a string either way

Constructor Detail

SetPropertyValueModifier

public SetPropertyValueModifier()

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

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Set the name and value of property to be set

Parameters:

name - Name of property

value - Value of property. Can be a number, or the name of a class

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             double value)

Set the name and value of property to be set

Parameters:

name - Name of property

value - Value of property

modifyDataset

protected void modifyDataset(Dataset dataPtr)

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:

dataPtr - Dataset to be modified