Package org.apache.jackrabbit.oak.segment

Interface Summary

Interface	Description
Cache<K,V>	Partial mapping of keys of type K to values of type Cache.
RecordNumbers	A table to translate record numbers to offsets.
RecordNumbers.Entry	Represents an entry in the record table.
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.
SegmentIdFactory	A factory for SegmentId given their representation in MSB/LSB longs.
SegmentIdProvider	Instances of this class provides SegmentId instances of a given SegmentStore and creates new SegmentId instances on the fly if required.
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.
SegmentReferences	Represents a list of segment IDs referenced from a segment.
SegmentStore	The backend storage interface used by the segment node store.
SegmentStoreProvider
SegmentWriter	Converts nodes, properties, values, etc.
SegmentWriterFactory

Class Summary

Class	Description
CacheAccessTracker<K,V>	Cache wrapper exposing the number of read accesses and the number of misses ot the underlying cache via the StatisticsProvider.
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.
CancelableDiff	A NodeStateDiff that cancels itself when a condition occurs.
CheckpointCompactor	This compactor implementation is aware of the checkpoints in the repository.
ClassicCompactor	Instances of this class can be used to compact a node state.
Compactor	A compactor compacts the differences between two NodeStates (before and after) on top of a third NodeState (onto).
DefaultSegmentWriter	Converts nodes, properties, values, etc.
DefaultSegmentWriterBuilder	Builder for building DefaultSegmentWriter instances.
FileStoreHelper
LegacyCheckpointCompactor	Deprecated. Use CheckpointCompactor instead.
LoggingHook
MapRecord	A map.
ParallelCompactor	This compactor implementation leverages the tree structure of the repository for concurrent compaction.
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<K>	Partial mapping of keys of type K 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.
SegmentBufferMonitor	This class exposes CounterStats for allocations and de-allocations of Buffer instances: SegmentBufferMonitor.DIRECT_BUFFER_COUNT: number of allocated direct byte buffers.
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.
SegmentBufferWriterPool.SegmentBufferWriterPoolFactory
SegmentCache	A cache for data Segment instances by their SegmentId.
SegmentCheckpointMBean	CheckpointMBean implementation for the SegmentNodeStore.
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.
SegmentNodeStoreMonitorService	An OSGi wrapper for segment node store monitoring configurations.
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.
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 Cache 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.
SegmentBufferWriterPool.PoolType
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.