Package com.apple.foundationdb.record.provider.foundationdb.clientlog

Class KeySpaceCountTree

java.lang.Object

com.apple.foundationdb.clientlog.TupleKeyCountTree

com.apple.foundationdb.record.provider.foundationdb.clientlog.KeySpaceCountTree

public class KeySpaceCountTree
extends com.apple.foundationdb.clientlog.TupleKeyCountTree

Count keys and resolve back to key space paths.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeySpaceCountTree.Resolved	The resolved interpretation of the node value.
static class	KeySpaceCountTree.ResolvedIndexKeyspace	A resolved index keyspace.
static class	KeySpaceCountTree.ResolvedKeyField	A resolved field of a record primary key or index key.
static class	KeySpaceCountTree.ResolvedPath	KeySpaceCountTree.Resolved to a ResolvedKeySpacePath.
static class	KeySpaceCountTree.ResolvedPrefixRoot	KeySpaceCountTree.ResolvedRoot with a prefix object.
static class	KeySpaceCountTree.ResolvedRecordStoreKeyspace	A resolved record store keyspace, such as records or indexes.
static class	KeySpaceCountTree.ResolvedRecordTypeKeyspace	A resolved record type key prefix keyspace.
static class	KeySpaceCountTree.ResolvedRoot	KeySpaceCountTree.Resolved to a KeySpace root.

Nested classes/interfaces inherited from class com.apple.foundationdb.clientlog.TupleKeyCountTree

com.apple.foundationdb.clientlog.TupleKeyCountTree.Printer

Constructor Summary

Constructors

Constructor	Description
KeySpaceCountTree(KeySpaceCountTree parent, byte[] bytes, Object object)
KeySpaceCountTree(KeySpace keySpace)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<RecordMetaData>	getRecordStoreMetaData(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object)	Given a key space path for which isRecordStoreLeaf(com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext, com.apple.foundationdb.record.provider.foundationdb.clientlog.KeySpaceCountTree.Resolved, java.lang.Object) is true, get the record store's meta-data.
protected List<KeyExpression>	indexStoredKeys(Index index)
protected boolean	isRecordStoreLeaf(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object)	Determine whether this leaf of the KeySpaceDirectory tree is the root of a FDBRecordStore.
protected com.apple.foundationdb.clientlog.TupleKeyCountTree	newChild(byte[] childBytes, Object object)
protected com.apple.foundationdb.clientlog.TupleKeyCountTree	newPrefixChild(byte[] prefixBytes, Object prefix)
protected CompletableFuture<Void>	resolve(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent)
protected CompletableFuture<KeySpaceCountTree.Resolved>	resolve(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object)
protected CompletableFuture<KeySpaceCountTree.Resolved>	resolveIndexField(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object, Index index, KeyExpression fieldKey, int fieldIndex)
protected CompletableFuture<KeySpaceCountTree.Resolved>	resolveKeyField(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object, KeyExpression fieldKey)
protected CompletableFuture<KeySpaceCountTree.Resolved>	resolveNonDirectory(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object)	Resolve something other than a KeySpaceDirectory node.
protected CompletableFuture<KeySpaceCountTree.Resolved>	resolvePrimaryKeyField(FDBRecordContext context, KeySpaceCountTree.Resolved resolvedParent, Object object, KeyExpression fieldKey, int fieldIndex)
CompletableFuture<Void>	resolveVisibleChildren(FDBRecordContext context)
String	toString()

Methods inherited from class com.apple.foundationdb.clientlog.TupleKeyCountTree

add, add, addPrefixChild, getBytes, getChildren, getCount, getObject, getParent, hasObject, hideLessThanFraction, isVisible, printTree, printTree, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

KeySpaceCountTree

public KeySpaceCountTree(@Nonnull
                         KeySpace keySpace)

KeySpaceCountTree

public KeySpaceCountTree(@Nullable
                         KeySpaceCountTree parent,
                         @Nonnull
                         byte[] bytes,
                         @Nullable
                         Object object)

Method Detail

newChild

@Nonnull
protected com.apple.foundationdb.clientlog.TupleKeyCountTree newChild(@Nonnull
                                                                      byte[] childBytes,
                                                                      @Nonnull
                                                                      Object object)

Overrides:

newChild in class com.apple.foundationdb.clientlog.TupleKeyCountTree

newPrefixChild

