PredefinedBucketsFacetExtractor (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- com.day.cq.search.facets.extractors.PropertyFacetExtractor
- - com.day.cq.search.facets.extractors.PredefinedBucketsFacetExtractor

All Implemented Interfaces:

FacetExtractor
```
public class PredefinedBucketsFacetExtractor
extends PropertyFacetExtractor
```
PredefinedBucketsFacetExtractor extracts facets based on a list of predefined buckets. This means that the buckets returned will at most be the ones added in the constructor or through addPredefinedBucket(PredefinedBucket), but could be less, because only buckets with at least one match will be returned in the facet.

Since:

5.2

Constructor Summary

Constructors
Constructor	Description
`PredefinedBucketsFacetExtractor(java.lang.String propertyRelPath)`
`PredefinedBucketsFacetExtractor(java.lang.String propertyRelPath, java.util.Collection<? extends PredefinedBucket> buckets)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addPredefinedBucket(PredefinedBucket bucket)`	Adds a predefined bucket to this extractor.
`boolean`	`equals(java.lang.Object obj)`
`Facet`	`getFacet()`	Called after the result set was scanned (and `FacetExtractor.handleNode(Node)` was called for each node in the result) to retrieve the final `Facet` object.
`int`	`hashCode()`

Methods inherited from class com.day.cq.search.facets.extractors.PropertyFacetExtractor
handleNode

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PredefinedBucketsFacetExtractor
```
public PredefinedBucketsFacetExtractor(java.lang.String propertyRelPath)
```
  - PredefinedBucketsFacetExtractor
```
public PredefinedBucketsFacetExtractor(java.lang.String propertyRelPath,
                                       java.util.Collection<? extends PredefinedBucket> buckets)
```
- Method Detail
  - addPredefinedBucket
```
public void addPredefinedBucket(PredefinedBucket bucket)
```
    Adds a predefined bucket to this extractor.
    
    Parameters:
    
    definition - the bucket definition to add.
  - getFacet
```
public Facet getFacet()
```
    Description copied from interface: FacetExtractor
    
    Called after the result set was scanned (and FacetExtractor.handleNode(Node) was called for each node in the result) to retrieve the final Facet object. Please note that this might be called without FacetExtractor.handleNode(Node) ever being called, if the result was empty.
    Implementations can use the simple FacetImpl implementation of the Facet interface.
    
    Returns:
    
    an implementation of the Facet interface with all buckets found in the result or null if nothing was found in the result
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object