org.protempa

Interface Algorithm

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAlgorithm, MinAlgorithm, StateAlgorithm, TrendAlgorithm

public interface Algorithm
extends Serializable

Interface to algorithms for processing primitive parameters.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
void	close()
Value	compute(Segment<PrimitiveParameter> segment, AlgorithmArguments arguments) Computes whether or not a temporal abstraction exists in a segment of a time series.
Filter	createDataSourceConstraint()
int	getAdvanceRowSkipEnd()
String	getId() The algorithm's unique id.
ValueType	getInValueType()
int	getMaximumNumberOfValues() Gets the default maximum sliding window width.
int	getMinimumNumberOfValues() Gets the default minimum sliding window width.
AlgorithmParameter[]	getParameters()
void	initialize(AlgorithmArguments arguments)
AlgorithmParameter	parameter(String name) Returns the named parameter.

Method Detail

getId

String getId()

The algorithm's unique id.

Returns:

an id String.

getMinimumNumberOfValues

int getMinimumNumberOfValues()

Gets the default minimum sliding window width. May be overridden by low level abstraction definitions. If negative, the algorithm will process an entire sequence at once by default up to the maximumNumberOfValues.

Returns:

an int != 0.

See Also:

org.protempa.LowLevelAbstractionValueDefinition#getMaximumNumberOfValues()

getMaximumNumberOfValues

int getMaximumNumberOfValues()

Gets the default maximum sliding window width. May be overridden by low level abstraction definitions.

Returns:

an int > 0.

See Also:

org.protempa.LowLevelAbstractionValueDefinition#getMaximumNumberOfValues()

close

void close()

getInValueType

ValueType getInValueType()

getParameters

AlgorithmParameter[] getParameters()

parameter

AlgorithmParameter parameter(String name)

Returns the named parameter.

Parameters:

name - a String.

Returns:

an AlgorithmParameter, or null if the named parameter does not exist.

createDataSourceConstraint

Filter createDataSourceConstraint()

getAdvanceRowSkipEnd

int getAdvanceRowSkipEnd()

initialize

void initialize(AlgorithmArguments arguments)
         throws AlgorithmInitializationException

Throws:

AlgorithmInitializationException

compute

Value compute(Segment<PrimitiveParameter> segment,
              AlgorithmArguments arguments)
       throws AlgorithmProcessingException

Computes whether or not a temporal abstraction exists in a segment of a time series.

Parameters:

segment - a Segment of Parameter objects.

Returns:

null if the pattern does not exist, or an algorithm-specific Value if it does.

Throws:

AlgorithmProcessingException