magpie.attributes.generators

Class LookupTableAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

magpie.attributes.generators.LookupTableAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Commandable, Options

public class LookupTableAttributeGenerator
extends BaseAttributeGenerator

Tool to add precomputed attributes from a lookup table. Use this if you'd like to compute attributes externally and them to a dataset.

Lookup table should follow the format:

entry attributeName1 attributeName2 [...] [string describing entry #1] [attribute 1 value] [...]

When supplied with a dataset, the dataset is first used to parse the strings describing each entry. These are then match to appropriate entries in that dataset. If no matching entry in the lookup table is found for an entry in the dataset, its attributes are set to NaN.

Usage: <path>
path: Path to lookup table

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LookupTableAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Dataset data) Generate new attributes for a dataset.
java.lang.String	printDescription(boolean htmlFormat) Print out description of attributes.
java.lang.String	printUsage() Print out required format for options.
void	readAttributeTable(java.lang.String path) Read in lookup table containing attribute names and values for selected entries.
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

Constructor Detail

LookupTableAttributeGenerator

public LookupTableAttributeGenerator()

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

readAttributeTable

public void readAttributeTable(java.lang.String path)
                        throws java.io.IOException

Read in lookup table containing attribute names and values for selected entries.

Parameters:

path - Path to lookup table

Throws:

java.io.IOException

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