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

Class CompareWithRange<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

RangeCompareBase<T>

RangeCompareFromScalars<T>

CompareWithRange<T>

Type Parameters:

T - feature-input-type

public class CompareWithRange<T extends FeatureInput>
extends RangeCompareFromScalars<T>

Compares a value with a range, returning specified constants if its inside the range, below it or above it

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
CompareWithRange()

Method Summary

Modifier and Type	Method	Description
String	describeParameters()	A human-readable description of the parameterization of the bean.
protected Feature<T>	featureToCalcInputValue()	Specifies which feature to calculate the input value.
double	getWithinValue()	Constant to return if value lies within the range
void	setWithinValue(double withinValue)	Constant to return if value lies within the range
protected double	withinRangeValue(double valWithinRange, FeatureCalculationInput<T> input)	Calculates the value to return if the input is within the range.

Methods inherited from class org.anchoranalysis.plugin.operator.feature.bean.range.RangeCompareFromScalars

boundaryMax, boundaryMin, getMax, getMin, setMax, setMin

Methods inherited from class org.anchoranalysis.plugin.operator.feature.bean.range.RangeCompareBase

calculate, getAboveMaxValue, getBelowMinValue, setAboveMaxValue, setBelowMinValue

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

getItem, inputType, 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

CompareWithRange

public CompareWithRange()

Method Details

featureToCalcInputValue

protected Feature<T> featureToCalcInputValue()

Description copied from class: RangeCompareBase

Specifies which feature to calculate the input value.

Specified by:

featureToCalcInputValue in class RangeCompareBase<T extends FeatureInput>

Returns:

the Feature used to calculate the input value

withinRangeValue

protected double withinRangeValue(double valWithinRange,
 FeatureCalculationInput<T> input)
                           throws FeatureCalculationException

Description copied from class: RangeCompareBase

Calculates the value to return if the input is within the range.

Specified by:

withinRangeValue in class RangeCompareBase<T extends FeatureInput>

Parameters:

valWithinRange - the input value that is within the range

input - the FeatureCalculationInput to use for calculation

Returns:

the calculated value

Throws:

FeatureCalculationException - if the calculation fails

describeParameters

public String describeParameters()

Description copied from class: Feature

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

Overrides:

describeParameters in class RangeCompareFromScalars<T extends FeatureInput>

Returns:

the description.

getWithinValue

public double getWithinValue()

Constant to return if value lies within the range

setWithinValue

public void setWithinValue(double withinValue)

Constant to return if value lies within the range