org.apache.jackrabbit.oak.plugins.segment

Interface PartialCompactionMap

All Known Implementing Classes:

InMemoryCompactionMap, PersistedCompactionMap

public interface PartialCompactionMap

A PartialCompactionMap maps uncompacted to compacted record ids from a single compaction cycle.

See Also:

CompactionMap

Method Summary

Methods

Modifier and Type	Method and Description
void	compress() Compressing this map ensures it takes up as little heap as possible.
RecordId	get(RecordId before) Retrieve the record id before maps to or null if no such id exists.
long	getEstimatedWeight() The weight of the compaction map is its heap memory consumption in bytes.
long	getRecordCount() Number of records referenced by the keys in this map.
long	getSegmentCount() Number of segments referenced by the keys in this map.
boolean	isEmpty() Determine whether this map contains keys at all.
void	put(RecordId before, RecordId after) Adds a new entry to the compaction map.
void	remove(Set<UUID> uuids) Remove all keys from this map where keys.contains(key.asUUID()).
boolean	wasCompacted(UUID id) Checks whether content in the segment with the given identifier was compacted to new segments.
boolean	wasCompactedTo(RecordId before, RecordId after) Checks whether the record with the given before identifier was compacted to a new record with the given after identifier.

Method Detail

wasCompactedTo

boolean wasCompactedTo(@Nonnull
                     RecordId before,
                     @Nonnull
                     RecordId after)

Checks whether the record with the given before identifier was compacted to a new record with the given after identifier.

Parameters:

before - before record identifier

after - after record identifier

Returns:

whether before was compacted to after

wasCompacted

boolean wasCompacted(@Nonnull
                   UUID id)

Checks whether content in the segment with the given identifier was compacted to new segments.

Parameters:

id - segment identifier

Returns:

whether the identified segment was compacted

get

@CheckForNull
RecordId get(@Nonnull
                        RecordId before)

Retrieve the record id before maps to or null if no such id exists.

Parameters:

before - before record id

Returns:

after record id or null

put

void put(@Nonnull
       RecordId before,
       @Nonnull
       RecordId after)

Adds a new entry to the compaction map. Overwriting a previously added entry is not supported.

Parameters:

before - before record id

after - after record id

Throws:

IllegalArgumentException - if before already exists in the map

remove

void remove(@Nonnull
          Set<UUID> uuids)

Remove all keys from this map where keys.contains(key.asUUID()).

Parameters:

uuids - uuids of the keys to remove

compress

void compress()

Compressing this map ensures it takes up as little heap as possible. This operation might be expensive and should only be called in suitable intervals.

getSegmentCount

long getSegmentCount()

Number of segments referenced by the keys in this map. The returned value might only be based on the compressed part of the map.

Returns:

number of segments

getRecordCount

long getRecordCount()

Number of records referenced by the keys in this map. The returned value might only be based on the compressed part of the map.

Returns:

number of records

isEmpty

boolean isEmpty()

Determine whether this map contains keys at all.

Returns:

true iff this map is empty

getEstimatedWeight

long getEstimatedWeight()

The weight of the compaction map is its heap memory consumption in bytes.

Returns:

Estimated weight of the compaction map