Package org.anchoranalysis.feature.bean.operator

Class Reference<T extends FeatureInput>

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<Feature<T>,FeatureInitialization>

org.anchoranalysis.feature.bean.Feature<T>

org.anchoranalysis.feature.bean.operator.FeatureGeneric<T>

org.anchoranalysis.feature.bean.operator.Reference<T>

Type Parameters:

T - the feature input-type

public class Reference<T extends FeatureInput>
extends FeatureGeneric<T>

Uses another feature to calculate the value.

The other feature is identified by it's name, or a string that otherwise resolves to its name.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
Reference()
Reference(String id)	Create with a specific identifier.

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
String	descriptionLong()	A long human-readable description of the feature and some or all of its parameterization.
String	getId()	The identifier that uniquely determines the other feature to reference.
void	setId(String id)	The identifier that uniquely determines the other feature to reference.

Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureGeneric

inputType

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

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

Constructor Details

Reference

public Reference(String id)

Create with a specific identifier.

Parameters:

id - the identifier.

Reference

public Reference()

Method Details

calculate

public double calculate(FeatureCalculationInput<T> input) throws FeatureCalculationException

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<T extends FeatureInput>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

descriptionLong

public String descriptionLong()

Description copied from class: Feature

A long human-readable description of the feature and some or all of its parameterization.

This can be overwritten to create an alternative description for features. By default string returned by Feature.describeBean() is used.

Overrides:

descriptionLong in class Feature<T extends FeatureInput>

Returns:

the description.

getId

public String getId()

The identifier that uniquely determines the other feature to reference.

setId

public void setId(String id)

The identifier that uniquely determines the other feature to reference.