com.adobe.cq.social.scf.core

Class BaseSocialComponent

java.lang.Object

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

All Implemented Interfaces:

SocialComponent

Direct Known Subclasses:

AbstractComment, AbstractCommentCollection, AbstractDVBarChartComponent, AbstractDVDonutChartComponent, AbstractDVLineChartComponent, AbstractFollowing, AbstractRelationshipCollection, AbstractSocialNotificationCollection, AbstractSubscriptionCollection, AbstractTally, AbstractTallyResponse, AbstractUser

public class BaseSocialComponent
extends java.lang.Object
implements SocialComponent

Default SocialComponent implementation for all Resource Types. This class should be extended to implement SocialComponent for other Resource Types.

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
BaseSocialComponent(Resource resource, ClientUtilities clientUtils)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildJSONString(java.util.Map<java.lang.String,java.lang.Object> data, boolean tidy)
java.util.Map<java.lang.String,java.lang.Object>	getAsMap()
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.
ResourceID	getId()
SocialComponent	getParentComponent() Gets the immediate parent of this component.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Get the resource value for the specified key.
<T> T	getProperty(java.lang.String name, T defaultValue) Get the resource value for the specified key, if the property doesn't exist, return the specified default value.
Resource	getResource()
java.lang.String	getResourceType()
SocialComponent	getSourceComponent() Gets the SocialComponent that created this piece of UGC.
java.lang.String	getUrl()
java.lang.String	toJSONString(boolean tidy)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSocialComponent

public BaseSocialComponent(Resource resource,
                           ClientUtilities clientUtils)

Parameters:

resource - the resource for which this BaseSocialComponent will be created for.

clientUtils - an instance of ClientUtilities for accessing helper methods for XSS support and generating URLs.

Method Detail

buildJSONString

public static java.lang.String buildJSONString(java.util.Map<java.lang.String,java.lang.Object> data,
                                               boolean tidy)
                                        throws JsonException

Throws:

JsonException

getId

public ResourceID getId()

Specified by:

getId in interface SocialComponent

Returns:

the ResourceID of the resource.

getResourceType

public java.lang.String getResourceType()

Specified by:

getResourceType in interface SocialComponent

Returns:

the resource type of the resource.

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface SocialComponent

Returns:

the url to the resource if possible.

getProperties

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

Specified by:

getProperties in interface SocialComponent

Returns:

a list of resource properties.

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.Class<T> type)

Get the resource value for the specified key.

Specified by:

getProperty in interface SocialComponent

Type Parameters:

T - type

Parameters:

name - name/key of the property

type - Class

Returns:

T property

getProperty

public <T> T getProperty(java.lang.String name,
                         T defaultValue)

Get the resource value for the specified key, if the property doesn't exist, return the specified default value.

Specified by:

getProperty in interface SocialComponent

Type Parameters:

T - type

Parameters:

name - the name of the property

defaultValue - a non null default value to be returned by this method if the specified property does not exist

Returns:

T property

toJSONString

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

Specified by:

toJSONString in interface SocialComponent

Parameters:

tidy - true to return readable JSON string.

Returns:

JSON representation of this object.

Throws:

JsonException - if an error occurs during serialization.

getResource

public Resource getResource()

Specified by:

getResource in interface SocialComponent

Returns:

Resource - the resource represented by this SocialComponent.

getAsMap

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

Specified by:

getAsMap in interface SocialComponent

Returns:

Map this object represented as a map.

getParentComponent

public SocialComponent getParentComponent()

Description copied from interface: SocialComponent

Gets the immediate parent of this component.

Specified by:

getParentComponent in interface SocialComponent

Returns:

the parent social component or {code}null{/code} if none exists

getSourceComponent

public SocialComponent getSourceComponent()

Description copied from interface: SocialComponent

Gets the SocialComponent that created this piece of UGC. This generally links back to the component that is in the real content tree.

Specified by:

getSourceComponent in interface SocialComponent

Returns:

the source social component

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

Returns:

friendlyURL String