org.protempa

Class SimpleGapFunction

java.lang.Object

org.protempa.GapFunction

org.protempa.SimpleGapFunction

All Implemented Interfaces:

Serializable

public final class SimpleGapFunction
extends GapFunction

Implements a gap function with a simple max range: if one interval is before the second and the distance between them is less than or equal to the supplied maximum gap, then the function returns true, otherwise it returns false.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyChangeSupport	changes

Fields inherited from class org.protempa.GapFunction

DEFAULT

Constructor Summary

Constructors

Constructor and Description
SimpleGapFunction() Instantiates an instance with the default maximum gap and units.
SimpleGapFunction(Integer maximumGap, Unit maximumGapUnit) Initializes a gap function with a maximum gap and units.

Method Summary

Modifier and Type	Method and Description
boolean	execute(Interval lhs, Interval rhs) Executes the gap function.
Integer	getMaximumGap() Returns the gap function's maximum gap value.
Unit	getMaximumGapUnit() Returns the units of the maximum gap value.
void	setMaximumGap(Integer maximumGap) Sets the the gap function's maximum gap value.
void	setMaximumGapUnit(Unit unit) Sets the maximum gap value's units.
String	toString()

Methods inherited from class org.protempa.GapFunction

execute

Methods inherited from class java.lang.Object

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

Field Detail

changes

protected final PropertyChangeSupport changes

Constructor Detail

SimpleGapFunction

public SimpleGapFunction()

Instantiates an instance with the default maximum gap and units. The default maximum gap value is null, which means any gap will cause the gap function to return true. The default units is null, the meaning of which is defined by the Granularity of the data.

SimpleGapFunction

public SimpleGapFunction(Integer maximumGap,
                         Unit maximumGapUnit)

Initializes a gap function with a maximum gap and units.

Parameters:

maximumGap - the maximum gap Integer. Must be non-negative. If set to zero, the gap function always will return false.

maximumGapUnit - a Unit. A value of null is defined by the Granularity of the data.

Method Detail

execute

public boolean execute(Interval lhs,
                       Interval rhs)

Executes the gap function. If the first interval (lhs) is before the second (rhs) and the distance between them is less than or equal to the maximumGap, then this method returns true, otherwise it returns false.

Specified by:

execute in class GapFunction

Parameters:

lhs - the first Interval.

rhs - the second Interval.

Returns:

true or false.

getMaximumGap

public Integer getMaximumGap()

Returns the gap function's maximum gap value. The default value is null, which means any gap.

Returns:

an Integer.

getMaximumGapUnit

public Unit getMaximumGapUnit()

Returns the units of the maximum gap value. The default value is null, which means milliseconds.

Returns:

a Unit.

setMaximumGap

public void setMaximumGap(Integer maximumGap)

Sets the the gap function's maximum gap value. A value of null means any gap.

Parameters:

maximumGap - the maximum gap Integer. Must be non-negative. If set to zero, the gap function always will return false.

setMaximumGapUnit

public void setMaximumGapUnit(Unit unit)

Sets the maximum gap value's units. A value of null means milliseconds.

Parameters:

unit - a Unit value.

toString

public String toString()

Overrides:

toString in class Object