org.protempa

Class MinMaxGapFunction

java.lang.Object

org.protempa.GapFunction

org.protempa.MinMaxGapFunction

All Implemented Interfaces:

Serializable

public final class MinMaxGapFunction
extends GapFunction

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields inherited from class org.protempa.GapFunction

DEFAULT

Constructor Summary

Constructors

Constructor and Description
MinMaxGapFunction() Instantiates an instance with the default minimum and maximum gap and units.
MinMaxGapFunction(Integer minimumGap, Unit minimumGapUnit, Integer maximumGap, Unit maximumGapUnit)

Method Summary

Modifier and Type	Method and Description
boolean	execute(Interval lhs, Interval rhs) Returns whether two intervals have a gap that satisfies the constraints of the gap function.
Integer	getMaximumGap()
Unit	getMaximumGapUnit()
Integer	getMinimumGap()
Unit	getMinimumGapUnit()
void	setMaximumGap(Integer maximumGap)
void	setMaximumGapUnit(Unit unit)
void	setMinimumGap(Integer minimumGap)
void	setMinimumGapUnit(Unit unit)
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

Constructor Detail

MinMaxGapFunction

public MinMaxGapFunction()

Instantiates an instance with the default minimum and maximum gap and units.

MinMaxGapFunction

public MinMaxGapFunction(Integer minimumGap,
                         Unit minimumGapUnit,
                         Integer maximumGap,
                         Unit maximumGapUnit)

Method Detail

execute

public boolean execute(Interval lhs,
                       Interval rhs)

Description copied from class: GapFunction

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.

Specified by:

execute in class GapFunction

Parameters:

lhs - the first Interval.

rhs - the second Interval.

Returns:

true or false.

getMinimumGap

public Integer getMinimumGap()

getMinimumGapUnit

public Unit getMinimumGapUnit()

getMaximumGap

public Integer getMaximumGap()

getMaximumGapUnit

public Unit getMaximumGapUnit()

setMaximumGap

public void setMaximumGap(Integer maximumGap)

setMinimumGap

public void setMinimumGap(Integer minimumGap)

setMaximumGapUnit

public void setMaximumGapUnit(Unit unit)

setMinimumGapUnit

public void setMinimumGapUnit(Unit unit)

toString

public String toString()

Overrides:

toString in class Object