Package org.anchoranalysis.plugin.operator.feature.bean

Class FromDictionary<T extends FeatureInputDictionary>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureGeneric<T>

FromDictionary<T>

Type Parameters:

T - feature-input type

public class FromDictionary<T extends FeatureInputDictionary>
extends FeatureGeneric<T>

Extracts a key-value from a Dictionary as a double.

Note the key has an optional prefix and suffix, so that the actual key used is ${keyPrefix}${key}${keySuffix}

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FromDictionary()

Method Summary

Modifier and Type	Method	Description
protected void	beforeCalc(FeatureInitialization initialization)	Dummy method, that children can optionally override.
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
void	checkMisconfigured(BeanInstanceMap defaultInstances)	Checks that a bean's properties conform to expectations.
String	getKey()
String	getKeyPrefix()	Prefix prepended to key
String	getKeySuffix()
void	setKey(String key)
void	setKeyPrefix(String keyPrefix)	Prefix prepended to key
void	setKeySuffix(String keySuffix)

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

inputType

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

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

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

FromDictionary

public FromDictionary()

Method Details

checkMisconfigured

public void checkMisconfigured(BeanInstanceMap defaultInstances)
                        throws BeanMisconfiguredException

Description copied from class: AnchorBean

Checks that a bean's properties conform to expectations.

Overrides:

checkMisconfigured in class AnchorBean<Feature<T extends FeatureInputDictionary>>

Parameters:

defaultInstances - all available default instances if the DefaultInstance annotation is used

Throws:

BeanMisconfiguredException - if the bean has not been configured properly as XML

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 FeatureInputDictionary>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

beforeCalc

protected void beforeCalc(FeatureInitialization initialization)
                   throws InitializeException

Description copied from class: Feature

Dummy method, that children can optionally override.

Overrides:

beforeCalc in class Feature<T extends FeatureInputDictionary>

Parameters:

initialization - initialization parameters.

Throws:

InitializeException - if initialization cannot complete successfully.

getKeyPrefix

public String getKeyPrefix()

Prefix prepended to key

setKeyPrefix

public void setKeyPrefix(String keyPrefix)

Prefix prepended to key

getKey

public String getKey()

setKey

public void setKey(String key)

getKeySuffix

public String getKeySuffix()

setKeySuffix

public void setKeySuffix(String keySuffix)