Package org.ametys.cms.repository.comment

Class Comment

java.lang.Object

org.ametys.cms.repository.comment.AbstractComment

org.ametys.cms.repository.comment.Comment

All Implemented Interfaces:

ReactionableObject, ReportableObject

public class Comment
extends AbstractComment

A comment on a CommentableAmetysObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.repository.ReactionableObject

ReactionableObject.ReactionType

Field Summary

Fields inherited from class org.ametys.cms.repository.comment.AbstractComment

_commentComposite, _id, _rootDataHolder, COMMENT_NAME_PREFIX, ID_SEPARATOR, METADATA_COMMENT_AUTHOR, METADATA_COMMENT_AUTHOREMAIL, METADATA_COMMENT_AUTHOREMAIL_HIDDEN, METADATA_COMMENT_AUTHORNAME, METADATA_COMMENT_AUTHORURL, METADATA_COMMENT_CONTENT, METADATA_COMMENT_CREATIONDATE, METADATA_COMMENT_IS_ACCEPTED, METADATA_COMMENT_IS_DELETED, METADATA_COMMENT_IS_EDITED, METADATA_COMMENT_LAST_MODIFICATION_DATE, METADATA_COMMENT_VALIDATED, METADATA_COMMENTS_NOTVALIDATED, METADATA_COMMENTS_VALIDATED, REFERENCED_COMMENT_DATA_NAME, SUB_COMMENTS_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
Comment(Comment comment)	Creates a new sub comment of the comment
Comment(Comment comment, String commentId, ZonedDateTime creationDate)	Creates a new sub comment of the comment, with the given id and creation date This method allow to create a sub comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.
Comment(Comment parentComment, AbstractComment refComment)	Creates a reference comment of the comment, with the given comment
Comment(ModifiableDataHolder dataHolder)	Creates a new comment
Comment(ModifiableDataHolder rootDataHolder, String commentId)	Retrieves a comment by its id
Comment(ModifiableDataHolder dataHolder, String commentId, ZonedDateTime creationDate)	Creates a new comment, with the given id and creation date This method allows to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.

Method Summary

