Package org.apache.jackrabbit.oak.segment

Class SegmentParser

java.lang.Object

org.apache.jackrabbit.oak.segment.SegmentParser

Direct Known Subclasses:

RecordUsageAnalyser

public class SegmentParser
extends 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	Description
static class	SegmentParser.BlobInfo	Return type of parseBlob(RecordId).
static enum	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	Description
SegmentParser(@NotNull SegmentReader reader)

Method Summary

Modifier and Type	Method	Description
protected void	onBlob(RecordId parentId, RecordId blobId)	Callback called by parseValue(RecordId, RecordId, Type) upon encountering a blob.
protected void	onList(RecordId parentId, RecordId listId, int count)	Callback called by parseNode(RecordId), parseProperty(RecordId, RecordId, PropertyTemplate), parseTemplate(RecordId), parseBlob(RecordId) and parseString(RecordId) upon encountering a list.
protected void	onListBucket(RecordId parentId, RecordId listId, int index, int count, int capacity)	Callback called by parseList(RecordId, RecordId, int) and parseListBucket(RecordId, int, int, int) upon encountering a list bucket.
protected void	onMap(RecordId parentId, RecordId mapId, MapRecord map)	Callback called by parseNode(RecordId), parseMapDiff(RecordId, MapRecord) and parseMapBranch(RecordId, MapRecord) upon encountering a map.
protected void	onMapBranch(RecordId parentId, RecordId mapId, MapRecord map)	Callback called by parseMap(RecordId, RecordId, MapRecord) upon encountering a map branch.
protected void	onMapDiff(RecordId parentId, RecordId mapId, MapRecord map)	Callback called by parseMap(RecordId, RecordId, MapRecord) upon encountering a map diff.
protected void	onMapLeaf(RecordId parentId, RecordId mapId, MapRecord map)	Callback called by parseMap(RecordId, RecordId, MapRecord) upon encountering a map leaf.
protected void	onNode(RecordId parentId, RecordId nodeId)	Callback called by parseNode(RecordId) upon encountering a child node.
protected void	onProperty(RecordId parentId, RecordId propertyId, PropertyTemplate template)	Callback called by parseNode(RecordId) upon encountering a property.
protected void	onString(RecordId parentId, RecordId stringId)	Callback called by parseTemplate(RecordId), parseMapLeaf(RecordId, MapRecord) and parseValue(RecordId, RecordId, Type) upon encountering a string.
protected void	onTemplate(RecordId parentId, RecordId templateId)	Callback called by parseNode(RecordId) upon encountering a template
protected void	onValue(RecordId parentId, RecordId valueId, Type<?> type)	Callback called by parseProperty(RecordId, RecordId, PropertyTemplate) upon encountering a value.
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, MapRecord map)	Parse a map record
SegmentParser.MapInfo	parseMapBranch(RecordId mapId, MapRecord map)	Parse a map branch record
SegmentParser.MapInfo	parseMapDiff(RecordId mapId, MapRecord map)	Parse a map diff record
SegmentParser.MapInfo	parseMapLeaf(RecordId mapId, MapRecord map)	Parse a map leaf record
SegmentParser.NodeInfo	parseNode(RecordId nodeId)	Parse a node record
SegmentParser.PropertyInfo	parseProperty(RecordId parentId, RecordId propertyId, 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 record

Methods inherited from class java.lang.Object

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

Constructor Details

SegmentParser

public SegmentParser(@NotNull
 @NotNull SegmentReader reader)

Method Details

onNode

protected void onNode(RecordId parentId,
 RecordId nodeId)

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

Parameters:

parentId - id of the parent node

nodeId - if of the child node

onTemplate

protected void onTemplate(RecordId parentId,
 RecordId templateId)

Callback called by parseNode(RecordId) upon encountering a template

Parameters:

parentId - id of the node being parsed

templateId - id of the template

onMap

protected void onMap(RecordId parentId,
 RecordId mapId,
 MapRecord map)

Callback called by parseNode(RecordId), parseMapDiff(RecordId, MapRecord) and parseMapBranch(RecordId, MapRecord) upon encountering a map.

Parameters:

parentId - the id of the parent of the map

mapId - the id of the map

map - the map

onMapDiff

protected void onMapDiff(RecordId parentId,
 RecordId mapId,
 MapRecord map)

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

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,
 MapRecord map)

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

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,
 MapRecord map)

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

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,
 PropertyTemplate template)

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

Parameters:

parentId - the id of the parent node

propertyId - the id of the property

template - the property template

onValue

protected void onValue(RecordId parentId,
 RecordId valueId,
 Type<?> type)

Callback called by parseProperty(RecordId, RecordId, PropertyTemplate) upon encountering a value.

Parameters:

parentId - the id the value's parent

valueId - the id of the value

type - the type of the value

onBlob

protected void onBlob(RecordId parentId,
 RecordId blobId)

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

Parameters:

parentId - the id of the blob's parent

blobId - the id of the blob

onString

protected void onString(RecordId parentId,
 RecordId stringId)

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

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)

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

Parameters:

parentId - the id of the list's parent

listId - the id of the list

count - the number of elements in the list

onListBucket

protected void onListBucket(RecordId parentId,
 RecordId listId,
 int index,
 int count,
 int capacity)

Callback called by parseList(RecordId, RecordId, int) and parseListBucket(RecordId, int, int, int) upon encountering a list bucket.

Parameters:

parentId - the id of the list's parent

listId - the id of the list

index - the index into the bucket

count - the number of items in the bucket

capacity - the capacity of the bucket

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,
 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,
 MapRecord map)

Parse a map diff record

Parameters:

mapId -

map -

Returns:

parseMapLeaf

public SegmentParser.MapInfo parseMapLeaf(RecordId mapId,
 MapRecord map)

Parse a map leaf record

Parameters:

mapId -

map -

Returns:

parseMapBranch

public SegmentParser.MapInfo parseMapBranch(RecordId mapId,
 MapRecord map)

Parse a map branch record

Parameters:

mapId -

map -

Returns:

parseProperty

public SegmentParser.PropertyInfo parseProperty(RecordId parentId,
 RecordId propertyId,
 PropertyTemplate template)

Parse a property

Parameters:

parentId -

propertyId -

template -

Returns:

parseValue

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

Parse a value record

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: