Package org.apache.kafka.streams.state.internals

Class WindowKeySchema

java.lang.Object

org.apache.kafka.streams.state.internals.WindowKeySchema

All Implemented Interfaces:

SegmentedBytesStore.KeySchema

public class WindowKeySchema
extends Object
implements SegmentedBytesStore.KeySchema

Constructor Summary

Constructors

Constructor	Description
WindowKeySchema()

Method Summary

Modifier and Type	Method	Description
static <K> Windowed<K>	from(byte[] binaryKey, long windowSize, Deserializer<K> deserializer, String topic)
static Windowed<org.apache.kafka.common.utils.Bytes>	fromStoreBytesKey(byte[] binaryKey, long windowSize)
static <K> Windowed<K>	fromStoreKey(byte[] binaryKey, long windowSize, Deserializer<K> deserializer, String topic)
static <K> Windowed<K>	fromStoreKey(Windowed<org.apache.kafka.common.utils.Bytes> windowedKey, Deserializer<K> deserializer, String topic)
org.apache.kafka.streams.state.internals.HasNextCondition	hasNextCondition(org.apache.kafka.common.utils.Bytes binaryKeyFrom, org.apache.kafka.common.utils.Bytes binaryKeyTo, long from, long to)	Create an implementation of HasNextCondition that knows when to stop iterating over the KeyValueSegments.
org.apache.kafka.common.utils.Bytes	lowerRange(org.apache.kafka.common.utils.Bytes key, long from)	Given a range of record keys and a time, construct a Segmented key that represents the lower range of keys to search when performing range queries.
org.apache.kafka.common.utils.Bytes	lowerRangeFixedSize(org.apache.kafka.common.utils.Bytes key, long from)	Given a range of fixed size record keys and a time, construct a Segmented key that represents the lower range of keys to search when performing range queries.
<S extends Segment> List<S>	segmentsToSearch(org.apache.kafka.streams.state.internals.Segments<S> segments, long from, long to)	Used during SegmentedBytesStore.fetch(Bytes, long, long) operations to determine which segments should be scanned.
long	segmentTimestamp(org.apache.kafka.common.utils.Bytes key)	Extract the timestamp of the segment from the key.
static <K> byte[]	toBinary(Windowed<K> timeKey, Serializer<K> serializer, String topic)
static <K> org.apache.kafka.common.utils.Bytes	toStoreKeyBinary(K key, long timestamp, int seqnum, StateSerdes<K,?> serdes)
static org.apache.kafka.common.utils.Bytes	toStoreKeyBinary(org.apache.kafka.common.utils.Bytes key, long timestamp, int seqnum)
static <K> org.apache.kafka.common.utils.Bytes	toStoreKeyBinary(Windowed<K> timeKey, int seqnum, StateSerdes<K,?> serdes)
static org.apache.kafka.common.utils.Bytes	toStoreKeyBinary(Windowed<org.apache.kafka.common.utils.Bytes> timeKey, int seqnum)
org.apache.kafka.common.utils.Bytes	upperRange(org.apache.kafka.common.utils.Bytes key, long to)	Given a range of record keys and a time, construct a Segmented key that represents the upper range of keys to search when performing range queries.
org.apache.kafka.common.utils.Bytes	upperRangeFixedSize(org.apache.kafka.common.utils.Bytes key, long to)	Given a range of fixed size record keys and a time, construct a Segmented key that represents the upper range of keys to search when performing range queries.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowKeySchema

public WindowKeySchema()

Method Detail

upperRange

public org.apache.kafka.common.utils.Bytes upperRange(org.apache.kafka.common.utils.Bytes key,
                                                      long to)

Description copied from interface: SegmentedBytesStore.KeySchema

Given a range of record keys and a time, construct a Segmented key that represents the upper range of keys to search when performing range queries.

Specified by:

upperRange in interface SegmentedBytesStore.KeySchema

Returns:

The key that represents the upper range to search for in the store

See Also:

SessionKeySchema.upperRange(org.apache.kafka.common.utils.Bytes, long), upperRange(org.apache.kafka.common.utils.Bytes, long)

lowerRange

public org.apache.kafka.common.utils.Bytes lowerRange(org.apache.kafka.common.utils.Bytes key,
                                                      long from)

Description copied from interface: SegmentedBytesStore.KeySchema

Given a range of record keys and a time, construct a Segmented key that represents the lower range of keys to search when performing range queries.

Specified by:

lowerRange in interface SegmentedBytesStore.KeySchema

Returns:

The key that represents the lower range to search for in the store

See Also:

SessionKeySchema.lowerRange(org.apache.kafka.common.utils.Bytes, long), lowerRange(org.apache.kafka.common.utils.Bytes, long)

lowerRangeFixedSize

public org.apache.kafka.common.utils.Bytes lowerRangeFixedSize(org.apache.kafka.common.utils.Bytes key,
                                                               long from)

