org.protempa

Class GapFunction

java.lang.Object

org.protempa.GapFunction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MinMaxGapFunction, SimpleGapFunction

public abstract class GapFunction
extends Object
implements Serializable

A convenience class for implementing gap functions. In PROTEMPA, gap functions describe whether information inferred or data recorded during two separate intervals should also be true during the gap between the two intervals. If a pair of intervals of the same type satisfy the gap function, PROTEMPA replaces them with a single interval that spans the two original intervals and the gap between them. To implement a gap function, override execute(org.protempa.proposition.interval.Interval, org.protempa.proposition.interval.Interval) with the implementation of your function. Gap functions only apply to AbstractParameter propositions. A default concrete implementation is provided, SimpleGapFunction, an instance of which is assigned to the static variable DEFAULT.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static GapFunction	DEFAULT

Constructor Summary

Constructors

Constructor and Description
GapFunction()

Method Summary

Modifier and Type	Method and Description
abstract boolean	execute(Interval lhs, Interval rhs) Returns whether two intervals have a gap that satisfies the constraints of the gap function.
boolean	execute(TemporalProposition lhs, TemporalProposition rhs) Returns whether two abstract parameters have a gap that satisfies the constraints of the gap function.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final GapFunction DEFAULT

Constructor Detail

GapFunction

public GapFunction()

Method Detail

execute

public final boolean execute(TemporalProposition lhs,
                             TemporalProposition rhs)

Returns whether two abstract parameters have a gap that satisfies the constraints of the gap function. If either provided parameter is null, this method returns false.

Parameters:

lhs - the first AbstractParameter.

rhs - the second AbstractParameter.

Returns:

true or false.

execute

public abstract boolean execute(Interval lhs,
                                Interval rhs)

Returns whether two intervals have a gap that satisfies the constraints of the gap function. To be overridden by the actual implementation of the gap function.

Parameters:

lhs - the first Interval.

rhs - the second Interval.

Returns:

true or false.