com.loop54.model.request.parameters

Class EntityCollectionParameters

java.lang.Object

com.loop54.model.request.parameters.EntityCollectionParameters

public class EntityCollectionParameters
extends java.lang.Object

This class specifies how a collection of entities should be paged, filtered, sorted and faceted.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<FacetParameter>	facets List of facets to calculate and possibly filter the result on.
FilterParameter	filter How the results should be filtered.
java.lang.Integer	skip How many entities to skip when paging the result.
java.util.List<EntitySortingParameter>	sortBy List of sorting parameters specifying how the result should be sorted.
java.lang.Integer	take How many entities to take when paging the result.

Constructor Summary

Constructors

Constructor and Description
EntityCollectionParameters()

Method Summary

Modifier and Type	Method and Description
void	addDistinctFacet(java.lang.String attributeName) Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.
void	addDistinctFacet(java.lang.String attributeName, java.util.List<?> selected) Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.
void	addDistinctFacet(java.lang.String attributeName, java.util.List<?> selected, java.lang.String name, java.util.List<DistinctFacetItemSortingParameter> sortBy) Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.
void	addRangeFacet(java.lang.String attributeName) Adds a facet with the type FacetType.RANGE to the entity collection parameter.
void	addRangeFacet(java.lang.String attributeName, RangeFacetParameter.RangeFacetSelectedParameter<?> selected, java.lang.String name) Adds a facet with the type FacetType.RANGE to the entity collection parameter.

Methods inherited from class java.lang.Object

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

Field Detail

skip

public java.lang.Integer skip

How many entities to skip when paging the result. If null it defaults to 0.

take

public java.lang.Integer take

How many entities to take when paging the result. If null it defaults to 5.

sortBy

public java.util.List<EntitySortingParameter> sortBy

List of sorting parameters specifying how the result should be sorted. The first sorting parameter specifies the primary order. If items are equal, they will be sorted using the second parameter, and so on. If not set the entities will be sorted by relevance descending.

facets

public java.util.List<FacetParameter> facets

List of facets to calculate and possibly filter the result on. If not set, no faceting is done.

filter

public FilterParameter filter

How the results should be filtered. If not set, no filtering is done.

Constructor Detail

EntityCollectionParameters

public EntityCollectionParameters()

Method Detail

addDistinctFacet

public void addDistinctFacet(java.lang.String attributeName)

Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.

Parameters:

attributeName - What attribute on the entities to facet on. This must match one of the attributes available on the entities in the search engine.

addDistinctFacet

public void addDistinctFacet(java.lang.String attributeName,
                             java.util.List<?> selected)

Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.

Parameters:

attributeName - What attribute on the entities to facet on. This must match one of the attributes available on the entities in the search engine.

selected - Values selected by the user. If none are selected this can be null.

addDistinctFacet

public void addDistinctFacet(java.lang.String attributeName,
                             java.util.List<?> selected,
                             java.lang.String name,
                             java.util.List<DistinctFacetItemSortingParameter> sortBy)

Adds a facet with the type FacetType.DISTINCT to the entity collection parameter.

Parameters:

attributeName - What attribute on the entities to facet on. This must match one of the attributes available on the entities in the search engine.

selected - Values selected by the user. If none are selected this can be null.

name - The desired name of the facet in the response. Will be the same as the attributeName if null.

sortBy - How to sort the facet options in the response.

addRangeFacet

public void addRangeFacet(java.lang.String attributeName)

Adds a facet with the type FacetType.RANGE to the entity collection parameter.

Parameters:

attributeName - What attribute on the entities to facet on. This must match one of the attributes available on the entities in the search engine.

addRangeFacet

public void addRangeFacet(java.lang.String attributeName,
                          RangeFacetParameter.RangeFacetSelectedParameter<?> selected,
                          java.lang.String name)

Adds a facet with the type FacetType.RANGE to the entity collection parameter.

Parameters:

attributeName - What attribute on the entities to facet on. This must match one of the attributes available on the entities in the search engine.

selected - The min and max values selected by the user. Can be left to null if nothing is selected.

name - The desired name of the facet in the response. Will be the same as the attributeName if null.