Package com.atlassian.confluence.plugins.edgeindex

Interface EdgeDocumentFactory

All Known Implementing Classes:

DefaultEdgeDocumentFactory

public interface EdgeDocumentFactory

Responsible for creating an Atlassian document that represents an edge.

Method Summary

Modifier and Type	Method	Description
AtlassianDocument	buildDocument(String edgeId, com.atlassian.sal.api.user.UserKey userKey, ContentEntityObject target, Date date, String edgeTypeKey)	Build the AtlassianDocument which will be stored as an edge index document

Method Detail

buildDocument

AtlassianDocument buildDocument(String edgeId,
                                com.atlassian.sal.api.user.UserKey userKey,
                                ContentEntityObject target,
                                Date date,
                                String edgeTypeKey)

Build the AtlassianDocument which will be stored as an edge index document

Parameters:

edgeId - the edge ID

userKey - the user key

target - the target object (usually a page, blog post or comment)

date - the date when this edge index is created

edgeTypeKey - the edge type

Returns:

the AtlassianDocument representing the edge index document