Package org.anchoranalysis.feature.session

Class SequentialSession<T extends FeatureInput>

Object

SequentialSession<T>

Type Parameters:

T - input-type for feature

All Implemented Interfaces:

FeatureCalculatorMulti<T>

public class SequentialSession<T extends FeatureInput>
extends Object
implements FeatureCalculatorMulti<T>

Calculates features with successively different inputs, without caching any results from one input to the next.

i.e. caching is applied only within each call to calculate(FeatureInput) not but among successive calls.

All feature use the same initialization, but successively different {#FeatureCalculation} sequentially.

Author:

Owen Feehan

Method Summary

Modifier and Type	Method	Description
ResultsVector	calculate(T input)	Calculate the results of the features with a particular input.
ResultsVector	calculate(T input, FeatureList<T> featuresSubset)	Calculates the results of a subset of the features with a particular input.
ResultsVector	calculateSuppressErrors(T input, ErrorReporter errorReporter)	Calculates the results for the next input in the session, reporting any exceptions into an ErrorReporter.
int	sizeFeatures()	The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.
void	start(FeatureInitialization initialization, SharedFeatures sharedFeatures, Logger logger)	Starts the session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.feature.calculate.bound.FeatureCalculatorMulti

calculate

Method Details

start

public void start(FeatureInitialization initialization,
 SharedFeatures sharedFeatures,
 Logger logger)
           throws InitializeException

Starts the session.

Parameters:

initialization - the parameters used to initialize the feature.

sharedFeatures - features that can be referenced by all the features being calculated in the session. They are also initialized by this session.

logger - the logger.

Throws:

InitializeException - if any initialization fails to complete successfully.

calculate

public ResultsVector calculate(T input)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculate the results of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculate

public ResultsVector calculate(T input,
 FeatureList<T> featuresSubset)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculates the results of a subset of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate.

featuresSubset - the subset of features (from those bound to the current instance) to calculate with.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculateSuppressErrors

public ResultsVector calculateSuppressErrors(T input,
 ErrorReporter errorReporter)

Calculates the results for the next input in the session, reporting any exceptions into an ErrorReporter.

Specified by:

calculateSuppressErrors in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate results for.

errorReporter - where to report errors to.

Returns:

the calculated results.

sizeFeatures

public int sizeFeatures()

Description copied from interface: FeatureCalculatorMulti

The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.

Specified by:

sizeFeatures in interface FeatureCalculatorMulti<T extends FeatureInput>

Returns:

the number of features.