|
Spring Data Solr | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.data.solr.core.query.FacetOptions
public class FacetOptions
Set of options that can be set on a FacetQuery
| Nested Class Summary | |
|---|---|
static class |
FacetOptions.FacetParameter
|
static class |
FacetOptions.FacetSort
|
static class |
FacetOptions.FieldWithFacetParameters
|
| Field Summary | |
|---|---|
static int |
DEFAULT_FACET_LIMIT
|
static int |
DEFAULT_FACET_MIN_COUNT
|
static FacetOptions.FacetSort |
DEFAULT_FACET_SORT
|
| Constructor Summary | |
|---|---|
FacetOptions()
|
|
FacetOptions(Field... fields)
Creates new instance faceting on given fields |
|
FacetOptions(SolrDataQuery... facetQueries)
Creates new instance faceting on given queries |
|
FacetOptions(String... fieldnames)
Creates new instance faceting on fields with given name |
|
| Method Summary | |
|---|---|
FacetOptions |
addFacetOnField(Field field)
Append additional field for faceting |
FacetOptions |
addFacetOnField(String fieldname)
Append additional field with given name for faceting |
FacetOptions |
addFacetOnFlieldnames(Collection<String> fieldnames)
Append all fieldnames for faceting |
FacetOptions |
addFacetOnPivot(Field... fields)
Add pivot facet on given Fields. |
FacetOptions |
addFacetOnPivot(String... fieldnames)
|
FacetOptions |
addFacetQuery(SolrDataQuery query)
Append facet.query |
int |
getFacetLimit()
Get the max number of results per facet field. |
int |
getFacetMinCount()
get the min number of hits a result has to have to get listed in result. |
List<Field> |
getFacetOnFields()
Get the list of Fields to facet on |
List<PivotField> |
getFacetOnPivots()
Get the list of pivot Fields to face on |
String |
getFacetPrefix()
get value used for facet.prefix |
List<SolrDataQuery> |
getFacetQueries()
Get the list of facetQueries |
FacetOptions.FacetSort |
getFacetSort()
Get sorting of facet results. |
Collection<FacetOptions.FieldWithFacetParameters> |
getFieldsWithParameters()
|
Pageable |
getPageable()
Get the facet page requested. |
boolean |
hasFacetPrefix()
|
boolean |
hasFacetQueries()
|
boolean |
hasFacets()
|
boolean |
hasFields()
|
boolean |
hasPivotFields()
|
FacetOptions |
setFacetLimit(int rowsToReturn)
Set facet.limit |
FacetOptions |
setFacetMinCount(int minCount)
Set minimum number of hits facet.mincount for result to be included in response |
FacetOptions |
setFacetPrefix(String facetPrefix)
Set facet.prefix |
FacetOptions |
setFacetSort(FacetOptions.FacetSort facetSort)
Set facet.sort (INDEX or COUNT) |
FacetOptions |
setPageable(Pageable pageable)
Set facet.offet and facet.limit |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int DEFAULT_FACET_MIN_COUNT
public static final int DEFAULT_FACET_LIMIT
public static final FacetOptions.FacetSort DEFAULT_FACET_SORT
| Constructor Detail |
|---|
public FacetOptions()
public FacetOptions(String... fieldnames)
fieldnames - public FacetOptions(Field... fields)
fieldnames - public FacetOptions(SolrDataQuery... facetQueries)
facetQueries - | Method Detail |
|---|
public final FacetOptions addFacetOnField(Field field)
field -
public final FacetOptions addFacetOnField(String fieldname)
fieldname -
public final FacetOptions addFacetOnPivot(Field... fields)
Fields.
fields -
public final FacetOptions addFacetOnPivot(String... fieldnames)
fieldName -
public final FacetOptions addFacetOnFlieldnames(Collection<String> fieldnames)
fieldnames -
public final FacetOptions addFacetQuery(SolrDataQuery query)
facet.query
query -
public List<SolrDataQuery> getFacetQueries()
public FacetOptions setFacetMinCount(int minCount)
facet.mincount for result to be included in response
minCount - Default is 1
public FacetOptions setFacetLimit(int rowsToReturn)
facet.limit
rowsToReturn - Default is 10
public FacetOptions setFacetSort(FacetOptions.FacetSort facetSort)
facet.sort (INDEX or COUNT)
facetSort - Default is COUNT
public final List<Field> getFacetOnFields()
public final List<PivotField> getFacetOnPivots()
public int getFacetMinCount()
public int getFacetLimit()
public FacetOptions.FacetSort getFacetSort()
public Pageable getPageable()
public FacetOptions setPageable(Pageable pageable)
facet.offet and facet.limit
pageable -
public String getFacetPrefix()
facet.prefix
public FacetOptions setFacetPrefix(String facetPrefix)
facet.prefix
facetPrefix -
public boolean hasFields()
public boolean hasFacetQueries()
public boolean hasPivotFields()
public boolean hasFacets()
facet.field or facet.query setpublic boolean hasFacetPrefix()
public Collection<FacetOptions.FieldWithFacetParameters> getFieldsWithParameters()
|
Spring Data Solr | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||