org.apache.jackrabbit.oak.plugins.segment

Class SegmentParser

java.lang.Object

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

Direct Known Subclasses:

RecordUsageAnalyser

public class SegmentParser
extends java.lang.Object

SegmentParser serves as a base class for parsing segments.

This base class provides means for parsing segments into their various kinds of record. Descendants typically parametrise its behaviour by overriding the on...() methods as needed. By default those methods just initiate the traversal of the same named record.

A typical usage for e.g. printing out the sizes of all templates would look as follows:

      new TestParser() {
          protected void onTemplate(RecordId parentId, RecordId templateId) {
              TemplateInfo templateInfo = parseTemplate(parentId, templateId);
              System.out.println(templateInfo.size);
          }
     }.parseNode(null, nodeId);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentParser.BlobInfo Return type of parseBlob(RecordId).
static class	SegmentParser.BlobType Type of blobs (and strings)
static class	SegmentParser.ListBucketInfo Return type of parseListBucket(RecordId, int, int, int).
static class	SegmentParser.ListInfo Return type of parseList(RecordId, RecordId, int) .
static class	SegmentParser.MapInfo Result type of parseMap(RecordId, RecordId, MapRecord).
static class	SegmentParser.NodeInfo Result type of parseNode(RecordId).
static class	SegmentParser.PropertyInfo Result type of parseProperty(RecordId, RecordId, PropertyTemplate).
static class	SegmentParser.TemplateInfo Result type of parseTemplate(RecordId).
static class	SegmentParser.ValueInfo Result type of parseValue(RecordId, RecordId, Type).

Constructor Summary

Constructors

Constructor and Description
SegmentParser()

Method Summary

Modifier and Type	Method and Description
SegmentParser.BlobInfo	parseBlob(RecordId blobId) Parse a blob record
SegmentParser.ListInfo	parseList(RecordId parentId, RecordId listId, int count) Parse a list record
SegmentParser.ListBucketInfo	parseListBucket(RecordId listId, int index, int count, int capacity) Parse item of list buckets
SegmentParser.MapInfo	parseMap(RecordId parentId, RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Parse a map record
SegmentParser.MapInfo	parseMapBranch(RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Parse a map branch record
SegmentParser.MapInfo	parseMapDiff(RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Parse a map diff record
SegmentParser.MapInfo	parseMapLeaf(RecordId mapId, org.apache.jackrabbit.oak.plugins.segment.MapRecord map) Parse a map leaf record
SegmentParser.NodeInfo	parseNode(RecordId nodeId) Parse a node record
SegmentParser.PropertyInfo	parseProperty(RecordId parentId, RecordId propertyId, org.apache.jackrabbit.oak.plugins.segment.PropertyTemplate template) Parse a property
SegmentParser.BlobInfo	parseString(RecordId stringId) Parse a string record
SegmentParser.TemplateInfo	parseTemplate(RecordId templateId) Parse a template record
SegmentParser.ValueInfo	parseValue(RecordId parentId, RecordId valueId, Type<?> type) Parse a value racrod

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentParser

public SegmentParser()

Method Detail

parseNode

public SegmentParser.NodeInfo parseNode(RecordId nodeId)

Parse a node record

Parameters:

nodeId -

Returns:

parseTemplate

public SegmentParser.TemplateInfo parseTemplate(RecordId templateId)

Parse a template record

Parameters:

templateId -

Returns:

parseMap

public SegmentParser.MapInfo parseMap(RecordId parentId,
                                      RecordId mapId,
                                      org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Parse a map record

Parameters:

parentId - parent of this map or null if none

mapId -

map -

Returns:

parseMapDiff

public SegmentParser.MapInfo parseMapDiff(RecordId mapId,
                                          org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Parse a map diff record

Parameters:

mapId -

map -

Returns:

parseMapLeaf

public SegmentParser.MapInfo parseMapLeaf(RecordId mapId,
                                          org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Parse a map leaf record

Parameters:

mapId -

map -

Returns:

parseMapBranch

public SegmentParser.MapInfo parseMapBranch(RecordId mapId,
                                            org.apache.jackrabbit.oak.plugins.segment.MapRecord map)

Parse a map branch record

Parameters:

mapId -

map -

Returns:

parseProperty

public SegmentParser.PropertyInfo parseProperty(RecordId parentId,
                                                RecordId propertyId,
                                                org.apache.jackrabbit.oak.plugins.segment.PropertyTemplate template)

Parse a property

Parameters:

parentId -

propertyId -

template -

Returns:

parseValue

public SegmentParser.ValueInfo parseValue(RecordId parentId,
                                          RecordId valueId,
                                          Type<?> type)

Parse a value racrod

Parameters:

parentId - parent of the value record, null if none

valueId -

type -

Returns:

parseBlob

public SegmentParser.BlobInfo parseBlob(RecordId blobId)

Parse a blob record

Parameters:

blobId -

Returns:

parseString

public SegmentParser.BlobInfo parseString(RecordId stringId)

Parse a string record

Parameters:

stringId -

Returns:

parseList

public SegmentParser.ListInfo parseList(RecordId parentId,
                                        RecordId listId,
                                        int count)

Parse a list record

Parameters:

parentId - parent of the list, null if none

listId -

count -

Returns:

parseListBucket

public SegmentParser.ListBucketInfo parseListBucket(RecordId listId,
                                                    int index,
                                                    int count,
                                                    int capacity)

Parse item of list buckets

Parameters:

listId -

index - index of the first item to parse

count - number of items to parse

capacity - total number of items

Returns: