org.ametys.cms.repository.comment

Class Comment

java.lang.Object

org.ametys.cms.repository.comment.Comment

All Implemented Interfaces:

ReactionableObject

public class Comment
extends Object
implements ReactionableObject

A comment on a commentable content

Nested Class Summary

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

ReactionableObject.ReactionType

Field Summary

Fields

Modifier and Type	Field and Description
protected ModifiableCompositeMetadata	_contentMetadataHolder The content to comment
protected String	_id The id of the comment (unique in the content)
protected ModifiableCompositeMetadata	_metadata The metadata node of the comment
static String	ID_SEPARATOR Constants for the separator
static String	METADATA_COMMENT_AUTHOREMAIL Constants for author email Metadata
static String	METADATA_COMMENT_AUTHOREMAIL_HIDDEN Constants for author email hidden Metadata
static String	METADATA_COMMENT_AUTHORNAME Constants for author name Metadata
static String	METADATA_COMMENT_AUTHORURL Constants for author url Metadata
static String	METADATA_COMMENT_CONTENT Constants for the content Metadata
static String	METADATA_COMMENT_CREATIONDATE Constants for creation Metadata
static String	METADATA_COMMENT_NB_REPORTERS Constants for the number of reporters Metadata
static String	METADATA_COMMENT_VALIDATED Constants for the validated status Metadata
static String	METADATA_COMMENTS Constants for comments Metadat*
static String	METADATA_COMMENTS_NOTVALIDATED Constants for comments Metadata validated
static String	METADATA_COMMENTS_VALIDATED Constants for comments Metadata not validted

Constructor Summary

Constructors

Constructor and Description
Comment(Comment comment) Creates a new sub comment of the comment
Comment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder) Creates a new comment on the content
Comment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder, String commentId) Retrieves a comment by its id

Method Summary

Modifier and Type	Method and Description
void	addReaction(UserIdentity user, ReactionableObject.ReactionType reactionType) Add the user reaction
Comment	createSubComment() Create sub comment from this comment
String	getAuthorEmail() Get the email of the author.
String	getAuthorName() Get the readable name of the author.
String	getAuthorURL() Get the url given by the author as its personnal site url.
static Comment	getComment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder, String commentId) Get a comment
static List<Comment>	getComments(Comment parentComment, boolean includeNotValidatedComments, boolean includeValidatedComments) Get the comments of a content
static List<Comment>	getComments(Comment parentComment, boolean includeNotValidatedComments, boolean includeValidatedComments, boolean withSubComment) Get the comments of a content
static List<Comment>	getComments(ModifiableCompositeMetadata contentUnversionnedMetadataHolder, boolean includeNotValidatedComments, boolean includeValidatedComments) Get the comments of a content
static List<Comment>	getComments(ModifiableCompositeMetadata contentUnversionnedMetadataHolder, boolean includeNotValidatedComments, boolean includeValidatedComments, boolean isRecursive) Get the comments of a content
String	getContent() Get the content of the comment.
ModifiableCompositeMetadata	getContentMetadata() Get the composite metadata object holding the content
Date	getCreationDate() Get the date and time the comment was created
String	getId() The comment id (unique to the content)
ModifiableCompositeMetadata	getMetadata() Get the composite metadata object holding the comment
Long	getNbReporters() Get the number of reporters
List<UserIdentity>	getReactionUsers(ReactionableObject.ReactionType reactionType) Get the list of users who react
List<Comment>	getSubComment(boolean includeNotValidatedComments, boolean includeValidatedComments) Get sub comments of the comment
Long	increaseNbReporters() Increase the number of reporters
boolean	isEmailHidden() Does the email of the authors have to be hidden ?
boolean	isValidated() Is the comment validated
void	remove() Remove the comment.
void	removeReaction(UserIdentity user, ReactionableObject.ReactionType reactionType) Remove the user reaction
void	resetNbReporters() Reset to 0 the number of reporters
void	setAuthorEmail(String email) Set the email of the author.
void	setAuthorName(String name) Set the readable name of the author.
void	setAuthorURL(String url) Set the personnal site url of the author
void	setContent(String content) Set the content of the comment.
void	setEmailHiddenStatus(boolean hideEmail) Set the email hidden status.
void	setValidated(boolean validated) Set the validation status of the comment
protected void	update() Update the comment tag statistics

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_COMMENTS

public static final String METADATA_COMMENTS

Constants for comments Metadat*

See Also:

Constant Field Values

METADATA_COMMENTS_VALIDATED

public static final String METADATA_COMMENTS_VALIDATED

Constants for comments Metadata not validted

See Also:

Constant Field Values

METADATA_COMMENTS_NOTVALIDATED

public static final String METADATA_COMMENTS_NOTVALIDATED

Constants for comments Metadata validated

See Also:

Constant Field Values

METADATA_COMMENT_CREATIONDATE

public static final String METADATA_COMMENT_CREATIONDATE

Constants for creation Metadata

See Also:

Constant Field Values

METADATA_COMMENT_AUTHORNAME

public static final String METADATA_COMMENT_AUTHORNAME

Constants for author name Metadata

See Also:

Constant Field Values

METADATA_COMMENT_AUTHOREMAIL

public static final String METADATA_COMMENT_AUTHOREMAIL

Constants for author email Metadata

See Also:

Constant Field Values

METADATA_COMMENT_AUTHOREMAIL_HIDDEN

public static final String METADATA_COMMENT_AUTHOREMAIL_HIDDEN

Constants for author email hidden Metadata

See Also:

Constant Field Values

METADATA_COMMENT_AUTHORURL

public static final String METADATA_COMMENT_AUTHORURL

Constants for author url Metadata

See Also:

Constant Field Values

METADATA_COMMENT_CONTENT

