org.gbif.api.model.common.search

Class Facet<T extends SearchParameter>

java.lang.Object

org.gbif.api.model.common.search.Facet<T>

public class Facet<T extends SearchParameter>
extends Object

Represents a clustering of search results into categories. Each facet shows the number of hits within the search that match that category.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Facet.Count Nested class that represents the count of each category.

Constructor Summary

Constructors

Constructor and Description
Facet() Null/Empty constructor.
Facet(T field) Minimal constructor.
Facet(T field, List<Facet.Count> counts) Full constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<Facet.Count>	getCounts() List of the different categories/count for this facet.
T	getField() The facet field, it's used only for identify the facet in a possible list of facets.
int	hashCode()
void	setCounts(List<Facet.Count> counts) Sets the list of counts/categories for this faceted field.
void	setField(T field) Sets the field of the facet.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Facet

public Facet()

Null/Empty constructor.

Facet

public Facet(T field)

Minimal constructor.

Facet

public Facet(T field,
             List<Facet.Count> counts)

Full constructor.

Method Detail

getCounts

public List<Facet.Count> getCounts()

List of the different categories/count for this facet.

setCounts

public void setCounts(List<Facet.Count> counts)

Sets the list of counts/categories for this faceted field.

getField

public T getField()

The facet field, it's used only for identify the facet in a possible list of facets.

setField

public void setField(T field)

Sets the field of the facet.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object