Package org.anchoranalysis.feature.session

Class SessionInputSequential<T extends FeatureInput>

Object

SessionInputSequential<T>

Type Parameters:

T - feature-type

All Implemented Interfaces:

FeatureCalculationInput<T>

public class SessionInputSequential<T extends FeatureInput>
extends Object
implements FeatureCalculationInput<T>

A feature-input that will be used in a SequentialSession

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
SessionInputSequential(T input, CacheCreator cacheCreator)	Creates for a particular input and CacheCreator, otherwise using defaults.
SessionInputSequential(T input, CacheCreator cacheCreator, ChildCacheFinder findChild)	Creates for a particular input, CacheCreator and ChildCacheFinder.

Method Summary

Modifier and Type	Method	Description
FeatureSymbolCalculator<T>	bySymbol()	Calculates a feature if only an symbol (ID/name) is known, which refers to another feature.
double	calculate(Feature<T> feature)	Calculates the result of a feature using this input.
ResultsVector	calculate(FeatureList<T> features)	Calculates the results of several features using this input.
<S> S	calculate(ResolvedPart<S,T> calculation)	Calculates a resolved Feature-calculation.
<S> S	calculate(CalculationPart<S,T> cc)	Calculates a feature-calculation after resolving it against the main cache.
CalculateForChild<T>	forChild()	Performs calculations not on the main cache, but on a child cache.
T	get()	The underlying feature-input.
FeatureCalculationCache<T>	getCache()	Get the associated FeatureCalculationCache.
void	replaceInput(T input)	Replaces existing input with new input
CalculationPartResolver<T>	resolver()	A resolver for calculations.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionInputSequential

public SessionInputSequential(T input,
 CacheCreator cacheCreator)

Creates for a particular input and CacheCreator, otherwise using defaults.

Parameters:

input - input for feature calculation.

cacheCreator - creates a cache.

SessionInputSequential

public SessionInputSequential(T input,
 CacheCreator cacheCreator,
 ChildCacheFinder findChild)

Creates for a particular input, CacheCreator and ChildCacheFinder.

Parameters:

input - input for feature calculation.

cacheCreator - creates a cache.

findChild - locates a particular child-cache.

Method Details

replaceInput

public void replaceInput(T input)

Replaces existing input with new input

Parameters:

input - new parameters which will replace existing ones

get

public T get()

Description copied from interface: FeatureCalculationInput

The underlying feature-input.

Specified by:

get in interface FeatureCalculationInput<T extends FeatureInput>

Returns:

the feature-input.

calculate

public double calculate(Feature<T> feature)
                 throws FeatureCalculationException

Description copied from interface: FeatureCalculationInput

Calculates the result of a feature using this input.

Specified by:

calculate in interface FeatureCalculationInput<T extends FeatureInput>

Parameters:

feature - the feature to calculate with.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if a feature cannot be successfully calculated.

calculate

public ResultsVector calculate(FeatureList<T> features)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculationInput

Calculates the results of several features using this input.

Specified by:

calculate in interface FeatureCalculationInput<T extends FeatureInput>

Parameters:

features - features to calculate with.

Returns:

the results of each feature's calculation respectively.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculate

public <S> S calculate(CalculationPart<S,T> cc)
                throws FeatureCalculationException

Description copied from interface: FeatureCalculationInput

Calculates a feature-calculation after resolving it against the main cache.

Specified by:

calculate in interface FeatureCalculationInput<T extends FeatureInput>

Type Parameters:

S - return-type of the calculation.

Parameters:

cc - the feature-calculation to resolve.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if a feature cannot be successfully calculated.

calculate

public <S> S calculate(ResolvedPart<S,T> calculation)
                throws FeatureCalculationException

Description copied from interface: FeatureCalculationInput

Calculates a resolved Feature-calculation.

Specified by:

calculate in interface FeatureCalculationInput<T extends FeatureInput>

Type Parameters:

S - return-type of the calculation.

Parameters:

calculation - the feature-calculation to resolve.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if a feature cannot be successfully calculated.

resolver

public CalculationPartResolver<T> resolver()

Description copied from interface: FeatureCalculationInput

A resolver for calculations.

Specified by:

resolver in interface FeatureCalculationInput<T extends FeatureInput>

Returns:

the resolver.

bySymbol

public FeatureSymbolCalculator<T> bySymbol()

Description copied from interface: FeatureCalculationInput

Calculates a feature if only an symbol (ID/name) is known, which refers to another feature.

Specified by:

bySymbol in interface FeatureCalculationInput<T extends FeatureInput>

Returns:

the calculator.

forChild

public CalculateForChild<T> forChild()

Description copied from interface: FeatureCalculationInput

Performs calculations not on the main cache, but on a child cache.

Specified by:

forChild in interface FeatureCalculationInput<T extends FeatureInput>

Returns:

the calculator.

getCache

public FeatureCalculationCache<T> getCache()

Description copied from interface: FeatureCalculationInput

Get the associated FeatureCalculationCache.

Specified by:

getCache in interface FeatureCalculationInput<T extends FeatureInput>

Returns:

the associated cache.