org.fusesource.hawtdb.api

Interface Predicate<Key>

Type Parameters:

Key -

public interface Predicate<Key>

A predicate is used to narrow down the keys that an application is interested in accessing. You can implement custom predicate implementations by implementing the Predicate interface or you can you some of the predefined predicate classes.

Author:

Hiram Chirino

Method Summary

Modifier and Type	Method and Description
boolean	isInterestedInKey(Key key, Comparator comparator)
boolean	isInterestedInKeysBetween(Key first, Key second, Comparator comparator)

Method Detail

isInterestedInKeysBetween

boolean isInterestedInKeysBetween(Key first,
                                  Key second,
                                  Comparator comparator)

Parameters:

first - the first key in the range or null if unknown

second - the last key in the range or null if unknown

comparator - the Comparator configured for the index, may be null.

Returns:

true if the predicate is interested in keys in the range.

isInterestedInKey

boolean isInterestedInKey(Key key,
                          Comparator comparator)

Parameters:

key -

comparator - the Comparator configured for the index, may be null.

Returns:

true if the predicate is interested in the key