Class FDBQueriedRecord<M extends Message>
- java.lang.Object
-
- com.apple.foundationdb.record.provider.foundationdb.FDBQueriedRecord<M>
-
- Type Parameters:
M
- type used to represent stored records
- All Implemented Interfaces:
FDBRecord<M>
@API(MAINTAINED) public abstract class FDBQueriedRecord<M extends Message> extends Object implements FDBRecord<M>
A record returned by a query and therefore possibly associated with a particular entry in some index.
-
-
Constructor Summary
Constructors Constructor Description FDBQueriedRecord()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static <M extends Message>
FDBQueriedRecord<M>covered(Index index, IndexEntry indexEntry, Tuple primaryKey, RecordType recordType, M record)
abstract Index
getIndex()
Get the index, if any, that produced this query result record.abstract IndexEntry
getIndexEntry()
Get the index entry, if any, that produced this query result record.abstract FDBStoredRecord<M>
getStoredRecord()
Get the stored record, if any, that produced this query result record.static <M extends Message>
FDBQueriedRecord<M>indexed(FDBIndexedRecord<M> indexed)
static <M extends Message>
FDBQueriedRecord<M>stored(FDBStoredRecord<M> stored)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.apple.foundationdb.record.provider.foundationdb.FDBRecord
getPrimaryKey, getRecord, getRecordType, getVersion, hasVersion
-
-
-
-
Method Detail
-
getStoredRecord
@Nullable public abstract FDBStoredRecord<M> getStoredRecord()
Get the stored record, if any, that produced this query result record.null
if this query result record was assembled without loading the whole record, for example, from a covering index.- Returns:
- the stored record form of this record
-
getIndex
@Nullable public abstract Index getIndex()
Get the index, if any, that produced this query result record.null
if this query result record was gotten by some other means than an index scan.- Returns:
- the index that was queried to produce this record
-
getIndexEntry
@Nullable public abstract IndexEntry getIndexEntry()
Get the index entry, if any, that produced this query result record.null
if this query result record was gotten by direct lookup or scan and not an index.- Returns:
- this record's index entry
-
indexed
public static <M extends Message> FDBQueriedRecord<M> indexed(@Nonnull FDBIndexedRecord<M> indexed)
-
stored
public static <M extends Message> FDBQueriedRecord<M> stored(@Nonnull FDBStoredRecord<M> stored)
-
covered
public static <M extends Message> FDBQueriedRecord<M> covered(@Nonnull Index index, @Nonnull IndexEntry indexEntry, @Nonnull Tuple primaryKey, @Nonnull RecordType recordType, @Nonnull M record)
-
-