com.atlassian.confluence.search.lucene

Class ChangeDocumentIdBuilder

java.lang.Object

com.atlassian.confluence.search.lucene.ChangeDocumentIdBuilder

public class ChangeDocumentIdBuilder
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ChangeDocumentIdBuilder()

Method Summary

Modifier and Type	Method and Description
String	getChangeDocumentAndAuthorId(com.atlassian.bonnie.Searchable entityObject) Creates an id that uniquely identifies a change document in the index.
String	getGroupId(com.atlassian.bonnie.Handle handle) Creates an id that uniquely identifies a group of change documents in the index.
String	getGroupId(com.atlassian.bonnie.Searchable searchable) Creates an id that uniquely identifies a group of change documents in the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeDocumentIdBuilder

public ChangeDocumentIdBuilder()

Method Detail

getChangeDocumentAndAuthorId

public String getChangeDocumentAndAuthorId(com.atlassian.bonnie.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"

getGroupId

public String getGroupId(com.atlassian.bonnie.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

getGroupId

public String getGroupId(com.atlassian.bonnie.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.