uk.gov.gchq.koryphe.impl.predicate.range

Class AbstractInTimeRangeDual<T extends Comparable<T>>

java.lang.Object

uk.gov.gchq.koryphe.predicate.KoryphePredicate<TUPLE>

uk.gov.gchq.koryphe.tuple.predicate.KoryphePredicateN<Tuple2<T,U>>

uk.gov.gchq.koryphe.tuple.predicate.KoryphePredicate2<Comparable<T>,Comparable<T>>

uk.gov.gchq.koryphe.impl.predicate.range.AbstractInTimeRangeDual<T>

All Implemented Interfaces:

Predicate<Tuple2<Comparable<T>,Comparable<T>>>

Direct Known Subclasses:

InDateRangeDual, InTimeRangeDual

public abstract class AbstractInTimeRangeDual<T extends Comparable<T>>
extends KoryphePredicate2<Comparable<T>,Comparable<T>>

An AbstractInTimeRangeDual is a Predicate that tests if a start Comparable and end Comparable is within a provided range [start, end]. Specifically the start Comparable has to be greater than the start bound and the end Comparable has to be less than the end bound. By default the range is inclusive, you can toggle this using the startInclusive and endInclusive booleans.

If the start is not set then this will be treated as unbounded. Similarly with the end.

If the test value is null then the predicate will return false.

This range predicate takes 2 values to test, if you want to test a single value lies within a range then you can use the AbstractInTimeRange predicate.

The range can also be configured using time offsets from the current system time or a provided start/end time. You can set the start and end offsets using startOffset and endOffset. By default the offset is measured in Days, this can be changed to DAY, HOUR, MINUTE, SECOND, MILLISECOND and MICROSECOND using the offsetUnit field.

At the point when test is called on the class the current system time is used to calculate the start and end values based on: System.currentTimeMillis() + offset.

By default checks are carried out assuming the data will be in milliseconds. If this is not the case you can change the time unit using the timeUnit property.

You can configure the start and end time strings using one of the following formats:

• timestamp in milliseconds
• yyyy/MM
• yyyy/MM/dd
• yyyy/MM/dd HH
• yyyy/MM/dd HH:mm
• yyyy/MM/dd HH:mm:ss

You can use a space, '-', '/', '_', ':', '|', or '.' to separate the parts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractInTimeRangeDual.BaseBuilder<B extends AbstractInTimeRangeDual.BaseBuilder<B,R,T>,R extends AbstractInTimeRangeDual<T>,T extends Comparable<T>>

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEnd()
Long	getEndOffset()
TimeUnit	getOffsetUnit()
String	getStart()
Long	getStartOffset()
TimeUnit	getTimeUnit()
TimeZone	getTimeZone()
String	getTimeZoneId()
int	hashCode()
void	initialise()
Boolean	isEndFullyContained()
Boolean	isEndInclusive()
Boolean	isStartFullyContained()
Boolean	isStartInclusive()
boolean	test(Comparable<T> startValue, Comparable<T> endValue)
String	toString()

Methods inherited from class uk.gov.gchq.koryphe.tuple.predicate.KoryphePredicateN

test

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Method Detail

initialise

public void initialise()

test

public boolean test(Comparable<T> startValue,
                    Comparable<T> endValue)

Specified by:

test in class KoryphePredicate2<Comparable<T extends Comparable<T>>,Comparable<T extends Comparable<T>>>

equals

public boolean equals(Object obj)

Overrides:

equals in class KoryphePredicate<Tuple2<Comparable<T extends Comparable<T>>,Comparable<T extends Comparable<T>>>>

hashCode

public int hashCode()

Overrides:

hashCode in class KoryphePredicate<Tuple2<Comparable<T extends Comparable<T>>,Comparable<T extends Comparable<T>>>>

toString

public String toString()

Overrides:

toString in class Object

getStartOffset

public Long getStartOffset()

getStart

public String getStart()

isStartInclusive

public Boolean isStartInclusive()

isStartFullyContained

public Boolean isStartFullyContained()

getEnd

public String getEnd()

getEndOffset

public Long getEndOffset()

isEndInclusive

public Boolean isEndInclusive()

isEndFullyContained

public Boolean isEndFullyContained()

getOffsetUnit

public TimeUnit getOffsetUnit()

getTimeUnit

public TimeUnit getTimeUnit()

getTimeZone

public TimeZone getTimeZone()

getTimeZoneId

public String getTimeZoneId()