com.adobe.cq.social.ugc.api

Interface RelatedSearch

public interface RelatedSearch

Interface for performing related search and faceted search.

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,Integer>>	findFacetRanges(List<FacetRangeField> facetRanges, String resourceTypeFilter, String componentFilter, int count) Return a list of categories [Facets] grouped by the range gap.
FacetSearchResult	findFacets(List<String> fieldNames, List<FacetRangeField> facetRanges, String resourceTypeFilter, String componentFilter, int count) Return a list of categories [Facets] and their counts and ranges grouped by the range gap.
Map<String,Map<String,Integer>>	findFacets(List<String> fieldNames, String resourceTypeFilter, String componentFilter, int count) Return a list of categories [Facets] and their counts for multiple fields.
Map<String,Map<String,Integer>>	findFacets(List<String> fieldNames, String resourceTypeFilter, String componentFilter, int count, boolean isVisibleOnly) Return a list of categories [Facets] and their counts for multiple fields.
Map<String,Map<String,Integer>>	findFacets(List<String> fieldNames, String resourceTypeFilter, String componentFilter, int count, boolean isVisbleOny, boolean includeChildren) Return a list of categories [Facets] and their counts for multiple fields.
Map<String,Map<String,Integer>>	findFacets(String scName, List<String> fieldNames, String resourceTypeFilter, String componentFilter, int count) Deprecated. Use method without the scName argument.
Map<String,Integer>	findFacets(String scName, String fieldName, String resourceTypeFilter, String componentFilter, int count) Return a list of categories [Facets] and their counts for a field.
List<String>	findMLT(String scName, String query, String resourceTypeFilter, String componentFilter, String[] mltFields, int maxResults, int minTermFreq, int minDocFreq) Return a list of related elements, given a query.
List<String>	findMLT(String scName, String query, String statusFilter, String resourceTypeFilter, String componentFilter, String[] mltFields, int maxResults, int minTermFreq, int minDocFreq) Return a list of related elements, given a query.

Method Detail

findMLT

List<String> findMLT(String scName,
                     String query,
                     String statusFilter,
                     String resourceTypeFilter,
                     String componentFilter,
                     String[] mltFields,
                     int maxResults,
                     int minTermFreq,
                     int minDocFreq)
              throws RepositoryException

Return a list of related elements, given a query.

Parameters:

scName - The name of the search collection.

query - The string to search for.

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

statusFilter - The status to filter on.

mltFields - Node properties to search on.

maxResults - The maximum results returned.

minTermFreq - The frequency which terms will be ignored in the source doc

minDocFreq - The frequency at which words will be ignored which do not occur in at least this many docs.

Returns:

The list of matching documents.

Throws:

RepositoryException - thrown when there are issues with repository.

findMLT

List<String> findMLT(String scName,
                     String query,
                     String resourceTypeFilter,
                     String componentFilter,
                     String[] mltFields,
                     int maxResults,
                     int minTermFreq,
                     int minDocFreq)
              throws RepositoryException

Return a list of related elements, given a query.

Parameters:

scName - The name of the search collection.

query - The string to search for.

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

mltFields - Node properties to search on.

maxResults - The maximum results returned.

minTermFreq - The frequency which terms will be ignored in the source doc

minDocFreq - The frequency at which words will be ignored which do not occur in at least this many docs.

Returns:

The list of matching documents.

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

Map<String,Integer> findFacets(String scName,
                               String fieldName,
                               String resourceTypeFilter,
                               String componentFilter,
                               int count)
                        throws RepositoryException

Return a list of categories [Facets] and their counts for a field.

Parameters:

scName - The name of the search collection.

fieldName - The field name to be retrieved [Ex: Author, CategoryDate, cq:Tags]

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

Returns:

The map of Categories[values] and their counts.

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

@Deprecated
Map<String,Map<String,Integer>> findFacets(String scName,
                                                       List<String> fieldNames,
                                                       String resourceTypeFilter,
                                                       String componentFilter,
                                                       int count)
                                                throws RepositoryException

Deprecated. Use method without the scName argument.

Return a list of categories [Facets] and their counts for multiple fields. Takes a list of field names for which facet counts are wanted. Avoids multiple trips to the indexing engine, which could be in the cloud and have a non negligible network latency

Parameters:

scName - The name of the search collection.

fieldNames - The field names to be retrieved [Ex: Author, CategoryDate, cq:Tags]

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

Returns:

The map of names and facet results for each field: Map>

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

Map<String,Map<String,Integer>> findFacets(List<String> fieldNames,
                                           String resourceTypeFilter,
                                           String componentFilter,
                                           int count)
                                    throws RepositoryException

Return a list of categories [Facets] and their counts for multiple fields. Takes a list of field names for which facet counts are wanted. Avoids multiple trips to the indexing engine, which could be in the cloud and have a non negligible network latency.

Parameters:

fieldNames - The field names to be retrieved [Ex: Author, CategoryDate, cq:Tags]

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

Returns:

The map of names and facet results for each field: Map>

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

Map<String,Map<String,Integer>> findFacets(List<String> fieldNames,
                                           String resourceTypeFilter,
                                           String componentFilter,
                                           int count,
                                           boolean isVisbleOny,
                                           boolean includeChildren)
                                    throws RepositoryException

Return a list of categories [Facets] and their counts for multiple fields. Takes a list of field names for which facet counts are wanted. Avoids multiple trips to the indexing engine, which could be in the cloud and have a non negligible network latency.

Parameters:

fieldNames - The field names to be retrieved [Ex: Author, CategoryDate, cq:Tags]

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

isVisibleOnly - Should include drafts and spam posts etc

includeChildren - Should Subpaths be included

Returns:

The map of names and facet results for each field: Map>

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

Map<String,Map<String,Integer>> findFacets(List<String> fieldNames,
                                           String resourceTypeFilter,
                                           String componentFilter,
                                           int count,
                                           boolean isVisibleOnly)
                                    throws RepositoryException

Return a list of categories [Facets] and their counts for multiple fields. Takes a list of field names for which facet counts are wanted. Avoids multiple trips to the indexing engine, which could be in the cloud and have a non negligible network latency.

Parameters:

fieldNames - The field names to be retrieved [Ex: Author, CategoryDate, cq:Tags]

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

isVisibleOnly - Should Subpaths be included

Returns:

The map of names and facet results for each field: Map>

Throws:

RepositoryException - thrown when there are issues with repository.

findFacetRanges

Map<String,Map<String,Integer>> findFacetRanges(List<FacetRangeField> facetRanges,
                                                String resourceTypeFilter,
                                                String componentFilter,
                                                int count)
                                         throws RepositoryException

Return a list of categories [Facets] grouped by the range gap.

Parameters:

facetRanges - The facet range (field, start, end, gap)

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

Returns:

The map of names and facet range results for each field: Map>

Throws:

RepositoryException - thrown when there are issues with repository.

findFacets

FacetSearchResult findFacets(List<String> fieldNames,
                             List<FacetRangeField> facetRanges,
                             String resourceTypeFilter,
                             String componentFilter,
                             int count)
                      throws RepositoryException

Return a list of categories [Facets] and their counts and ranges grouped by the range gap.

Parameters:

fieldNames - The field names for the counts [Ex: Author, CategoryDate, cq:Tags]

facetRanges - The facet range (field, start, end, gap)

resourceTypeFilter - The resource type to filter on.

componentFilter - The path of the component to filter on.

count - The maximum results returned.

Returns:

Count and range maps in the FacetSearchResult.

Throws:

RepositoryException - thrown when there are issues with repository.