com.adobe.cq.social.ugc.api

Interface UgcNodeIndexerExtension

All Known Implementing Classes:

AbstractUgcNodeIndexerExtension

Deprecated.

@Deprecated
public interface UgcNodeIndexerExtension

Interface class for extension of node indexing. Service implementations of this interface are no longer honored as of AEM 6.1

Method Summary

Modifier and Type	Method and Description
boolean	checkEventModifiesIndex(Event event) Deprecated. Check the event and return true if it indicates data has been modified that affects the index.
boolean	checkNode(Node node) Deprecated. Check the node and return true if the node belongs in this index.
boolean	checkPrimaryType(NodeType primaryType) Deprecated. Check the primary type and return true if the node belongs in this index.
boolean	checkResource(Resource resource) Deprecated. Check the resource and return true if the node belongs in this index.
boolean	checkResourceType(java.lang.String resourceType) Deprecated. Check the resource type and return true if the node belongs in this index.
java.util.List<UgcIndexProperty>	getAllUgcIndexProperties(ResourceResolver resolver, Node node) Deprecated. Given a node, return a list of UgcIndexProperties.
java.lang.String	getIncludePaths() Deprecated. Return the include paths that should be observed for events to trigger indexing.
java.lang.String	getName() Deprecated. Return the name of the index.
java.lang.String[]	getPrimaryTypes() Deprecated. Return the node types that should be observed for events to trigger indexing.
java.util.List<UgcCategoryProperty>	getUgcIndexedCategories(ResourceResolver resolver, Node node) Deprecated. Given a node, return a list of Ugc Indexed Categories.
boolean	isEnabled() Deprecated. Is this indexer extension enabled?
boolean	suppportFacetedSearch() Deprecated. For Index extensonions that would need faceted search, this method should be overridden to return true.

Method Detail

checkPrimaryType

boolean checkPrimaryType(NodeType primaryType)

Deprecated.

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

Parameters:

primaryType - the node type to check.

Returns:

true if the node belongs in this index.

checkResourceType

boolean checkResourceType(java.lang.String resourceType)

Deprecated.

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

Parameters:

resourceType - the resource type to check.

Returns:

true if the node belongs in this index.

checkResource

boolean checkResource(Resource resource)

Deprecated.

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

Parameters:

resource - the resource to check.

Returns:

true if the node belongs in this index.

checkNode

boolean checkNode(Node node)

Deprecated.

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

Parameters:

node - the node to check.

Returns:

true if the node belongs in this index.

checkEventModifiesIndex

boolean checkEventModifiesIndex(Event event)

Deprecated.

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

Parameters:

event - Event to check.

Returns:

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

getAllUgcIndexProperties

java.util.List<UgcIndexProperty> getAllUgcIndexProperties(ResourceResolver resolver,
                                                          Node node)
                                                   throws RepositoryException

Deprecated.

Given a node, return a list of UgcIndexProperties.

Parameters:

resolver - the ResourceResolver.

node - the node being indexed.

Returns:

a list of UgcIndexProperties.

Throws:

RepositoryException - thrown if there are issues with repository.

getUgcIndexedCategories

java.util.List<UgcCategoryProperty> getUgcIndexedCategories(ResourceResolver resolver,
                                                            Node node)
                                                     throws RepositoryException

Deprecated.

Given a node, return a list of Ugc Indexed Categories. Implemented by subclass to include custom index Categories. Also suppportFacetedSearch() should return true

Parameters:

resolver - the ResourceResolver.

node - the node being indexed.

Returns:

a list of UgcIndexCategories.

Throws:

RepositoryException - thrown if there are issues with repository.

getName

java.lang.String getName()

Deprecated.

Return the name of the index.

Returns:

the name of the index.

getPrimaryTypes

java.lang.String[] getPrimaryTypes()

Deprecated.

Return the node types that should be observed for events to trigger indexing.

Returns:

the node types that should be observed for events to trigger indexing.

getIncludePaths

java.lang.String getIncludePaths()

Deprecated.

Return the include paths that should be observed for events to trigger indexing. This is in comma separated value format.

Returns:

the include paths that should be observed for events to trigger indexing.

suppportFacetedSearch

boolean suppportFacetedSearch()

Deprecated.

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

Returns:

boolean true if node extension need to implement faceted Search.

isEnabled

boolean isEnabled()

Deprecated.

Is this indexer extension enabled?

Returns:

true if enabled.