Package org.anchoranalysis.mpp.feature.bean.energy.element

Class AsSingle

Object

AnchorBean<Feature<FeatureInputPairMemo>>

InitializableBean<Feature<FeatureInputPairMemo>,FeatureInitialization>

Feature<FeatureInputPairMemo>

FeatureUnary<FeatureInputPairMemo,FeatureInputSingleMemo>

AsSingle

public class AsSingle
extends FeatureUnary<FeatureInputPairMemo,FeatureInputSingleMemo>

Extracts one of the memos from the pair, and processes as a FeatureSingleMemo

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
AsSingle()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputPairMemo> input)	Calculates a value for some input.
String	describeParameters()	A human-readable description of the parameterization of the bean.
Class<? extends FeatureInput>	inputType()	The class corresponding to feature input-type.
boolean	isFirst()	Iff true, first object is used, otherwise the second
void	setFirst(boolean first)	Iff true, first object is used, otherwise the second

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

getItem, setItem

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

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, descriptionLong, 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

AsSingle

public AsSingle()

Method Details

calculate

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

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputPairMemo>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

inputType

public Class<? extends FeatureInput> inputType()

Description copied from class: Feature

The class corresponding to feature input-type.

i.e. corresponding to the T template parameter.

Overrides:

inputType in class FeatureUnary<FeatureInputPairMemo,FeatureInputSingleMemo>

Returns:

the class.

describeParameters

public String describeParameters()

Description copied from class: Feature

A human-readable description of the parameterization of the bean.

Overrides:

describeParameters in class Feature<FeatureInputPairMemo>

Returns:

the description.

isFirst

public boolean isFirst()

Iff true, first object is used, otherwise the second

setFirst

public void setFirst(boolean first)

Iff true, first object is used, otherwise the second