@Nonnull
protected com.apple.foundationdb.clientlog.TupleKeyCountTree newPrefixChild(@Nonnull
                                                                            byte[] prefixBytes,
                                                                            @Nonnull
                                                                            Object prefix)

Overrides:

newPrefixChild in class com.apple.foundationdb.clientlog.TupleKeyCountTree

resolveVisibleChildren

public CompletableFuture<Void> resolveVisibleChildren(@Nonnull
                                                      FDBRecordContext context)

resolve

protected CompletableFuture<Void> resolve(@Nonnull
                                          FDBRecordContext context,
                                          @Nonnull
                                          KeySpaceCountTree.Resolved resolvedParent)

resolve

protected CompletableFuture<KeySpaceCountTree.Resolved> resolve(@Nonnull
                                                                FDBRecordContext context,
                                                                @Nonnull
                                                                KeySpaceCountTree.Resolved resolvedParent,
                                                                @Nullable
                                                                Object object)

resolveNonDirectory

protected CompletableFuture<KeySpaceCountTree.Resolved> resolveNonDirectory(@Nonnull
                                                                            FDBRecordContext context,
                                                                            @Nonnull
                                                                            KeySpaceCountTree.Resolved resolvedParent,
                                                                            @Nullable
                                                                            Object object)

Resolve something other than a KeySpaceDirectory node.

Parameters:

context - an open transaction to use to read from the database

resolvedParent - the resolved parent node

object - the Tuple element for this node

Returns:

a future that completes to a new KeySpaceCountTree.Resolved or null

indexStoredKeys

protected List<KeyExpression> indexStoredKeys(@Nonnull
                                              Index index)

isRecordStoreLeaf

protected boolean isRecordStoreLeaf(@Nonnull
                                    FDBRecordContext context,
                                    @Nonnull
                                    KeySpaceCountTree.Resolved resolvedParent,
                                    @Nullable
                                    Object object)

Determine whether this leaf of the KeySpaceDirectory tree is the root of a FDBRecordStore. Override this if whether a leaf directory can be determined from the KeySpaceCountTree.Resolved; for example, because they use a specific KeySpacePathWrapper class.

Parameters:

context - an open transaction to use to read from the database

resolvedParent - the resolved parent node

object - the Tuple element for this node

Returns:

true if this path stores a record store

getRecordStoreMetaData

protected CompletableFuture<RecordMetaData> getRecordStoreMetaData(@Nonnull
                                                                   FDBRecordContext context,
                                                                   @Nonnull
                                                                   KeySpaceCountTree.Resolved resolvedParent,
                                                                   @Nullable
                                                                   Object object)

Given a key space path for which isRecordStoreLeaf(com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext, com.apple.foundationdb.record.provider.foundationdb.clientlog.KeySpaceCountTree.Resolved, java.lang.Object) is true, get the record store's meta-data. Override this method if the meta-data can be determined from the KeySpaceCountTree.Resolved tree.

Parameters:

context - an open transaction to use to read from the database

resolvedParent - the resolved parent node

object - the Tuple element for this node

Returns:

a future that completes to the record store's meta-data or null

resolvePrimaryKeyField

protected CompletableFuture<KeySpaceCountTree.Resolved> resolvePrimaryKeyField(@Nonnull
                                                                               FDBRecordContext context,
                                                                               @Nonnull
                                                                               KeySpaceCountTree.Resolved resolvedParent,
                                                                               @Nullable
                                                                               Object object,
                                                                               @Nonnull
                                                                               KeyExpression fieldKey,
                                                                               int fieldIndex)

resolveIndexField

protected CompletableFuture<KeySpaceCountTree.Resolved> resolveIndexField(@Nonnull
                                                                          FDBRecordContext context,
                                                                          @Nonnull
                                                                          KeySpaceCountTree.Resolved resolvedParent,
                                                                          @Nullable
                                                                          Object object,
                                                                          @Nonnull
                                                                          Index index,
                                                                          @Nonnull
                                                                          KeyExpression fieldKey,
                                                                          int fieldIndex)

resolveKeyField

protected CompletableFuture<KeySpaceCountTree.Resolved> resolveKeyField(@Nonnull
                                                                        FDBRecordContext context,
                                                                        @Nonnull
                                                                        KeySpaceCountTree.Resolved resolvedParent,
                                                                        @Nullable
                                                                        Object object,
                                                                        @Nonnull
                                                                        KeyExpression fieldKey)

toString

public String toString()

Overrides:

toString in class com.apple.foundationdb.clientlog.TupleKeyCountTree