Description copied from interface: SegmentedBytesStore.KeySchema

Given a range of fixed size record keys and a time, construct a Segmented key that represents the lower range of keys to search when performing range queries.

Specified by:

lowerRangeFixedSize in interface SegmentedBytesStore.KeySchema

Parameters:

key - the first key in the range

from - the first timestamp in the range

Returns:

The key that represents the lower range to search for in the store

See Also:

SessionKeySchema.lowerRange(org.apache.kafka.common.utils.Bytes, long), lowerRange(org.apache.kafka.common.utils.Bytes, long)

upperRangeFixedSize

public org.apache.kafka.common.utils.Bytes upperRangeFixedSize(org.apache.kafka.common.utils.Bytes key,
                                                               long to)

Description copied from interface: SegmentedBytesStore.KeySchema

Given a range of fixed size record keys and a time, construct a Segmented key that represents the upper range of keys to search when performing range queries.

Specified by:

upperRangeFixedSize in interface SegmentedBytesStore.KeySchema

Parameters:

key - the last key in the range

to - the last timestamp in the range

Returns:

The key that represents the upper range to search for in the store

See Also:

SessionKeySchema.upperRange(org.apache.kafka.common.utils.Bytes, long), upperRange(org.apache.kafka.common.utils.Bytes, long)

segmentTimestamp

public long segmentTimestamp(org.apache.kafka.common.utils.Bytes key)

Description copied from interface: SegmentedBytesStore.KeySchema

Extract the timestamp of the segment from the key. The key is a composite of the record-key, any timestamps, plus any additional information.

Specified by:

segmentTimestamp in interface SegmentedBytesStore.KeySchema

Returns:

See Also:

SessionKeySchema.lowerRange(org.apache.kafka.common.utils.Bytes, long), lowerRange(org.apache.kafka.common.utils.Bytes, long)

hasNextCondition

public org.apache.kafka.streams.state.internals.HasNextCondition hasNextCondition(org.apache.kafka.common.utils.Bytes binaryKeyFrom,
                                                                                  org.apache.kafka.common.utils.Bytes binaryKeyTo,
                                                                                  long from,
                                                                                  long to)

Description copied from interface: SegmentedBytesStore.KeySchema

Create an implementation of HasNextCondition that knows when to stop iterating over the KeyValueSegments. Used during SegmentedBytesStore.fetch(Bytes, Bytes, long, long) operations

Specified by:

hasNextCondition in interface SegmentedBytesStore.KeySchema

Parameters:

binaryKeyFrom - the first key in the range

binaryKeyTo - the last key in the range

from - starting time range

to - ending time range

Returns:

segmentsToSearch

public <S extends Segment> List<S> segmentsToSearch(org.apache.kafka.streams.state.internals.Segments<S> segments,
                                                    long from,
                                                    long to)

Description copied from interface: SegmentedBytesStore.KeySchema

Used during SegmentedBytesStore.fetch(Bytes, long, long) operations to determine which segments should be scanned.

Specified by:

segmentsToSearch in interface SegmentedBytesStore.KeySchema

Returns:

List of segments to search

toBinary

public static <K> byte[] toBinary(Windowed<K> timeKey,
                                  Serializer<K> serializer,
                                  String topic)

from

public static <K> Windowed<K> from(byte[] binaryKey,
                                   long windowSize,
                                   Deserializer<K> deserializer,
                                   String topic)

toStoreKeyBinary

public static org.apache.kafka.common.utils.Bytes toStoreKeyBinary(org.apache.kafka.common.utils.Bytes key,
                                                                   long timestamp,
                                                                   int seqnum)

toStoreKeyBinary

public static <K> org.apache.kafka.common.utils.Bytes toStoreKeyBinary(K key,
                                                                       long timestamp,
                                                                       int seqnum,
                                                                       StateSerdes<K,?> serdes)

toStoreKeyBinary

public static org.apache.kafka.common.utils.Bytes toStoreKeyBinary(Windowed<org.apache.kafka.common.utils.Bytes> timeKey,
                                                                   int seqnum)

toStoreKeyBinary

public static <K> org.apache.kafka.common.utils.Bytes toStoreKeyBinary(Windowed<K> timeKey,
                                                                       int seqnum,
                                                                       StateSerdes<K,?> serdes)

fromStoreKey

public static <K> Windowed<K> fromStoreKey(byte[] binaryKey,
                                           long windowSize,
                                           Deserializer<K> deserializer,
                                           String topic)

fromStoreKey

public static <K> Windowed<K> fromStoreKey(Windowed<org.apache.kafka.common.utils.Bytes> windowedKey,
                                           Deserializer<K> deserializer,
                                           String topic)

fromStoreBytesKey

public static Windowed<org.apache.kafka.common.utils.Bytes> fromStoreBytesKey(byte[] binaryKey,
                                                                              long windowSize)