Package com.apple.foundationdb.record.query.plan.temp

Class IndexEntrySource

java.lang.Object

com.apple.foundationdb.record.query.plan.temp.IndexEntrySource

public class IndexEntrySource
extends Object

A source of abstract index entries, each of which references a single record. An IndexEntrySource is an abstraction of the disparate sources of index entries. Presently, an IndexEntrySource is either an index or the range of primary keys, but in general there could be other index entry sources.

This abstraction is quite useful for the various rules in com.apple.foundationdb.record.query.plan.temp.rules since most rules can consider different types of scans that produces records with a uniform interface.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static IndexEntrySource	fromCommonPrimaryKey(Collection<String> recordTypes, KeyExpression commonPrimaryKey)
static IndexEntrySource	fromIndex(Collection<RecordType> recordTypes, Index index)
static IndexEntrySource	fromIndexWithTypeStrings(Collection<String> recordTypes, Index index)
ViewExpressionComparisons	getEmptyComparisons()
String	getIndexName()
int	hashCode()
boolean	isIndexScan()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getEmptyComparisons

@Nonnull
public ViewExpressionComparisons getEmptyComparisons()

getIndexName

@Nullable
public String getIndexName()

isIndexScan

public boolean isIndexScan()

fromIndex

@Nonnull
public static IndexEntrySource fromIndex(@Nonnull
                                         Collection<RecordType> recordTypes,
                                         @Nonnull
                                         Index index)

fromIndexWithTypeStrings

@Nonnull
public static IndexEntrySource fromIndexWithTypeStrings(@Nonnull
                                                        Collection<String> recordTypes,
                                                        @Nonnull
                                                        Index index)

fromCommonPrimaryKey

@Nonnull
public static IndexEntrySource fromCommonPrimaryKey(@Nonnull
                                                    Collection<String> recordTypes,
                                                    @Nonnull
                                                    KeyExpression commonPrimaryKey)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object