magpie.attributes.generators

Class PropertyAsAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

magpie.attributes.generators.PropertyAsAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Commandable, Options

public class PropertyAsAttributeGenerator
extends BaseAttributeGenerator

Use measured property of entry as an attribute. Requires dataset to extend MultiPropertyDataset.

Entries in dataset must contain a measurement for this property, otherwise they are assigned Double.NaN as the attribute value. If the dataset does not contain the property as any of the options, addAttributes(magpie.data.Dataset) will throw an exception.

Usage: <properties...>
properties: List of properties to use as attributes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	Properties List of properties to use as attributes.

Constructor Summary

Constructors

Constructor and Description
PropertyAsAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Dataset data) Generate new attributes for a dataset.
void	addProperty(java.lang.String prop) Add property to list of properties used as attributes.
void	clearProperties() Clear the list of properties being used as attributes.
java.lang.String	printDescription(boolean htmlFormat) Print out description of attributes.
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.

Methods inherited from class magpie.attributes.generators.BaseAttributeGenerator

runCommand

Methods inherited from class java.lang.Object

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

Field Detail

Properties

protected java.util.Set<java.lang.String> Properties

List of properties to use as attributes.

Constructor Detail

PropertyAsAttributeGenerator

public PropertyAsAttributeGenerator()

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

clearProperties

public void clearProperties()

Clear the list of properties being used as attributes.

addProperty

public void addProperty(java.lang.String prop)

Add property to list of properties used as attributes.

Parameters:

prop - Property to use as attributes

addAttributes

public void addAttributes(Dataset data)
                   throws java.lang.Exception

Description copied from class: BaseAttributeGenerator

Generate new attributes for a dataset. This operation must both add the new attribute names to the dataset and new values to each entry.

Specified by:

addAttributes in class BaseAttributeGenerator

Parameters:

data - Dataset to be added to

Throws:

java.lang.Exception

See Also:

Dataset.addAttribute(java.lang.String, double[])

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from class: BaseAttributeGenerator

Print out description of attributes.

Implementation Notes

Format should look like

[Full Name of generator]: (Number of attributes) Text description of what these attributes are

For HTML format, omit the ":".

Specified by:

printDescription in class BaseAttributeGenerator

Parameters:

htmlFormat - Whether to print in HTML format

Returns:

Description of the attributes