public class FacetOptions extends Object
FacetQuery
Modifier and Type | Class and Description |
---|---|
static class |
FacetOptions.FacetParameter |
static class |
FacetOptions.FacetSort |
static class |
FacetOptions.FieldWithDateRangeParameters
Class representing date field specific facet range parameters
|
static class |
FacetOptions.FieldWithFacetParameters |
static class |
FacetOptions.FieldWithNumericRangeParameters
Class representing numeric field specific facet range parameters
|
static class |
FacetOptions.FieldWithRangeParameters<T extends FacetOptions.FieldWithRangeParameters<?,?,?>,R,G>
Class representing common facet range parameters.
|
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_FACET_LIMIT |
static int |
DEFAULT_FACET_MIN_COUNT |
static FacetOptions.FacetSort |
DEFAULT_FACET_SORT |
Constructor and Description |
---|
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
|
Modifier and Type | Method and Description |
---|---|
FacetOptions |
addFacetByRange(FacetOptions.FieldWithRangeParameters<?,?,?> field)
Append additional field for range faceting
|
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
Field s. |
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() |
Collection<FacetOptions.FieldWithRangeParameters<?,?,?>> |
getFieldsWithRangeParameters() |
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 |
public static final int DEFAULT_FACET_MIN_COUNT
public static final int DEFAULT_FACET_LIMIT
public static final FacetOptions.FacetSort DEFAULT_FACET_SORT
public FacetOptions()
public FacetOptions(String... fieldnames)
fieldnames
- public FacetOptions(Field... fields)
public FacetOptions(SolrDataQuery... facetQueries)
facetQueries
- public final FacetOptions addFacetOnField(Field field)
field
- public final FacetOptions addFacetOnField(String fieldname)
fieldname
- public final FacetOptions addFacetByRange(FacetOptions.FieldWithRangeParameters<?,?,?> field)
field
- the Field
to be appended to range faceting fieldspublic final FacetOptions addFacetOnPivot(Field... fields)
Field
s.fields
- public final FacetOptions addFacetOnPivot(String... fieldnames)
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 responseminCount
- Default is 1public FacetOptions setFacetLimit(int rowsToReturn)
facet.limit
rowsToReturn
- Default is 10public 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 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()
public Collection<FacetOptions.FieldWithRangeParameters<?,?,?>> getFieldsWithRangeParameters()
Copyright © 2011–2019 Pivotal Software, Inc.. All rights reserved.