Package org.onehippo.forge.document.commenting.cms.impl

Class DefaultJcrCommentPersistenceManager

java.lang.Object

org.onehippo.forge.document.commenting.cms.impl.DefaultJcrCommentPersistenceManager

All Implemented Interfaces:

Serializable, CommentPersistenceManager

public class DefaultJcrCommentPersistenceManager
extends Object
implements CommentPersistenceManager

CommentPersistenceManager implementation which stores data into JCR repository.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COMMENTS_LOCATION
static final String	NT_COMMENT
static final String	NT_COMMENTS_CONTAINER
static final String	PROP_AUTHOR
static final String	PROP_CONTENT
static final String	PROP_CREATED
static final String	PROP_LAST_MODIFIED
static final String	PROP_SUBJECTID

Constructor Summary

Constructors

Constructor	Description
DefaultJcrCommentPersistenceManager()

Method Summary

Modifier and Type	Method	Description
protected void	bindCommentNode(Node commentNode, CommentItem commentItem)
String	createCommentItem(CommentingContext commentingContext, CommentItem commentItem)	Create comment data item based on given commentItem.
protected Query	createLatestCommentItemsReadQuery(CommentingContext commentingContext, String subjectId, long offset, long limit)
void	deleteCommentItem(CommentingContext commentingContext, CommentItem commentItem)	Deletes comment data item based on information given by commentItem.
protected String	getAuthorName(CommentItem commentItem)
String	getCommentBodyText(CommentingContext commentingContext, CommentItem commentItem)	Gets comment body text to display in user interface from commentItem.
String	getCommentBodyTooltip(CommentingContext commentingContext, CommentItem commentItem)	Gets comment body tooltip text to display in user interface from commentItem.
String	getCommentHeadText(CommentingContext commentingContext, CommentItem commentItem)	Gets comment header text to display in user interface from commentItem.
String	getCommentHeadTooltip(CommentingContext commentingContext, CommentItem commentItem)	Gets comment header tooltip text to display in user interface from commentItem.
CommentItem	getCommentItemById(CommentingContext commentingContext, String commentId)	Retrieves a comment data item by commentId.
protected String	getDateFormat(CommentingContext commentingContext)
List<CommentItem>	getLatestCommentItemsBySubjectId(CommentingContext commentingContext, String subjectId, long offset, long limit)	Retrieves command data by subjectId, offset and limit.
protected Session	getSession()
protected void	mapCommentItem(CommentItem commentItem, Node commentNode)
void	updateCommentItem(CommentingContext commentingContext, CommentItem commentItem)	Updates comment data item by commentItem.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_COMMENTS_LOCATION

public static final String DEFAULT_COMMENTS_LOCATION

See Also:

• Constant Field Values

NT_COMMENTS_CONTAINER

public static final String NT_COMMENTS_CONTAINER

See Also:

• Constant Field Values

NT_COMMENT

public static final String NT_COMMENT

See Also:

• Constant Field Values

PROP_SUBJECTID

public static final String PROP_SUBJECTID

See Also:

• Constant Field Values

PROP_AUTHOR

public static final String PROP_AUTHOR

See Also:

• Constant Field Values

PROP_CREATED

public static final String PROP_CREATED

See Also:

• Constant Field Values

PROP_LAST_MODIFIED

public static final String PROP_LAST_MODIFIED

See Also:

• Constant Field Values

PROP_CONTENT

public static final String PROP_CONTENT

See Also:

• Constant Field Values

Constructor Details

DefaultJcrCommentPersistenceManager

public DefaultJcrCommentPersistenceManager()

Method Details

getCommentItemById

public CommentItem getCommentItemById(CommentingContext commentingContext,
 String commentId)
                               throws CommentingException

Description copied from interface: CommentPersistenceManager

Retrieves a comment data item by commentId.

Specified by:

getCommentItemById in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentId - the identifier of the comment data item

Returns:

CommentItem instance

Throws:

CommentingException - if any exception occurs while retrieving a comment data item

getLatestCommentItemsBySubjectId

