Package com.apple.foundationdb.record.metadata

Class SyntheticRecordType<C extends SyntheticRecordType.Constituent>

java.lang.Object

com.apple.foundationdb.record.metadata.RecordType

com.apple.foundationdb.record.metadata.SyntheticRecordType<C>

Type Parameters:

C - type of constituent record types

All Implemented Interfaces:

RecordTypeOrBuilder, RecordMetaDataProvider

Direct Known Subclasses:

JoinedRecordType

@API(EXPERIMENTAL)
public abstract class SyntheticRecordType<C extends SyntheticRecordType.Constituent>
extends RecordType

A synthetic record type is made up of other record types and not actually stored separately in the record store. It can, however, be indexed, by passing it to an IndexMaintainer that will evaluate KeyExpressions against it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyntheticRecordType.Constituent	A constituent type of the synthetic record type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SyntheticRecordType(RecordMetaData metaData, Descriptors.Descriptor descriptor, KeyExpression primaryKey, Object recordTypeKey, List<Index> indexes, List<Index> multiTypeIndexes, List<C> constituents)

Method Summary

Modifier and Type	Method	Description
List<C>	getConstituents()
boolean	isSynthetic()	Get whether this record type represents synthetic records.
String	toString()

Methods inherited from class com.apple.foundationdb.record.metadata.RecordType

getAllIndexes, getDescriptor, getExplicitRecordTypeKey, getIndexes, getMultiTypeIndexes, getName, getPrimaryKey, getRecordMetaData, getRecordTypeKey, getRecordTypeKeyTuple, getSinceVersion, hasExplicitRecordTypeKey, primaryKeyHasRecordTypePrefix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SyntheticRecordType

protected SyntheticRecordType(@Nonnull
                              RecordMetaData metaData,
                              @Nonnull
                              Descriptors.Descriptor descriptor,
                              @Nonnull
                              KeyExpression primaryKey,
                              @Nonnull
                              Object recordTypeKey,
                              @Nonnull
                              List<Index> indexes,
                              @Nonnull
                              List<Index> multiTypeIndexes,
                              @Nonnull
                              List<C> constituents)

Method Detail

getConstituents

@Nonnull
public List<C> getConstituents()

isSynthetic

public boolean isSynthetic()

Description copied from class: RecordType

Get whether this record type represents synthetic records. A synthetic record is one that is not actually stored, although it can may be indexed.

Overrides:

isSynthetic in class RecordType

Returns:

true if this record type represents synthetic records, false if it represents records that are actually stored

toString

public String toString()

Overrides:

toString in class RecordType