com.adobe.cq.social.srp.internal

Interface SocialIndexer

@ProviderType
public interface SocialIndexer

Interface that should be implemented by anybody who wants the social ugc data to be indexed for better efficient searching EG: Solr, ElasticSearch, etc

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REPORT_SUITE To allow sharding on tenant id.

Method Summary

Modifier and Type	Method and Description
void	addToIndex(java.util.Map<java.lang.String,java.lang.Object> data)
long	countChildren(java.lang.String keyValue, java.lang.String baseType, boolean visibleOnly)
void	delete(java.lang.String key)
java.lang.String	escapeQueryChars(java.lang.String query) Simply provide access to the same method in org.apache.solr.client.solrj.util.ClientUtils
FacetResults	facetedSearch(java.lang.String queryToAs, java.util.List<java.lang.String> facetFields, java.util.List<java.lang.String> pivotFields, java.lang.String rows, java.lang.String mincount, boolean isPivot, SocialDatabase database)
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	find(java.lang.String component, java.lang.String solrQueryString, java.util.List<SearchSortField> sortFields, int offset, int limit, SocialDatabase database, java.util.Map<java.lang.String,java.lang.Object> signals)
FacetSearchResult	findFacets(java.util.List<java.lang.String> countFields, java.util.List<FacetRangeField> rangeFields, java.lang.String resourceTypeFilter, java.lang.String componentFilter, int count, boolean visibleOnly, boolean includeChildren)
SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>>	findFacets(java.util.List<java.lang.String> inPath, java.util.List<java.lang.String> notInPath, java.util.List<java.lang.String> fieldNames, java.util.List<FacetRangeField> facetRanges, java.lang.String scoredQueryString, int maxFacetCount, java.util.List<SearchSortField> sortFields, int offset, int pageSize, SocialDatabase database)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getMLTResults(java.lang.String query, java.lang.String statusFilter, java.lang.String resourceTypeFilter, java.lang.String componentFilter, java.util.List<java.lang.String> mltField, int maxResults, int minTermFreq, int minDocFreq, SocialDatabase database)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	nonFacetedSearch(java.lang.String solrQueryString, SocialDatabase database)
java.util.List<java.lang.String>	readForDelete(java.lang.String key, int offset, int limit) Returns a list of 'id' matching the given key and its children
void	setSolrConfig(int solrZKTimeout, int commitWithin, AbstractSchemaMapper mapper)
void	setupClient(SocialResourceConfiguration genericConfiguration)

Field Detail

REPORT_SUITE

static final java.lang.String REPORT_SUITE

To allow sharding on tenant id. Uses reportSuite from configuration

See Also:

Constant Field Values

Method Detail

setupClient

void setupClient(SocialResourceConfiguration genericConfiguration)
          throws java.io.IOException

Throws:

java.io.IOException

addToIndex

void addToIndex(java.util.Map<java.lang.String,java.lang.Object> data)
         throws java.io.IOException

Throws:

java.io.IOException

delete

void delete(java.lang.String key)

facetedSearch

FacetResults facetedSearch(java.lang.String queryToAs,
                           java.util.List<java.lang.String> facetFields,
                           java.util.List<java.lang.String> pivotFields,
                           java.lang.String rows,
                           java.lang.String mincount,
                           boolean isPivot,
                           SocialDatabase database)
                    throws PersistenceException

Throws:

PersistenceException

getMLTResults

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getMLTResults(java.lang.String query,
                                                                               java.lang.String statusFilter,
                                                                               java.lang.String resourceTypeFilter,
                                                                               java.lang.String componentFilter,
                                                                               java.util.List<java.lang.String> mltField,
                                                                               int maxResults,
                                                                               int minTermFreq,
                                                                               int minDocFreq,
                                                                               SocialDatabase database)
                                                                        throws java.io.IOException

Throws:

java.io.IOException

find

SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> find(java.lang.String component,
                                                                                  java.lang.String solrQueryString,
                                                                                  java.util.List<SearchSortField> sortFields,
                                                                                  int offset,
                                                                                  int limit,
                                                                                  SocialDatabase database,
                                                                                  java.util.Map<java.lang.String,java.lang.Object> signals)
                                                                           throws java.io.IOException

Throws:

java.io.IOException

findFacets

FacetSearchResult findFacets(java.util.List<java.lang.String> countFields,
                             java.util.List<FacetRangeField> rangeFields,
                             java.lang.String resourceTypeFilter,
                             java.lang.String componentFilter,
                             int count,
                             boolean visibleOnly,
                             boolean includeChildren)
                      throws java.io.IOException

Throws:

java.io.IOException

findFacets

SocialResourceSearchResult<java.util.Map<java.lang.String,java.lang.Object>> findFacets(java.util.List<java.lang.String> inPath,
                                                                                        java.util.List<java.lang.String> notInPath,
                                                                                        java.util.List<java.lang.String> fieldNames,
                                                                                        java.util.List<FacetRangeField> facetRanges,
                                                                                        java.lang.String scoredQueryString,
                                                                                        int maxFacetCount,
                                                                                        java.util.List<SearchSortField> sortFields,
                                                                                        int offset,
                                                                                        int pageSize,
                                                                                        SocialDatabase database)
                                                                                 throws java.io.IOException

Throws:

java.io.IOException

countChildren

long countChildren(java.lang.String keyValue,
                   java.lang.String baseType,
                   boolean visibleOnly)
            throws PersistenceException

Throws:

PersistenceException

nonFacetedSearch

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> nonFacetedSearch(java.lang.String solrQueryString,
                                                                                  SocialDatabase database)
                                                                           throws PersistenceException

Throws:

PersistenceException

setSolrConfig

void setSolrConfig(int solrZKTimeout,
                   int commitWithin,
                   AbstractSchemaMapper mapper)

escapeQueryChars

java.lang.String escapeQueryChars(java.lang.String query)

Simply provide access to the same method in org.apache.solr.client.solrj.util.ClientUtils

Parameters:

query - String query

Returns:

String

readForDelete

java.util.List<java.lang.String> readForDelete(java.lang.String key,
                                               int offset,
                                               int limit)
                                        throws java.io.IOException

Returns a list of 'id' matching the given key and its children

Parameters:

key - String

limit - int

offset - int

Returns:

List

Throws:

java.io.IOException - IOException