org.protempa

Class AbstractAlgorithm

java.lang.Object

org.protempa.AbstractAlgorithm

All Implemented Interfaces:

Serializable, Algorithm

Direct Known Subclasses:

MinAlgorithm, StateAlgorithm, TrendAlgorithm

public abstract class AbstractAlgorithm
extends Object
implements Algorithm

Provides a skeletal implementation of the Algorithm interface.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAlgorithm(Algorithms algorithms, String id)

Method Summary

Modifier and Type	Method and Description
void	close()
abstract Value	compute(Segment<PrimitiveParameter> segment, AlgorithmArguments arguments) Computes whether or not a temporal abstraction exists in a segment of a time series.
Filter	createDataSourceConstraint()
protected void	finalize()
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.
protected void	setAdvanceRowSkipEnd(int advanceRowSkipEnd)
void	setInValueType(ValueType inValueType)
void	setMaximumNumberOfValues(int val) Sets the default maximum sliding window width.
void	setMinimumNumberOfValues(int val) Sets the default minimum sliding window width.
void	setParameters(AlgorithmParameter[] parameters)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAlgorithm

public AbstractAlgorithm(Algorithms algorithms,
                         String id)

Method Detail

getId

public final String getId()

Description copied from interface: Algorithm

The algorithm's unique id.

Specified by:

getId in interface Algorithm

Returns:

an id String.

setMinimumNumberOfValues

public final void setMinimumNumberOfValues(int val)

Sets 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 maximumNumberOfValues.

Parameters:

val -

getMinimumNumberOfValues

public final int getMinimumNumberOfValues()

Description copied from interface: Algorithm

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.

Specified by:

getMinimumNumberOfValues in interface Algorithm

Returns:

an int != 0.

See Also:

org.protempa.LowLevelAbstractionValueDefinition#getMaximumNumberOfValues()

setMaximumNumberOfValues

public final void setMaximumNumberOfValues(int val)

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

Parameters:

val - an int > 0.

Throws:

IllegalArgumentException - if val is < 1.

getMaximumNumberOfValues

public final int getMaximumNumberOfValues()

Description copied from interface: Algorithm

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

Specified by:

getMaximumNumberOfValues in interface Algorithm

Returns:

an int > 0.

See Also:

org.protempa.LowLevelAbstractionValueDefinition#getMaximumNumberOfValues()

close

public void close()

Specified by:

close in interface Algorithm

finalize

protected void finalize()

Overrides:

finalize in class Object

getInValueType

public final ValueType getInValueType()

Specified by:

getInValueType in interface Algorithm

setInValueType

public final void setInValueType(ValueType inValueType)

setParameters

public void setParameters(AlgorithmParameter[] parameters)

getParameters

public AlgorithmParameter[] getParameters()

Specified by:

getParameters in interface Algorithm

parameter

public AlgorithmParameter parameter(String name)

Description copied from interface: Algorithm

Returns the named parameter.

Specified by:

parameter in interface Algorithm

Parameters:

name - a String.

Returns:

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

createDataSourceConstraint

public Filter createDataSourceConstraint()

Specified by:

createDataSourceConstraint in interface Algorithm

setAdvanceRowSkipEnd

protected void setAdvanceRowSkipEnd(int advanceRowSkipEnd)

getAdvanceRowSkipEnd

public int getAdvanceRowSkipEnd()

Specified by:

getAdvanceRowSkipEnd in interface Algorithm

toString

public String toString()

Overrides:

toString in class Object

initialize

public void initialize(AlgorithmArguments arguments)
                throws AlgorithmInitializationException

Specified by:

initialize in interface Algorithm

Throws:

AlgorithmInitializationException

compute

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

Description copied from interface: Algorithm

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

Specified by:

compute in interface Algorithm

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