public static final String METADATA_COMMENT_CONTENT

Constants for the content Metadata

See Also:

Constant Field Values

METADATA_COMMENT_VALIDATED

public static final String METADATA_COMMENT_VALIDATED

Constants for the validated status Metadata

See Also:

Constant Field Values

METADATA_COMMENT_NB_REPORTERS

public static final String METADATA_COMMENT_NB_REPORTERS

Constants for the number of reporters Metadata

See Also:

Constant Field Values

ID_SEPARATOR

public static final String ID_SEPARATOR

Constants for the separator

See Also:

Constant Field Values

_contentMetadataHolder

protected ModifiableCompositeMetadata _contentMetadataHolder

The content to comment

_metadata

protected ModifiableCompositeMetadata _metadata

The metadata node of the comment

_id

protected String _id

The id of the comment (unique in the content)

Constructor Detail

Comment

public Comment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder,
               String commentId)

Retrieves a comment by its id

Parameters:

contentUnversionnedMetadataHolder - The unversionned metadate holder of the content hosting the comment

commentId - The id of the comment to retrieve

Throws:

AmetysRepositoryException - if an error occured

Comment

public Comment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder)

Creates a new comment on the content

Parameters:

contentUnversionnedMetadataHolder - The unversionned metadate holder of the content where to add the new comment

Comment

public Comment(Comment comment)

Creates a new sub comment of the comment

Parameters:

comment - The parent comment

Method Detail

getMetadata

public ModifiableCompositeMetadata getMetadata()

Get the composite metadata object holding the comment

Returns:

the composite metadata

getContentMetadata

public ModifiableCompositeMetadata getContentMetadata()

Get the composite metadata object holding the content

Returns:

the content composite metadata

getId

public String getId()

The comment id (unique to the content)

Returns:

The id. Cannot be null.

getCreationDate

public Date getCreationDate()

Get the date and time the comment was created

Returns:

The non null date of creation of the comment.

getAuthorName

public String getAuthorName()

Get the readable name of the author.

Returns:

The full name. Can be null.

setAuthorName

public void setAuthorName(String name)

Set the readable name of the author.

Parameters:

name - The full name. Can be null to remove the name.

getAuthorEmail

public String getAuthorEmail()

Get the email of the author.

Returns:

The ameil. Can be null.

setAuthorEmail

public void setAuthorEmail(String email)

Set the email of the author.

Parameters:

email - The email. Can be null to remove the email.

getAuthorURL

public String getAuthorURL()

Get the url given by the author as its personnal site url.

Returns:

The url. Can be null.

setAuthorURL

public void setAuthorURL(String url)

Set the personnal site url of the author

Parameters:

url - The url. Can be null to remove url.

isEmailHidden

public boolean isEmailHidden()

Does the email of the authors have to be hidden ?

Returns:

true (default value) if the email does not have to appears to others users. Can still be used for administration.

setEmailHiddenStatus

public void setEmailHiddenStatus(boolean hideEmail)

Set the email hidden status.

Parameters:

hideEmail - true to set the email as hidden.

getContent

public String getContent()

Get the content of the comment. A simple String (with \n or \t).

Returns:

The content. Can be null.

setContent

public void setContent(String content)

Set the content of the comment.

Parameters:

content - The content to set. Can be null to remove the content. Have to be a simple String (with \n or \t).

isValidated

public boolean isValidated()

Is the comment validated

Returns:

the status of validation of the comment

setValidated

public void setValidated(boolean validated)

Set the validation status of the comment

Parameters:

validated - true the comment is validated

resetNbReporters

public void resetNbReporters()

Reset to 0 the number of reporters

increaseNbReporters

public Long increaseNbReporters()

Increase the number of reporters

Returns:

the increase number of reporters

getNbReporters

public Long getNbReporters()

Get the number of reporters

Returns:

the number of reporters

remove

public void remove()

Remove the comment.

getSubComment

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

Get sub comments of the comment

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

createSubComment

public Comment createSubComment()

Create sub comment from this comment

Returns:

the sub comment

update

protected void update()

Update the comment tag statistics

getComment

public static Comment getComment(ModifiableCompositeMetadata contentUnversionnedMetadataHolder,
                                 String commentId)
                          throws AmetysRepositoryException

Get a comment

Parameters:

contentUnversionnedMetadataHolder - the content

commentId - The comment

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 comments of a content

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 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 comments of a content

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(ModifiableCompositeMetadata contentUnversionnedMetadataHolder,
                                        boolean includeNotValidatedComments,
                                        boolean includeValidatedComments)
                                 throws AmetysRepositoryException

Get the comments of a content

Parameters:

contentUnversionnedMetadataHolder - The content unversionned metadata 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(ModifiableCompositeMetadata contentUnversionnedMetadataHolder,
                                        boolean includeNotValidatedComments,
                                        boolean includeValidatedComments,
                                        boolean isRecursive)
                                 throws AmetysRepositoryException

Get the comments of a content

Parameters:

contentUnversionnedMetadataHolder - The content unversionned metadata 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

addReaction

public void addReaction(UserIdentity user,
                        ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Add the user reaction

Specified by:

addReaction in interface ReactionableObject

Parameters:

user - the user

reactionType - the reaction type

removeReaction

public void removeReaction(UserIdentity user,
                           ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Remove the user reaction

Specified by:

removeReaction in interface ReactionableObject

Parameters:

user - the user

reactionType - the reaction type

getReactionUsers

public List<UserIdentity> getReactionUsers(ReactionableObject.ReactionType reactionType)

Description copied from interface: ReactionableObject

Get the list of users who react

Specified by:

getReactionUsers in interface ReactionableObject

Parameters:

reactionType - the reaction type

Returns:

the list of users