com.adobe.cq.social.srp.internal

Class FacetResults

java.lang.Object

com.adobe.cq.social.srp.internal.FacetResults

public class FacetResults
extends java.lang.Object

The parsed facet results.

Constructor Summary

Constructors

Constructor and Description
FacetResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> docs, java.util.List<java.lang.String> facetFields, java.util.List<java.lang.String> pivotFields, java.util.Map<java.lang.String,java.lang.Object> facetFieldsFromResults, java.util.Map<java.lang.String,java.lang.Object> facetPivotFromResults) Constructor.

Method Summary

Modifier and Type	Method and Description
static FacetResults	emptyResults() A method for getting an empty facet result.
java.util.Map<java.lang.String,java.lang.Object>	getAggregation() Get the facetAggregations.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getDocs() Get the documents.
java.util.Map<java.lang.String,java.lang.Object>	getPivotAggregation() A method to return the first aggregation of the first field for the first pivot.field.
java.util.Map<java.lang.String,java.lang.Object>	getPivotAggregation(java.lang.String fpf)
java.util.Map<java.lang.String,java.lang.Integer>	getPivotAggregation(java.lang.String fpf, java.util.List<java.lang.String> fieldsFilter) Return the aggregate with field matching.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetResults

public FacetResults(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> docs,
                    java.util.List<java.lang.String> facetFields,
                    java.util.List<java.lang.String> pivotFields,
                    java.util.Map<java.lang.String,java.lang.Object> facetFieldsFromResults,
                    java.util.Map<java.lang.String,java.lang.Object> facetPivotFromResults)

Constructor.

Parameters:

docs - the list of documents

facetFields - the input list of facets

pivotFields - the input list of facet pivot fields

facetFieldsFromResults - the facet field results fetched from the data service

facetPivotFromResults - the pivot field results fetched from the data service

Method Detail

getPivotAggregation

public java.util.Map<java.lang.String,java.lang.Object> getPivotAggregation()

A method to return the first aggregation of the first field for the first pivot.field.

Returns:

a Map where the key is the value of the first field in the first pivot.field

getPivotAggregation

public java.util.Map<java.lang.String,java.lang.Object> getPivotAggregation(java.lang.String fpf)

Parameters:

fpf - the facet.pivot field

Returns:

a Map where the key is the value of the first field in the first pivot.field

getPivotAggregation

public java.util.Map<java.lang.String,java.lang.Integer> getPivotAggregation(java.lang.String fpf,
                                                                             java.util.List<java.lang.String> fieldsFilter)

Return the aggregate with field matching. e.g. getPivotAggregation(":parent,reponse,:key", ["/some/path/to/a/particular/parent","-1"])

Parameters:

fpf - the facet.pivot field used in the search

fieldsFilter - a list of

Returns:

a Map of the aggregate or empty Map if nothing is found matchig filters

getAggregation

public java.util.Map<java.lang.String,java.lang.Object> getAggregation()

Get the facetAggregations.

Returns:

a Map from the values to their counts

getDocs

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getDocs()

Get the documents.

Returns:

the list of documents

emptyResults

public static FacetResults emptyResults()

A method for getting an empty facet result.

Returns:

An empty result