public class

ChangeDocumentIdBuilder

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.search.lucene.ChangeDocumentIdBuilder

Class Overview

This class is used to generate the ids used to identify change documents and groups of change document in the Lucene index

Summary

Public Constructors
ChangeDocumentIdBuilder()
Public Methods
String getChangeDocumentAndAuthorId(Searchable entityObject)
Creates an id that uniquely identifies a change document in the index.
String getGroupId(Searchable searchable)
Creates an id that uniquely identifies a group of change documents in the index.
String getGroupId(Handle handle)
Creates an id that uniquely identifies a group of change documents in the index.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ChangeDocumentIdBuilder ()

Public Methods

public String getChangeDocumentAndAuthorId (Searchable entityObject)

Creates an id that uniquely identifies a change document in the index. The format of the id is "-", for example "com.atlassian.confluence.pages.Page-123-foo"

public String getGroupId (Searchable searchable)

Creates an id that uniquely identifies a group of change documents in the index. The format of the id is "", for example "com.atlassian.confluence.pages.Page-123"

Parameters
searchable an entity.

public String getGroupId (Handle handle)

Creates an id that uniquely identifies a group of change documents in the index. The format of the id is "", for example "com.atlassian.confluence.pages.Page-123"

Parameters
handle the handle of an entity. Note:If the referenced entity is an instance of Versioned it expects the handle for the latest version of that entity