org.ametys.cms.repository.comment

Class Comment

java.lang.Object

org.ametys.cms.repository.comment.Comment

public class Comment
extends Object

A comment on a commentable content

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	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_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(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
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(ModifiableCompositeMetadata contentUnversionnedMetadataHolder, boolean includeNotValidatedComments, boolean includeValidatedComments) Get the comments of a content
String	getContent() Get the content of the comment.
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
boolean	isEmailHidden() Does the email of the authors have to be hidden ?
boolean	isValidated() Is the comment validated
void	remove() Remove the comment.
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

_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

Method Detail

getMetadata

public ModifiableCompositeMetadata getMetadata()

Get the composite metadata object holding the comment

Returns:

the comment

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

remove

public void remove()

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

Get the comments of a content

Parameters:

contentUnversionnedMetadataHolder - The content to update

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