Package org.apache.jackrabbit.oak.segment

Interface Summary

Interface	Description
NodeCache	Partial mapping of String keys to values of type RecordId.
Revisions	Revisions instances provide read and write access to the current head state.
Revisions.Option	Implementation specific options for the setHead methods.
Segment.RecordConsumer	A consumer of record data.
SegmentGraph.SegmentGraphVisitor	Visitor for receiving call backs while traversing the segment graph.
SegmentIdFactory	A factory for SegmentId given their representation in MSB/LSB longs.
SegmentNodeStoreMonitor	SegmentNodeStoreMonitor is notified for commit related operations performed by SegmentNodeStore.
SegmentNodeStoreStatsMBean
SegmentNotFoundExceptionListener	Listener for SegmentNotFoundException.
SegmentReader	Instances of SegmentReader are responsible for reading records from segments.
SegmentStore	The backend storage interface used by the segment node store.
SegmentStoreProvider

Class Summary

Class	Description
CacheWeights
CacheWeights.NodeCacheWeigher
CacheWeights.OneWeigher<K,V>
CacheWeights.ReaderStringCacheWeigher
CacheWeights.ReaderTemplateCacheWeigher
CacheWeights.SegmentCacheWeigher
CacheWeights.StringCacheWeigher
CacheWeights.TemplateCacheWeigher
CachingSegmentReader	This SegmentReader implementation implements caching for strings and templates.
Compactor	Tool for compacting segments.
MapRecord	A map.
PropertyTemplate	A property definition within a template (the property name, the type, and the index within the list of properties for the given node).
ReaderCache<T>	A cache consisting of a fast and slow component.
RecordCache<T>	Partial mapping of keys of type T to values of type RecordId.
RecordCacheStats	Statistics for RecordCache.
RecordId	The record id.
RecordIdSet	A memory optimised set of RecordIds.
RecordUsageAnalyser	This utility breaks down space usage per record type.
Segment	A list of records.
SegmentBlob	A BLOB (stream of bytes).
SegmentBlobReferenceRetriever	Implementation of BlobReferenceRetriever to retrieve blob references from the SegmentTracker.
SegmentBufferWriter	This class encapsulates the state of a segment being written.
SegmentBufferWriterPool	This WriteOperationHandler uses a pool of SegmentBufferWriters, which it passes to its execute method.
SegmentCache	A cache for Segment instances by their SegmentId.
SegmentCheckpointMBean	CheckpointMBean implementation for the SegmentNodeStore.
SegmentGraph	Utility graph for parsing a segment graph.
SegmentGraph.Graph<T>	A simple graph representation for a graph with node of type T.
SegmentId	Segment identifier.
SegmentIdTable	Hash table of weak references to segment identifiers.
SegmentNodeBuilder	A node builder that keeps track of the number of updates (set property calls and so on).
SegmentNodeState	A record of type "NODE".
SegmentNodeStateHelper
SegmentNodeStore	The top level class for the segment store.
SegmentNodeStore.SegmentNodeStoreBuilder
SegmentNodeStoreBuilders	Static factories for creating SegmentNodeBuilder instances pertaining to specific SegmentStore instances.
SegmentNodeStoreFactory	A factory allowing creation of secondary segment node stores.
SegmentNodeStoreService	An OSGi wrapper for the segment node store.
SegmentNodeStoreStats
SegmentParser	SegmentParser serves as a base class for parsing segments.
SegmentParser.BlobInfo	Return type of SegmentParser.parseBlob(RecordId).
SegmentParser.ListBucketInfo	Return type of SegmentParser.parseListBucket(RecordId, int, int, int).
SegmentParser.ListInfo	Return type of SegmentParser.parseList(RecordId, RecordId, int) .
SegmentParser.MapInfo	Result type of SegmentParser.parseMap(RecordId, RecordId, MapRecord).
SegmentParser.NodeInfo	Result type of SegmentParser.parseNode(RecordId).
SegmentParser.PropertyInfo	Result type of SegmentParser.parseProperty(RecordId, RecordId, PropertyTemplate).
SegmentParser.TemplateInfo	Result type of SegmentParser.parseTemplate(RecordId).
SegmentParser.ValueInfo	Result type of SegmentParser.parseValue(RecordId, RecordId, Type).
SegmentPropertyState	A property, which can read a value or list record from a segment.
SegmentStream	For reading any record of type "VALUE" as binary streams.
SegmentTracker	Tracker of references to segment identifiers and segment instances that are currently kept in memory and factory for creating SegmentId instances.
SegmentWriter	A SegmentWriter converts nodes, properties, values, etc.
SegmentWriterBuilder	Builder for building SegmentWriter instances.
StringCache
Template	The in-memory representation of a "hidden class" of a node; inspired by the Chrome V8 Javascript engine).
TemplateCache
WriterCacheManager	Instances of this class manage the deduplication caches used by the SegmentWriter to avoid writing multiple copies of the same record.
WriterCacheManager.Default	This implementation of WriterCacheManager returns RecordCache instances for the string and template cache and NodeCache instance for the node cache.
WriterCacheManager.Empty	This implementation of WriterCacheManager returns empty caches of size 0.

Enum Summary

Enum	Description
RecordType	The type of a record in a segment.
SegmentParser.BlobType	Type of blobs (and strings)
SegmentVersion	Version of the segment storage format.

Exception Summary

Exception	Description
SegmentNotFoundException	This exception is thrown when there the segment does not exist in the store
SegmentOverflowException	This exception is thrown by the Segment NodeStore when an internal limit is exceeded such as too many segment references.