org.neo4j.consistency.checking.cache

Interface CacheAccess.Client

Enclosing interface:

CacheAccess

public static interface CacheAccess.Client

Client per thread for accessing cache and counts for statistics

Method Summary

Modifier and Type	Method and Description
void	clearCache(long id) Clears the cached values for the specified id.
boolean	getBooleanFromCache(long id, int slot) Gets a cached value, put there with putToCache(long, long...) or putToCacheSingle(long, int, long) and interpret field value as a boolean.
long	getFromCache(long id, int slot) Gets a cached value, put there with putToCache(long, long...) or putToCacheSingle(long, int, long).
Iterable<org.neo4j.kernel.impl.store.record.PropertyRecord>	getPropertiesFromCache()
org.neo4j.kernel.impl.store.record.PropertyRecord	getPropertyFromCache(long id) Gets a cached PropertyRecord of a specific id, see putPropertiesToCache(Collection).
void	incAndGetCount(Counts.Type type) Increases the count of the specified type, for gathering statistics during a run.
void	putPropertiesToCache(Collection<org.neo4j.kernel.impl.store.record.PropertyRecord> properties) Caches a Collection of PropertyRecord for later checking.
void	putToCache(long id, long... cacheFields) Caches all values for an id, i.e.
void	putToCacheSingle(long id, int slot, long value) Caches a single value for an id and slot.
boolean	withinBounds(long id) Some consistency check stages splits the id range into segments, one per thread.

Method Detail

getFromCache

long getFromCache(long id,
                  int slot)

Gets a cached value, put there with putToCache(long, long...) or putToCacheSingle(long, int, long).

Parameters:

id - the entity id this cached value is tied to.

slot - which cache slot for this id.

Returns:

the cached value.

getBooleanFromCache

boolean getBooleanFromCache(long id,
                            int slot)

Gets a cached value, put there with putToCache(long, long...) or putToCacheSingle(long, int, long) and interpret field value as a boolean. 0 will be treated as false all the rest as true.

Parameters:

id - the entity id this cached value is tied to.

slot - which cache slot for this id.

Returns:

false if slot value is 0, true otherwise.

putToCache

void putToCache(long id,
                long... cacheFields)

Caches all values for an id, i.e. fills all slots.

Parameters:

id - the entity id these cached values will be tied to.

cacheFields - the values to cache, one per slot.

putToCacheSingle

void putToCacheSingle(long id,
                      int slot,
                      long value)

Caches a single value for an id and slot.

Parameters:

id - the entity id this cached values will be tied to.

slot - the slot for the given id.

value - the value to cache for this id and slot.

clearCache

void clearCache(long id)

Clears the cached values for the specified id.

Parameters:

id - the entity id to clear the cached values for.

putPropertiesToCache

void putPropertiesToCache(Collection<org.neo4j.kernel.impl.store.record.PropertyRecord> properties)

Caches a Collection of PropertyRecord for later checking.

Parameters:

properties - property records to cache for this thread.

getPropertyFromCache

org.neo4j.kernel.impl.store.record.PropertyRecord getPropertyFromCache(long id)

Gets a cached PropertyRecord of a specific id, see putPropertiesToCache(Collection).

Parameters:

id - the property record id to look for.

Returns:

cached PropertyRecord id, or null if not found.

getPropertiesFromCache

Iterable<org.neo4j.kernel.impl.store.record.PropertyRecord> getPropertiesFromCache()

Returns:

cached properties.

incAndGetCount

void incAndGetCount(Counts.Type type)

Increases the count of the specified type, for gathering statistics during a run.

Parameters:

type - counts type.

withinBounds

boolean withinBounds(long id)

Some consistency check stages splits the id range into segments, one per thread. That split is initiated by CacheAccess.prepareForProcessingOfSingleStore(long) and checker, per thread, using this method.

Parameters:

id - the record id to check whether or not to process for this thread.

Returns:

true if the thread represented by this client should process the record of the given id, otherwise false.