software.chronicle.datagrid.query

Interface IndexQuery<V>

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

VanillaIndexQuery

public interface IndexQuery<V>
extends net.openhft.chronicle.wire.Marshallable

Field Summary

Fields

Modifier and Type	Field and Description
static int	FROM_END send the snapshot that is collected from all the data in the current roll cycle if you have just restarted, no data will be return until internally all the data in the current roll cycle has been read and added to the internal map
static int	FROM_START replay data from the start of the current roll cycle, e.g.

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
boolean	bootstrap()
static <V> IndexQuery<V>	create(@NotNull String eventName, @NotNull Class<V> valueClass, @NotNull String select, long from, boolean bootstrap) Creates and returns a new IndexQuery for the provided parameters.
String	eventName() Returns the evenName for this IndexQuery.
Predicate<V>	filter() Returns the filter Predicate for this IndexQuery.
long	fromIndex() Returns the fromIndex for this IndexQuery.

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyFrom, copyTo, deepCopy, fromFile, fromFile, fromFileAsMap, fromFileAsMap, fromHexString, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, usesSelfDescribingMessage, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Field Detail

FROM_END

static final int FROM_END

send the snapshot that is collected from all the data in the current roll cycle if you have just restarted, no data will be return until internally all the data in the current roll cycle has been read and added to the internal map

See Also:

Constant Field Values

FROM_START

static final int FROM_START

replay data from the start of the current roll cycle, e.g. the start of today

See Also:

Constant Field Values

Method Detail

bootstrap

boolean bootstrap()

Returns:

if true the latest update for the roll cycle ( for example day ) , is provided, the latest update is determined using the KeyedMarshallable, if false, not snapshot is return

fromIndex

long fromIndex()

Returns the fromIndex for this IndexQuery.

Only messages with an index that are equal or greater than the fromIndex will appear in the stream of messages. There are two special values for the fromIndex:

• FROM_START - All messages from the current roll cycle can appear in the stream of messages
• FROM_END - Only new messages can appear in the stream of messages

Returns:

the filter Predicate for this IndexQuery

filter

Predicate<V> filter()

Returns the filter Predicate for this IndexQuery.

Only messages that passes the filter Predicate will appear in the stream of messages.

Returns:

the filter Predicate for this IndexQuery

eventName

String eventName()

Returns the evenName for this IndexQuery.

Only messages that has a topic that matched the eventName appear in the stream of messages.

Returns:

evenName for this IndexQuery

create

static <V> IndexQuery<V> create(@NotNull
                                @NotNull String eventName,
                                @NotNull
                                @NotNull Class<V> valueClass,
                                @NotNull
                                @NotNull String select,
                                long from,
                                boolean bootstrap)

Creates and returns a new IndexQuery for the provided parameters.

Type Parameters:

V - value type

Parameters:

eventName - to subscribe to (e.g. topic)

valueClass - for the index query (e.g. message)

select - textual representation of a java predicate code body. The variable to test against is named value.

from - index to start from or FROM_START or FROM_END

bootstrap - if messages should be

Returns:

a new IndexQuery for the provided parameters