com.adobe.cq.social.commons.comments.api

Class AbstractCommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.commons.comments.api.AbstractCommentCollection<C,T>

Type Parameters:

C - any SocialComponent type that extends the Comment data type.

All Implemented Interfaces:

CommentCollection<C,T>, SocialCollectionComponent, SocialComponent

Direct Known Subclasses:

AbstractFileLibrary, AbstractForum, AbstractReviewCollection

public abstract class AbstractCommentCollection<C extends Comment,T extends CommentCollectionConfiguration>
extends BaseSocialComponent
implements CommentCollection<C,T>

Base SocialComponentCollection class which maintains a list of Comment.

Field Summary

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractCommentCollection(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager commentListProviderManager) Constructor using the specified Resource which should be the root of the collection without paging specification.
AbstractCommentCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager commentListProviderManager) Construct a CommentCollection using the specified Resource which should be the root of the collection.
AbstractCommentCollection(ResourceID id, ResourceResolver resolver, ClientUtilities clientUtils, CommentSocialComponentListProviderManager commentListProviderManager) Constructor using the specified ResourceID which should be the root of the collection without paging specification.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAsMap()
T	getConfiguration() Get the configuration for this collection
java.util.Calendar	getCreated() Returns the moment in time this collection was created.
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
java.util.List<java.lang.Object>	getItems() Get the comments of this CommentCollection base on the pagination configuration.
java.util.Calendar	getLastModified() Returns the moment in time this collection was last modified.
boolean	getMayPost()
PageInfo	getPageInfo() Gets information about the pages for this collection.
int	getTotalSize() Get total size of the collection.
boolean	isTaggingAllowed() Checks if is tagging allowed.
void	setPagination(CollectionPagination pagination) Set the collection list range.
void	setSortedOrder(CollectionSortedOrder sortedOrder) Set the collection sorted order.
java.lang.String	toJSONString(boolean tidy)

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl

Constructor Detail

AbstractCommentCollection

public AbstractCommentCollection(ResourceID id,
                                 ResourceResolver resolver,
                                 ClientUtilities clientUtils,
                                 CommentSocialComponentListProviderManager commentListProviderManager)

Constructor using the specified ResourceID which should be the root of the collection without paging specification. Paging information is not created until the pagination is specified.

Parameters:

id - the resource id of the CommentCollection

resolver - the resource resolver used to obtain the resource in the JCR.

clientUtils - the clientUtils

commentListProviderManager - CommentSocialComponentListProviderManager

See Also:

setPagination(CollectionPagination)

AbstractCommentCollection

public AbstractCommentCollection(Resource resource,
                                 ClientUtilities clientUtils,
                                 CommentSocialComponentListProviderManager commentListProviderManager)

Constructor using the specified Resource which should be the root of the collection without paging specification. Paging information is not created until the pagination is specified.

Parameters:

resource - the resource.

clientUtils - the clientUtils

commentListProviderManager - CommentSocialComponentListProviderManager

See Also:

setPagination(CollectionPagination)

AbstractCommentCollection

public AbstractCommentCollection(Resource resource,
                                 ClientUtilities clientUtils,
                                 QueryRequestInfo queryInfo,
                                 CommentSocialComponentListProviderManager commentListProviderManager)

Construct a CommentCollection using the specified Resource which should be the root of the collection.

Parameters:

resource - the resource where the CommentCollection is located

clientUtils - the clientUtilities instance

commentListProviderManager - CommentSocialComponentListProviderManager

queryInfo - QueryRequestInfo

Method Detail

getMayPost

public boolean getMayPost()

Specified by:

getMayPost in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

true if the Post action button should be displayed

setPagination

public void setPagination(CollectionPagination pagination)

Set the collection list range. If this is not set, then the return list will start at offset 0 and the default size.

Specified by:

setPagination in interface SocialCollectionComponent

Parameters:

pagination - pagination configuration

getCreated

public java.util.Calendar getCreated()

Returns the moment in time this collection was created.

Specified by:

getCreated in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

The calendar representing the creation date/time.

getLastModified

public java.util.Calendar getLastModified()

Returns the moment in time this collection was last modified.

Specified by:

getLastModified in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

The calendar representing the last modification.

getTotalSize

public int getTotalSize()

Get total size of the collection.

Specified by:

getTotalSize in interface SocialCollectionComponent

Returns:

the size of the collection.

getItems

public java.util.List<java.lang.Object> getItems()

Get the comments of this CommentCollection base on the pagination configuration.

Specified by:

getItems in interface SocialCollectionComponent

Returns:

List - a list of Comment

setSortedOrder

public void setSortedOrder(CollectionSortedOrder sortedOrder)

Set the collection sorted order.

Specified by:

setSortedOrder in interface SocialCollectionComponent

Parameters:

sortedOrder - the order definition of how the items should be sorted.

getPageInfo

public PageInfo getPageInfo()

Description copied from interface: CommentCollection

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Specified by:

getPageInfo in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

information about the pagination system

isTaggingAllowed

public boolean isTaggingAllowed()

Description copied from interface: CommentCollection

Checks if is tagging allowed.

Specified by:

isTaggingAllowed in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

true, if is tagging allowed

getConfiguration

public T getConfiguration()

Description copied from interface: CommentCollection

Get the configuration for this collection

Specified by:

getConfiguration in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

T

getFriendlyUrl

public java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class BaseSocialComponent

Returns:

friendlyURL String

getAsMap

public java.util.Map<java.lang.String,java.lang.Object> getAsMap()

Specified by:

getAsMap in interface SocialComponent

Overrides:

getAsMap in class BaseSocialComponent

Returns:

Map this object represented as a map.

toJSONString

public java.lang.String toJSONString(boolean tidy)
                              throws JsonException

Specified by:

toJSONString in interface SocialComponent

Overrides:

toJSONString in class BaseSocialComponent

Parameters:

tidy - true to return readable JSON string.

Returns:

JSON representation of this object.

Throws:

JsonException - if an error occurs during serialization.