com.loop54.model.request.parameters.facets

Class DistinctFacetParameter<T>

java.lang.Object

com.loop54.model.request.parameters.facets.FacetParameter

com.loop54.model.request.parameters.facets.DistinctFacetParameter<T>

Type Parameters:

T - Type of the attribute to facet on.

public class DistinctFacetParameter<T>
extends FacetParameter

Used for distinct faceting of entities. A distinct facet consists of a finite number of options with the number of connected entities as the values. Only entities connected to selected facet options are returned. Or all if none are selected.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<T>	selected What options the user has selected.
java.util.List<DistinctFacetItemSortingParameter>	sortBy These sorting parameters specify how the options are to be sorted in the response.

Fields inherited from class com.loop54.model.request.parameters.facets.FacetParameter

attributeName, name

Constructor Summary

Constructors

Constructor and Description
DistinctFacetParameter(java.lang.String attributeName, java.util.List<T> selected, java.lang.String name, java.util.List<DistinctFacetItemSortingParameter> sortBy)

Method Summary

Modifier and Type	Method and Description
FacetType	getType() Type of the facet.

Methods inherited from class java.lang.Object

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

Field Detail

selected

public final java.util.List<T> selected

What options the user has selected. Only entities belonging to those options will be returned.

sortBy

public final java.util.List<DistinctFacetItemSortingParameter> sortBy

These sorting parameters specify how the options are to be sorted in the response.

Constructor Detail

DistinctFacetParameter

public DistinctFacetParameter(java.lang.String attributeName,
                              java.util.List<T> selected,
                              java.lang.String name,
                              java.util.List<DistinctFacetItemSortingParameter> sortBy)

Method Detail

getType

public FacetType getType()

Description copied from class: FacetParameter

Type of the facet. Range or Distinct.

Specified by:

getType in class FacetParameter

Returns:

The type of the facet parameter. Will always be FacetType.DISTINCT