Package com.atlassian.confluence.plugins.edgeindex

Class DefaultEdgeDocumentFactory

java.lang.Object

com.atlassian.confluence.plugins.edgeindex.DefaultEdgeDocumentFactory

All Implemented Interfaces:

EdgeDocumentFactory

@Component
public class DefaultEdgeDocumentFactory
extends Object
implements EdgeDocumentFactory

This factory class builds an AtlassianDocument instance based on different information such as' the edge, date, content and current authenticated user.

Since:

7.17

Constructor Summary

Constructors

Constructor	Description
DefaultEdgeDocumentFactory(ContentPermissionCalculator contentPermissionCalculator)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEdgeDocumentFactory

@Autowired
public DefaultEdgeDocumentFactory(ContentPermissionCalculator contentPermissionCalculator)

Method Detail

buildDocument

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

Description copied from interface: EdgeDocumentFactory

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

Specified by:

buildDocument in interface EdgeDocumentFactory

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