de.otto.synapse.messagestore

Interface Indexer

All Known Implementing Classes:

CalculatedValueIndexer, CompositeIndexer, StaticValueIndexer

@Beta
public interface Indexer

Indexes message-store entries added to a MessageStore so it can later be retrieved using MessageStore.stream(Index,String).

Method Summary

Modifier and Type	Method and Description
java.lang.String	calc(Index index, MessageStoreEntry entry) Calculates the Index value from the message-store entry.
com.google.common.collect.ImmutableSet<Index>	getIndexes() Returns the indexes supported by this Indexer.
MessageStoreEntry	index(MessageStoreEntry entry)
boolean	supports(Index index)

Method Detail

getIndexes

@Nonnull
com.google.common.collect.ImmutableSet<Index> getIndexes()

Returns the indexes supported by this Indexer.

Returns:

Set of Index instances

supports

boolean supports(@Nonnull
                 Index index)

Parameters:

index - the Index

Returns:

true, if the Index is supported, false otherwise.

calc

@Nonnull
java.lang.String calc(@Nonnull
                               Index index,
                               @Nonnull
                               MessageStoreEntry entry)

Calculates the Index value from the message-store entry.

Parameters:

index - the Index

entry - the MessageStoreEntry

Returns:

indexed value

index

@Nonnull
MessageStoreEntry index(@Nonnull
                                 MessageStoreEntry entry)