org.apache.jackrabbit.oak.segment

Class CachingSegmentReader

java.lang.Object

org.apache.jackrabbit.oak.segment.CachingSegmentReader

All Implemented Interfaces:

SegmentReader

public class CachingSegmentReader
extends Object
implements SegmentReader

This SegmentReader implementation implements caching for strings and templates. It can also optionally rely on a BlobStore for resolving blobs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STRING_CACHE_MB
static int	DEFAULT_TEMPLATE_CACHE_MB

Constructor Summary

Constructors

Constructor and Description
CachingSegmentReader(com.google.common.base.Supplier<SegmentWriter> writer, org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore, long stringCacheMB, long templateCacheMB) Create a new instance based on the supplied arguments.

Method Summary

Modifier and Type	Method and Description
org.apache.jackrabbit.oak.cache.CacheStats	getStringCacheStats()
org.apache.jackrabbit.oak.cache.CacheStats	getTemplateCacheStats()
SegmentBlob	readBlob(RecordId id) Read the blob identified by id.
SegmentNodeState	readHeadState(Revisions revisions) Read the current head state based on the head of revisions
MapRecord	readMap(RecordId id) Read the map identified by id.
SegmentNodeState	readNode(RecordId id) Read the node identified by id.
SegmentPropertyState	readProperty(RecordId id, PropertyTemplate template) Read the property identified by id and template
String	readString(RecordId id) Cached reading of a string.
Template	readTemplate(RecordId id) Cached reading of a template.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STRING_CACHE_MB

public static final int DEFAULT_STRING_CACHE_MB

See Also:

Constant Field Values

DEFAULT_TEMPLATE_CACHE_MB

public static final int DEFAULT_TEMPLATE_CACHE_MB

See Also:

Constant Field Values

Constructor Detail

CachingSegmentReader

public CachingSegmentReader(@Nonnull
                            com.google.common.base.Supplier<SegmentWriter> writer,
                            @Nullable
                            org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore,
                            long stringCacheMB,
                            long templateCacheMB)

Create a new instance based on the supplied arguments.

Parameters:

writer - A Supplier for a the SegmentWriter used by the segment builders returned from NodeState.builder() to write ahead changes. writer.get() must not return null.

blobStore - BlobStore instance of the underlying SegmentStore, or null if none.

stringCacheMB - the size of the string cache in MBs or 0 for no cache.

templateCacheMB - the size of the template cache in MBs or 0 for no cache.

Method Detail

readString

@Nonnull
public String readString(@Nonnull
                                  RecordId id)

Cached reading of a string.

Specified by:

readString in interface SegmentReader

readMap

@Nonnull
public MapRecord readMap(@Nonnull
                                  RecordId id)

Description copied from interface: SegmentReader

Read the map identified by id.

Specified by:

readMap in interface SegmentReader

readTemplate

@Nonnull
public Template readTemplate(@Nonnull
                                      RecordId id)

Cached reading of a template.

Specified by:

readTemplate in interface SegmentReader

readNode

@Nonnull
public SegmentNodeState readNode(@Nonnull
                                          RecordId id)

Description copied from interface: SegmentReader

Read the node identified by id.

Specified by:

readNode in interface SegmentReader

readHeadState

@Nonnull
public SegmentNodeState readHeadState(@Nonnull
                                               Revisions revisions)

Description copied from interface: SegmentReader

Read the current head state based on the head of revisions

Specified by:

readHeadState in interface SegmentReader

readProperty

@Nonnull
public SegmentPropertyState readProperty(@Nonnull
                                                  RecordId id,
                                                  @Nonnull
                                                  PropertyTemplate template)

Description copied from interface: SegmentReader

Read the property identified by id and template

Specified by:

readProperty in interface SegmentReader

readBlob

@Nonnull
public SegmentBlob readBlob(@Nonnull
                                     RecordId id)

Description copied from interface: SegmentReader

Read the blob identified by id.

Specified by:

readBlob in interface SegmentReader

getStringCacheStats

@Nonnull
public org.apache.jackrabbit.oak.cache.CacheStats getStringCacheStats()

getTemplateCacheStats

@Nonnull
public org.apache.jackrabbit.oak.cache.CacheStats getTemplateCacheStats()