FacetField (Solr 9.6.0 core API)

java.lang.Object
- org.apache.solr.search.facet.FacetRequest
- - org.apache.solr.search.facet.FacetField

public class FacetField
extends FacetRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FacetField.FacetMethod
- Nested classes/interfaces inherited from class org.apache.solr.search.facet.FacetRequest
  FacetRequest.Domain, FacetRequest.FacetSort, FacetRequest.RefineMethod, FacetRequest.SortDirection

Field Summary

Fields
Modifier and Type Field Description

static int DEFAULT_FACET_LIMIT
- Fields inherited from class org.apache.solr.search.facet.FacetRequest
  domain, facetStats, processEmpty, subFacets

Constructor Summary

Constructors
Constructor Description

FacetField()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FacetMerger`	`createFacetMerger(Object prototype)`
`FacetProcessor<FacetField>`	`createFacetProcessor(FacetContext fcontext)`
`Map<String,Object>`	`getFacetDescription()`
`FacetRequest.RefineMethod`	`getRefineMethod()`	Returns null if unset
`boolean`	`returnsPartial()`	Returns true if this facet can return just some of the facet buckets that match all the criteria.

Methods inherited from class org.apache.solr.search.facet.FacetRequest
addStat, addSubFacet, canProduceFromEmpty, doRefine, getFacetStats, getSubFacets, parse, parseOneFacetReq, process, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_FACET_LIMIT
```
public static final int DEFAULT_FACET_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FacetField
```
public FacetField()
```
- Method Detail
  - createFacetProcessor
```
public FacetProcessor<FacetField> createFacetProcessor(FacetContext fcontext)
```
    Specified by:
    
    createFacetProcessor in class FacetRequest
  - createFacetMerger
```
public FacetMerger createFacetMerger(Object prototype)
```
    Specified by:
    
    createFacetMerger in class FacetRequest
  - getFacetDescription
```
public Map<String,Object> getFacetDescription()
```
    Specified by:
    
    getFacetDescription in class FacetRequest
  - getRefineMethod
```
public FacetRequest.RefineMethod getRefineMethod()
```
    Description copied from class: FacetRequest
    
    Returns null if unset
    
    Overrides:
    
    getRefineMethod in class FacetRequest
  - returnsPartial
```
public boolean returnsPartial()
```
    Description copied from class: FacetRequest
    
    Returns true if this facet can return just some of the facet buckets that match all the criteria. This is normally true only for facets with a limit.
    
    Overrides:
    
    returnsPartial in class FacetRequest