com.adobe.cq.social.ugc.api

Class AbstractUgcNodeIndexerExtension

java.lang.Object

com.adobe.cq.social.ugc.api.AbstractUgcNodeIndexerExtension

All Implemented Interfaces:

UgcNodeIndexerExtension

public abstract class AbstractUgcNodeIndexerExtension
extends Object
implements UgcNodeIndexerExtension

Default implementation of UgcNodeIndexerExtension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_ENABLED The enabled property.

Constructor Summary

Constructors

Constructor and Description
AbstractUgcNodeIndexerExtension()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkEventModifiesIndex(Event event) Check the event and return true if it indicates data has been modified that affects the index.
boolean	checkNode(Node node) Check the node and return true if the node belongs in this index.
boolean	checkPrimaryType(NodeType primaryType) Check the primary type and return true if the node belongs in this index.
boolean	checkResource(Resource resource) Check the resource and return true if the node belongs in this index.
boolean	checkResourceType(String resourceType) Check the resource type and return true if the node belongs in this index.
List<UgcIndexProperty>	getAllUgcIndexProperties(ResourceResolver resolver, Node node) Given a node, return a list of UgcIndexProperties.
List<UgcCategoryProperty>	getUgcIndexedCategories(ResourceResolver resolver, Node node) Given a node, return a list of Ugc Indexed Categories.
abstract List<UgcIndexProperty>	getUgcIndexProperties(ResourceResolver resolver, Node node) Given a node, return a list of UgcIndexProperties.
boolean	isEnabled() Return true if enabled.
boolean	suppportFacetedSearch() For Index extensonions that would need faceted search, this method should be overridden to return true

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.ugc.api.UgcNodeIndexerExtension

getIncludePaths, getName, getPrimaryTypes

Field Detail

PROP_ENABLED

public static final String PROP_ENABLED

The enabled property.

See Also:

Constant Field Values

Constructor Detail

AbstractUgcNodeIndexerExtension

public AbstractUgcNodeIndexerExtension()

Method Detail

checkPrimaryType

public boolean checkPrimaryType(NodeType primaryType)

Check the primary type and return true if the node belongs in this index.

Specified by:

checkPrimaryType in interface UgcNodeIndexerExtension

Parameters:

primaryType - the node type to check.

Returns:

true if the node belongs in this index.

checkResourceType

public boolean checkResourceType(String resourceType)

Check the resource type and return true if the node belongs in this index.

Specified by:

checkResourceType in interface UgcNodeIndexerExtension

Parameters:

resourceType - the resource type to check.

Returns:

true if the node belongs in this index.

checkResource

public boolean checkResource(Resource resource)

Check the resource and return true if the node belongs in this index.

Specified by:

checkResource in interface UgcNodeIndexerExtension

Parameters:

resource - the resource to check.

Returns:

true if the node belongs in this index.

checkNode

public boolean checkNode(Node node)

Check the node and return true if the node belongs in this index.

Specified by:

checkNode in interface UgcNodeIndexerExtension

Parameters:

node - the node to check.

Returns:

true if the node belongs in this index.

checkEventModifiesIndex

public boolean checkEventModifiesIndex(Event event)

Check the event and return true if it indicates data has been modified that affects the index.

Specified by:

checkEventModifiesIndex in interface UgcNodeIndexerExtension

Parameters:

event - Event to check.

Returns:

true if the event indicates data has been modified that should be indexed.

isEnabled

public boolean isEnabled()

Return true if enabled.

Specified by:

isEnabled in interface UgcNodeIndexerExtension

Returns:

true if enabled.

suppportFacetedSearch

public boolean suppportFacetedSearch()

For Index extensonions that would need faceted search, this method should be overridden to return true

Specified by:

suppportFacetedSearch in interface UgcNodeIndexerExtension

Returns:

boolean true if node extension need to implement faceted Search

getAllUgcIndexProperties

public List<UgcIndexProperty> getAllUgcIndexProperties(ResourceResolver resolver,
                                              Node node)
                                                throws RepositoryException

Given a node, return a list of UgcIndexProperties.

Specified by:

getAllUgcIndexProperties in interface UgcNodeIndexerExtension

Parameters:

resolver - the ResourceResolver.

node - the node being indexed.

Returns:

a list of UgcIndexProperties.

Throws:

RepositoryException - thrown if there are issues with repository.

getUgcIndexProperties

public abstract List<UgcIndexProperty> getUgcIndexProperties(ResourceResolver resolver,
                                           Node node)
                                                      throws RepositoryException

Given a node, return a list of UgcIndexProperties. Implemented by subclass to include custom index properties.

Parameters:

resolver - the ResourceResolver.

node - the node being indexed.

Returns:

a list of UgcIndexProperties.

Throws:

RepositoryException - thrown if there are issues with repository.

getUgcIndexedCategories

public List<UgcCategoryProperty> getUgcIndexedCategories(ResourceResolver resolver,
                                                Node node)
                                                  throws RepositoryException

Given a node, return a list of Ugc Indexed Categories. Implemented by subclass to include custom index Categories.Also suppportFacetedSearch() should be overridden return true This method should be overridden - check JournalUgcNodeIndexerExtension in com.adobe.cq.social.journal.impl for sample implementation

Specified by:

getUgcIndexedCategories in interface UgcNodeIndexerExtension

Parameters:

resolver - the ResourceResolver.

node - the node being indexed.

Returns:

a list of UgcIndexCategories.

Throws:

RepositoryException - thrown if there are issues with repository.