co.cask.cdap.data.stream

Class TimeRangeReadFilter

java.lang.Object

co.cask.cdap.data.file.ReadFilter

co.cask.cdap.data.stream.TimeRangeReadFilter

public final class TimeRangeReadFilter
extends ReadFilter

A ReadFilter for accepting events that are within a given time range.

Field Summary

Fields inherited from class co.cask.cdap.data.file.ReadFilter

ALWAYS_ACCEPT, ALWAYS_REJECT_OFFSET

Constructor Summary

Constructors

Constructor and Description
TimeRangeReadFilter(long startTime, long endTime) Creates a TimeRangeReadFilter with the specific time range.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptTimestamp(long timestamp) Accept or reject based on event timestamp.
long	getNextTimestampHint() If the ReadFilter.acceptTimestamp(long) returns false, the filter can provide a hint for the next timestamp the reader should start reading from.
boolean	isActive() Returns true if this filter has been called at least once after the prior call to reset().
void	reset() Invoked before filtering a new data block.

Methods inherited from class co.cask.cdap.data.file.ReadFilter

acceptOffset

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeRangeReadFilter

public TimeRangeReadFilter(long startTime,
                   long endTime)

Creates a TimeRangeReadFilter with the specific time range.

Parameters:

startTime - start timestamp for event to be accepted (inclusive)

endTime - end timestamp for event to be accepted (exclusive)

Method Detail

reset

public void reset()

Description copied from class: ReadFilter

Invoked before filtering a new data block.

Overrides:

reset in class ReadFilter

getNextTimestampHint

public long getNextTimestampHint()

Description copied from class: ReadFilter

If the ReadFilter.acceptTimestamp(long) returns false, the filter can provide a hint for the next timestamp the reader should start reading from.

Overrides:

getNextTimestampHint in class ReadFilter

Returns:

the timestamp for the next event should be or a negative value if no hint is provided.

acceptTimestamp

public boolean acceptTimestamp(long timestamp)

Description copied from class: ReadFilter

Accept or reject based on event timestamp.

Overrides:

acceptTimestamp in class ReadFilter

Parameters:

timestamp - The timestamp of the event.

Returns:

true to accept, false to reject.

isActive

public boolean isActive()

Returns true if this filter has been called at least once after the prior call to reset().