magpie.attributes.generators

Class BaseAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Commandable, Options

Direct Known Subclasses:

APEAttributeGenerator, APRDFAttributeGenerator, ChargeDependentAttributeGenerator, ChemicalOrderingAttributeGenerator, CoordinationNumberAttributeGenerator, CoulombMatrixAttributeGenerator, EffectiveCoordinationNumberAttributeGenerator, ElementalPropertyAttributeGenerator, ElementalPropertyAttributeGenerator, ElementFractionAttributeGenerator, ElementPairPropertyAttributeGenerator, GCLPAttributeGenerator, IonicCompoundProximityAttributeGenerator, IonicityAttributeGenerator, LatticeSimilarityAttributeGenerator, LocalPropertyDifferenceAttributeGenerator, LookupTableAttributeGenerator, MeredigAttributeGenerator, ModelPredictionAttributeGenerator, PackingEfficiencyAttributeGenerator, PRDFAttributeGenerator, PropertyAsAttributeGenerator, SingleSiteAttributeGenerator, StoichiometricAttributeGenerator, StructuralHeterogeneityAttributeGenerator, ValenceShellAttributeGenerator, YangOmegaAttributeGenerator

public abstract class BaseAttributeGenerator
extends java.lang.Object
implements java.io.Serializable, Options, Commandable

Base class for objects that generate attributes. These attributes are designed to be in addition to what is already generated by default.

Available Commands

run $<data> - Run attribute generator on a dataset

data - Dataset dataset to be run

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
abstract void	addAttributes(Dataset data) Generate new attributes for a dataset.
abstract java.lang.String	printDescription(boolean htmlFormat) Print out description of attributes.
java.lang.Object	runCommand(java.util.List<java.lang.Object> command) Process some command described by a list of Objects.

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

BaseAttributeGenerator

public BaseAttributeGenerator()

Method Detail

addAttributes

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

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

Parameters:

data - Dataset to be added to

Throws:

java.lang.Exception

See Also:

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

printDescription

public abstract java.lang.String printDescription(boolean htmlFormat)

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 ":".

Parameters:

htmlFormat - Whether to print in HTML format

Returns:

Description of the attributes

runCommand

public java.lang.Object runCommand(java.util.List<java.lang.Object> command)
                            throws java.lang.Exception

Description copied from interface: Commandable

Process some command described by a list of Objects.

Specified by:

runCommand in interface Commandable

Parameters:

command - Command as a list of objects

Returns:

Any output (null if no output generated by command)

Throws:

java.lang.Exception - If something goes wrong