Modifier and Type	Method	Description
Comment	createReferencedComment(AbstractComment comment)	Creates a referenced comment from this comment, with the given comment
Comment	createSubComment()	Create sub comment from this comment
Comment	createSubComment(String commentId, ZonedDateTime creationDate)	Creates a sub comment from this comment, with the given id and creation date This method allow to create a sub comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted.
Collection<UserIdentity>	extractMentions()	Extract users mentioned in the comment
static Comment	getComment(ModifiableDataHolder rootDataHolder, String commentId)	Get a comment
Comment	getCommentParent()	Get parent of comment if exists
static List<Comment>	getComments(Comment parentComment, boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the sub comments of the given comment
static List<Comment>	getComments(Comment parentComment, boolean includeNotValidatedComments, boolean includeValidatedComments, boolean withSubComment)	Get the sub comments of the given comment
static List<Comment>	getComments(ModifiableDataHolder rootDataHolder, boolean includeNotValidatedComments, boolean includeValidatedComments)	Get the comments in the given root data holder
static List<Comment>	getComments(ModifiableDataHolder rootDataHolder, boolean includeNotValidatedComments, boolean includeValidatedComments, boolean isRecursive)	Get the comments in the given root data holder
Comment	getReferencedComment()	Get the referenced comment of the comment
List<Comment>	getSubComment(boolean includeNotValidatedComments, boolean includeValidatedComments)	Get sub comments of the comment
protected void	update()	Update the comment tag statistics

Methods inherited from class org.ametys.cms.repository.comment.AbstractComment

addReaction, addReport, clearReports, getAuthor, getAuthorEmail, getAuthorName, getAuthorURL, getCommentDataPath, getComments, getComments, getComments, getComments, getContent, getCreationDate, getId, getLastModificationDate, getReactionUsers, getReferencedComment, getReportsCount, getRepositoryData, hasSubComments, isAccepted, isDeleted, isEdited, isEmailHidden, isSubComment, isValidated, remove, removeReaction, setAccepted, setAuthor, setAuthorEmail, setAuthorName, setAuthorURL, setContent, setDeleted, setEdited, setEmailHiddenStatus, setLastModificationDate, setReportsCount, setValidated

Methods inherited from class java.lang.Object

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

Constructor Details

Comment

public Comment(ModifiableDataHolder rootDataHolder,
 String commentId)

Retrieves a comment by its id

Parameters:

rootDataHolder - The root data holder hosting the first level of comments

commentId - The id of the comment to retrieve

Throws:

AmetysRepositoryException - if an error occurred

Comment

public Comment(ModifiableDataHolder dataHolder)

Creates a new comment

Parameters:

dataHolder - The data holder where to add the new comment

Comment

public Comment(ModifiableDataHolder dataHolder,
 String commentId,
 ZonedDateTime creationDate)

Creates a new comment, with the given id and creation date This method allows to create a comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Parameters:

dataHolder - The data holder where to add the new comment

commentId - the comment's id

creationDate - the comment's creation date

Comment

public Comment(Comment comment)

Creates a new sub comment of the comment

Parameters:

comment - The parent comment

Comment

public Comment(Comment comment,
 String commentId,
 ZonedDateTime creationDate)

Creates a new sub comment of the comment, with the given id and creation date This method allow to create a sub comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Parameters:

comment - The parent comment

commentId - the sub comment's id

creationDate - the sub comment's creation date

Comment

public Comment(Comment parentComment,
 AbstractComment refComment)

Creates a reference comment of the comment, with the given comment

Parameters:

parentComment - The parent comment

refComment - the referenced comment

Method Details

getComment

public static Comment getComment(ModifiableDataHolder rootDataHolder,
 String commentId)
                          throws AmetysRepositoryException

Get a comment

Parameters:

rootDataHolder - The root data holder of the first level of comments

commentId - The comment identifier

Returns:

The comment

Throws:

AmetysRepositoryException - if the comment does not exist

getComments

public static List<Comment> getComments(Comment parentComment,
 boolean includeNotValidatedComments,
 boolean includeValidatedComments)
                                 throws AmetysRepositoryException

Get the sub comments of the given comment

Parameters:

parentComment - The parent comment

includeNotValidatedComments - True to include the comments that are not validated

includeValidatedComments - True to include the comments that are validated

Returns:

the list of sub comments

Throws:

AmetysRepositoryException - If an error occurred

getComments

public static List<Comment> getComments(Comment parentComment,
 boolean includeNotValidatedComments,
 boolean includeValidatedComments,
 boolean withSubComment)
                                 throws AmetysRepositoryException

Get the sub comments of the given comment

Parameters:

parentComment - The parent comment

includeNotValidatedComments - True to include the comments that are not validated

includeValidatedComments - True to include the comments that are validated

withSubComment - true if we want to get all child comments

Returns:

the list of comments

Throws:

AmetysRepositoryException - If an error occurred

getComments

public static List<Comment> getComments(ModifiableDataHolder rootDataHolder,
 boolean includeNotValidatedComments,
 boolean includeValidatedComments)
                                 throws AmetysRepositoryException

Get the comments in the given root data holder

Parameters:

rootDataHolder - The root data holder

includeNotValidatedComments - True to include the comments that are not validated

includeValidatedComments - True to include the comments that are validated

Returns:

the list of comments

Throws:

AmetysRepositoryException - If an error occurred

getComments

public static List<Comment> getComments(ModifiableDataHolder rootDataHolder,
 boolean includeNotValidatedComments,
 boolean includeValidatedComments,
 boolean isRecursive)
                                 throws AmetysRepositoryException

Get the comments in the given root data holder

Parameters:

rootDataHolder - The root data holder

includeNotValidatedComments - True to include the comments that are not validated

includeValidatedComments - True to include the comments that are validated

isRecursive - true if we want to have sub comments

Returns:

the list of comments

Throws:

AmetysRepositoryException - If an error occurred

update

protected void update()

Description copied from class: AbstractComment

Update the comment tag statistics

Specified by:

update in class AbstractComment

getCommentParent

public Comment getCommentParent()

Description copied from class: AbstractComment

Get parent of comment if exists

Specified by:

getCommentParent in class AbstractComment

Returns:

the comment parent. null if the comment is not a sub comment

getSubComment

public List<Comment> getSubComment(boolean includeNotValidatedComments,
 boolean includeValidatedComments)

Description copied from class: AbstractComment

Get sub comments of the comment

Specified by:

getSubComment in class AbstractComment

Parameters:

includeNotValidatedComments - True to include the comments that are not validated

includeValidatedComments - True to include the comments that are validated

Returns:

the list of comments

getReferencedComment

public Comment getReferencedComment()

Description copied from class: AbstractComment

Get the referenced comment of the comment

Specified by:

getReferencedComment in class AbstractComment

Returns:

the referenced comment

createSubComment

public Comment createSubComment()

Create sub comment from this comment

Specified by:

createSubComment in class AbstractComment

Returns:

the sub comment

createSubComment

public Comment createSubComment(String commentId,
 ZonedDateTime creationDate)

Description copied from class: AbstractComment

Creates a sub comment from this comment, with the given id and creation date This method allow to create a sub comment from existing data (ex: data import from archive) The id is not generated here, the source is trusted. Be careful using this method

Specified by:

createSubComment in class AbstractComment

Parameters:

commentId - the comment's id

creationDate - the comment's creation date

Returns:

the new comment

createReferencedComment

public Comment createReferencedComment(AbstractComment comment)

Description copied from class: AbstractComment

Creates a referenced comment from this comment, with the given comment

Specified by:

createReferencedComment in class AbstractComment

Parameters:

comment - the comment to reference

Returns:

the referenced comment

extractMentions

public Collection<UserIdentity> extractMentions()

Extract users mentioned in the comment

Returns:

the mentioned users