public List<CommentItem> getLatestCommentItemsBySubjectId(CommentingContext commentingContext,
 String subjectId,
 long offset,
 long limit)
                                                   throws CommentingException

Description copied from interface: CommentPersistenceManager

Retrieves command data by subjectId, offset and limit.

Specified by:

getLatestCommentItemsBySubjectId in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

subjectId - the identifier of the subject data (e.g, document handle UUID).

offset - first item index of data

limit - max query item count limit

Returns:

list of comment data items

Throws:

CommentingException - if any exception occurs while retrieving comment data

createCommentItem

public String createCommentItem(CommentingContext commentingContext,
 CommentItem commentItem)
                         throws CommentingException

Description copied from interface: CommentPersistenceManager

Create comment data item based on given commentItem.

Specified by:

createCommentItem in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Returns:

the identifier of the newly created comment data item

Throws:

CommentingException - if any exception occurs while creating a comment data item

updateCommentItem

public void updateCommentItem(CommentingContext commentingContext,
 CommentItem commentItem)
                       throws CommentingException

Description copied from interface: CommentPersistenceManager

Updates comment data item by commentItem.

Specified by:

updateCommentItem in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Throws:

CommentingException - if any exception occurs while updating a comment data item

deleteCommentItem

public void deleteCommentItem(CommentingContext commentingContext,
 CommentItem commentItem)
                       throws CommentingException

Description copied from interface: CommentPersistenceManager

Deletes comment data item based on information given by commentItem.

Specified by:

deleteCommentItem in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Throws:

CommentingException - if any exception occurs while deleting a comment data item

getCommentHeadText

public String getCommentHeadText(CommentingContext commentingContext,
 CommentItem commentItem)
                          throws CommentingException

Description copied from interface: CommentPersistenceManager

Gets comment header text to display in user interface from commentItem.

Specified by:

getCommentHeadText in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Returns:

comment header text to display in user interface

Throws:

CommentingException - if any exception occurs while creating a comment data item

getCommentBodyText

public String getCommentBodyText(CommentingContext commentingContext,
 CommentItem commentItem)
                          throws CommentingException

Description copied from interface: CommentPersistenceManager

Gets comment body text to display in user interface from commentItem.

Specified by:

getCommentBodyText in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Returns:

comment body text to display in user interface

Throws:

CommentingException - if any exception occurs while creating a comment data item

getCommentHeadTooltip

public String getCommentHeadTooltip(CommentingContext commentingContext,
 CommentItem commentItem)
                             throws CommentingException

Description copied from interface: CommentPersistenceManager

Gets comment header tooltip text to display in user interface from commentItem. Null if tooltip is not needed to display.

Specified by:

getCommentHeadTooltip in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Returns:

comment header tooltip text to display in user interface. Null if tooltip is not needed to display.

Throws:

CommentingException - if any exception occurs while creating a comment data item

getCommentBodyTooltip

public String getCommentBodyTooltip(CommentingContext commentingContext,
 CommentItem commentItem)
                             throws CommentingException

Description copied from interface: CommentPersistenceManager

Gets comment body tooltip text to display in user interface from commentItem. Null if tooltip is not needed to display.

Specified by:

getCommentBodyTooltip in interface CommentPersistenceManager

Parameters:

commentingContext - commenting context instance

commentItem - comment data item object

Returns:

comment body tooltip text to display in user interface. Null if tooltip is not needed to display.

Throws:

CommentingException - if any exception occurs while creating a comment data item

getSession

protected Session getSession()

createLatestCommentItemsReadQuery

protected Query createLatestCommentItemsReadQuery(CommentingContext commentingContext,
 String subjectId,
 long offset,
 long limit)
                                           throws RepositoryException

Throws:

RepositoryException

mapCommentItem

protected void mapCommentItem(CommentItem commentItem,
 Node commentNode)
                       throws RepositoryException

Throws:

RepositoryException

bindCommentNode

protected void bindCommentNode(Node commentNode,
 CommentItem commentItem)
                        throws RepositoryException

Throws:

RepositoryException

getDateFormat

protected String getDateFormat(CommentingContext commentingContext)

getAuthorName

protected String getAuthorName(CommentItem commentItem)