org.neo4j.consistency.checking.cache

Interface CacheAccess

All Known Implementing Classes:

DefaultCacheAccess

public interface CacheAccess

Just as RecordAccess is the main access point for AbstractBaseRecord and friends, so is CacheAccess the main access point for cached values related to records, most often caching parts of records, specific to certain stages of the consistency check. The access patterns to CacheAccess is designed to have multiple threads concurrently, and so client() provides a CacheAccess.Client that accesses the cache on the current thread's behalf. The cache is a compact representation of records, tied to an id, for example nodeId. There can be multiple cached values per id, selected by slot.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CacheAccess.Client Client per thread for accessing cache and counts for statistics

Field Summary

Fields

Modifier and Type	Field and Description
static CacheAccess	EMPTY
static CacheAccess.Client	EMPTY_CLIENT

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears all cached values.
CacheAccess.Client	client()
boolean	isForward() A flag for record checkers using this cache, where cached values are treated differently if we're scanning through a store forwards or backwards.
void	prepareForProcessingOfSingleStore(long recordsPerCPU)
void	setCacheSlotSizes(int... slotSize) Sets the slot sizes of the cached values.
void	setForward(boolean forward) Tells this CacheAccess whether or not the current stage, i.e is scanning forwards or backwards through a store or not.

Field Detail

EMPTY_CLIENT

static final CacheAccess.Client EMPTY_CLIENT

EMPTY

static final CacheAccess EMPTY

Method Detail

client

CacheAccess.Client client()

Returns:

CacheAccess.Client for the current Thread.

isForward

boolean isForward()

A flag for record checkers using this cache, where cached values are treated differently if we're scanning through a store forwards or backwards.

Returns:

true if the scanning is currently set to go forward.

setForward

void setForward(boolean forward)

Tells this CacheAccess whether or not the current stage, i.e is scanning forwards or backwards through a store or not. The cached values are treated differently depending on which. This is due to the double-linked nature of some stores, specifically the relationship store.

Parameters:

forward - true if the current scanning is forwards, otherwise it's backwards.

clearCache

void clearCache()

Clears all cached values.

setCacheSlotSizes

void setCacheSlotSizes(int... slotSize)

Sets the slot sizes of the cached values.

Parameters:

slotSize - defines how many and how big the slots are for cached values that are put after this call.

prepareForProcessingOfSingleStore

void prepareForProcessingOfSingleStore(long recordsPerCPU)