co.cask.cdap.data.file.filter

Class TTLReadFilter

java.lang.Object

co.cask.cdap.data.file.ReadFilter

co.cask.cdap.data.file.filter.TTLReadFilter

public class TTLReadFilter
extends ReadFilter

ReadFilter for filtering expired stream events according to TTL and current time.

Field Summary

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

ALWAYS_ACCEPT, ALWAYS_REJECT_OFFSET

Constructor Summary

Constructors

Constructor and Description
TTLReadFilter(long ttl)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptTimestamp(long timestamp) Accept or reject based on event timestamp.
protected long	getCurrentTime()
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.
long	getTTL()
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

TTLReadFilter

public TTLReadFilter(long ttl)

Method Detail

getTTL

public final long getTTL()

reset

public void reset()

Description copied from class: ReadFilter

Invoked before filtering a new data block.

Overrides:

reset in class ReadFilter

acceptTimestamp

public final 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.

getNextTimestampHint

public final 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.

getCurrentTime

protected long getCurrentTime()