com.adobe.cq.social.srp.internal

Interface SocialIndexer

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 String	REPORT_SUITE To allow sharding on tenant id.

Method Summary

Modifier and Type	Method and Description
void	addToIndex(Map<String,Object> data)
long	countChildren(String keyValue, String baseType, boolean visibleOnly)
void	delete(String key)
String	escapeQueryChars(String query) Simply provide access to the same method in org.apache.solr.client.solrj.util.ClientUtils
FacetResults	facetedSearch(String queryToAs, List<String> facetFields, List<String> pivotFields, String rows, String mincount, boolean isPivot, SocialDatabase database)
SocialResourceSearchResult<Map<String,Object>>	find(String component, String solrQueryString, List<SearchSortField> sortFields, int offset, int limit, SocialDatabase database, Map<String,Object> signals)
FacetSearchResult	findFacets(List<String> countFields, List<FacetRangeField> rangeFields, String resourceTypeFilter, String componentFilter, int count, boolean visibleOnly, boolean includeChildren)
SocialResourceSearchResult<Map<String,Object>>	findFacets(List<String> inPath, List<String> notInPath, List<String> fieldNames, List<FacetRangeField> facetRanges, String scoredQueryString, int maxFacetCount, List<SearchSortField> sortFields, int offset, int pageSize, SocialDatabase database)
List<Map<String,Object>>	getMLTResults(String query, String statusFilter, String resourceTypeFilter, String componentFilter, List<String> mltField, int maxResults, int minTermFreq, int minDocFreq, SocialDatabase database)
List<Map<String,Object>>	nonFacetedSearch(String solrQueryString, SocialDatabase database)
List<String>	readForDelete(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 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 IOException

Throws:

IOException

addToIndex

void addToIndex(Map<String,Object> data)
         throws IOException

Throws:

IOException

delete

void delete(String key)

facetedSearch

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

Throws:

PersistenceException

getMLTResults

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

Throws:

IOException

find

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

Throws:

IOException

findFacets

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

Throws:

IOException

findFacets

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

Throws:

IOException

countChildren

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

Throws:

PersistenceException

nonFacetedSearch

List<Map<String,Object>> nonFacetedSearch(String solrQueryString,
                                          SocialDatabase database)
                                   throws PersistenceException

Throws:

PersistenceException

setSolrConfig

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

escapeQueryChars

String escapeQueryChars(String query)

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

Parameters:

query -

Returns:

readForDelete

List<String> readForDelete(String key,
                           int offset,
                           int limit)
                    throws IOException

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

Parameters:

key -

Returns:

Throws:

IOException