org.apache.jackrabbit.oak.plugins.segment

Class RecordUsageAnalyser

java.lang.Object

org.apache.jackrabbit.oak.plugins.segment.SegmentParser

org.apache.jackrabbit.oak.plugins.segment.RecordUsageAnalyser

public class RecordUsageAnalyser
extends SegmentParser

This utility breaks down space usage per record type. It accounts for value sharing. That is, an instance of this class will remember which records it has seen already and not count those again. Only the effective space taken by the records is taken into account. Slack space from aligning records is not accounted for.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.plugins.segment.SegmentParser

SegmentParser.BlobInfo, SegmentParser.BlobType, SegmentParser.ListBucketInfo, SegmentParser.ListInfo, SegmentParser.MapInfo, SegmentParser.NodeInfo, SegmentParser.PropertyInfo, SegmentParser.TemplateInfo, SegmentParser.ValueInfo

Constructor Summary

Constructors

Constructor and Description
RecordUsageAnalyser()

Method Summary

Methods

Modifier and Type	Method and Description
void	analyseNode(RecordId nodeId)
long	getExternalBlobCount()
long	getListCount()
long	getListSize()
long	getLongBlobCount()
long	getLongStringCount()
long	getMapCount()
long	getMapSize()
long	getMediumBlobCount()
long	getMediumStringCount()
long	getNodeCount()
long	getNodeSize()
long	getPropertyCount()
long	getSmallBlobCount()
long	getSmallStringCount()
long	getTemplateCount()
long	getTemplateSize()
long	getValueSize()
protected void	onBlob(RecordId parentId, RecordId blobId) Callback called by SegmentParser.parseValue(RecordId, RecordId, Type) upon encountering a blob.
protected void	onList(RecordId parentId, RecordId listId, int count) Callback called by SegmentParser.parseNode(RecordId), SegmentParser.parseProperty(RecordId, RecordId, PropertyTemplate), SegmentParser.parseTemplate(RecordId), SegmentParser.parseBlob(RecordId) and SegmentParser.parseString(RecordId) upon encountering a list.
protected void	onMapBranch(RecordId parentId, RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map branch.
protected void	onMapDiff(RecordId parentId, RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map diff.
protected void	onMapLeaf(RecordId parentId, RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map leaf.
protected void	onNode(RecordId parentId, RecordId nodeId) Callback called by SegmentParser.parseNode(RecordId) upon encountering a child node.
protected void	onProperty(RecordId parentId, RecordId propertyId, org.apache.jackrabbit.oak.plugins.segment.PropertyTemplate template) Callback called by SegmentParser.parseNode(RecordId) upon encountering a property.
protected void	onString(RecordId parentId, RecordId stringId) Callback called by SegmentParser.parseTemplate(RecordId), SegmentParser.parseMapLeaf(RecordId, MapRecord) and SegmentParser.parseValue(RecordId, RecordId, Type) upon encountering a string.
protected void	onTemplate(RecordId parentId, RecordId templateId) Callback called by SegmentParser.parseNode(RecordId) upon encountering a template
String	toString()

Methods inherited from class org.apache.jackrabbit.oak.plugins.segment.SegmentParser

onListBucket, onMap, onValue, parseBlob, parseList, parseListBucket, parseMap, parseMapBranch, parseMapDiff, parseMapLeaf, parseNode, parseProperty, parseString, parseTemplate, parseValue

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordUsageAnalyser

public RecordUsageAnalyser()

Method Detail

getMapSize

public long getMapSize()

Returns:

number of bytes in leaf and branch records.

getListSize

public long getListSize()

Returns:

number of bytes in list and bucket records.

getValueSize

public long getValueSize()

Returns:

number of bytes in inlined values (strings and blobs)

getTemplateSize

public long getTemplateSize()

Returns:

number of bytes in template records.

getNodeSize

public long getNodeSize()

Returns:

number of bytes in node records.

getMapCount

public long getMapCount()

Returns:

number of maps

getListCount

public long getListCount()

Returns:

number of lists

getPropertyCount

public long getPropertyCount()

Returns:

number of properties

getSmallBlobCount

public long getSmallBlobCount()

Returns:

number of small blobs.

getMediumBlobCount

public long getMediumBlobCount()

Returns:

number of medium blobs.

getLongBlobCount

public long getLongBlobCount()

Returns:

number of long blobs.

getExternalBlobCount

public long getExternalBlobCount()

Returns:

number of external blobs.

getSmallStringCount

public long getSmallStringCount()

Returns:

number of small strings.

getMediumStringCount

public long getMediumStringCount()

Returns:

number of medium strings.

getLongStringCount

public long getLongStringCount()

Returns:

number of long strings.

getTemplateCount

public long getTemplateCount()

Returns:

number of templates.

getNodeCount

public long getNodeCount()

Returns:

number of nodes.

analyseNode

public void analyseNode(RecordId nodeId)

toString

public String toString()

Overrides:

toString in class Object

onNode

protected void onNode(RecordId parentId,
          RecordId nodeId)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseNode(RecordId) upon encountering a child node.

Overrides:

onNode in class SegmentParser

Parameters:

parentId - id of the parent node

nodeId - if of the child node

onTemplate

protected void onTemplate(RecordId parentId,
              RecordId templateId)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseNode(RecordId) upon encountering a template

Overrides:

onTemplate in class SegmentParser

Parameters:

parentId - id of the node being parsed

templateId - id of the template

onMapDiff

protected void onMapDiff(RecordId parentId,
             RecordId mapId,
             org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map diff.

Overrides:

onMapDiff in class SegmentParser

Parameters:

parentId - the id of the parent map

mapId - the id of the map

map - the map

onMapLeaf

protected void onMapLeaf(RecordId parentId,
             RecordId mapId,
             org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map leaf.

Overrides:

onMapLeaf in class SegmentParser

Parameters:

parentId - the id of the parent map

mapId - the id of the map

map - the map

onMapBranch

protected void onMapBranch(RecordId parentId,
               RecordId mapId,
               org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseMap(RecordId, RecordId, MapRecord) upon encountering a map branch.

Overrides:

onMapBranch in class SegmentParser

Parameters:

parentId - the id of the parent map

mapId - the id of the map

map - the map

onProperty

protected void onProperty(RecordId parentId,
              RecordId propertyId,
              org.apache.jackrabbit.oak.plugins.segment.PropertyTemplate template)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseNode(RecordId) upon encountering a property.

Overrides:

onProperty in class SegmentParser

Parameters:

parentId - the id of the parent node

propertyId - the id of the property

template - the property template

onBlob

protected void onBlob(RecordId parentId,
          RecordId blobId)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseValue(RecordId, RecordId, Type) upon encountering a blob.

Overrides:

onBlob in class SegmentParser

Parameters:

parentId - the id of the blob's parent

blobId - the id of the blob

onString

protected void onString(RecordId parentId,
            RecordId stringId)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseTemplate(RecordId), SegmentParser.parseMapLeaf(RecordId, MapRecord) and SegmentParser.parseValue(RecordId, RecordId, Type) upon encountering a string.

Overrides:

onString in class SegmentParser

Parameters:

parentId - the id of the string's parent

stringId - the id of the string

onList

protected void onList(RecordId parentId,
          RecordId listId,
          int count)

Description copied from class: SegmentParser

Callback called by SegmentParser.parseNode(RecordId), SegmentParser.parseProperty(RecordId, RecordId, PropertyTemplate), SegmentParser.parseTemplate(RecordId), SegmentParser.parseBlob(RecordId) and SegmentParser.parseString(RecordId) upon encountering a list.

Overrides:

onList in class SegmentParser

Parameters:

parentId - the id of the list's parent

listId - the id of the list

count - the number of elements in the list