SolrFacetHelper (Alfresco Repository zap-7.87-postgres11 API)

java.lang.Object
- org.alfresco.repo.search.impl.solr.facet.SolrFacetHelper

```
public class SolrFacetHelper
extends java.lang.Object
```
A helper class for facet queries.

Since:

5.0

Author:

Jamal Kaabi-Mofrad

Constructor Summary

Constructors
Constructor Description

SolrFacetHelper(java.util.List<FacetQueryProvider> facetQueryProviders)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`createFacetQueriesFromSearchQuery(java.lang.String field, java.lang.String searchQuery)`	Creates a facet query by trying to extract the date range from the the search query.
`java.util.Set<java.lang.String>`	`getBucketedFieldFacets()`	Gets predefined set of field facets which are used to construct bucketing
`java.util.List<java.lang.String>`	`getDefaultFacetQueries()`	Gets the predefined set of facet queries.
`java.util.List<java.lang.String>`	`getFacetQueries(java.lang.String facetField)`	Gets all the defined facet queries for the specified field
`boolean`	`hasFacetQueries(java.lang.String facetField)`	Whether the specified field is defined as a facet.query or not
`boolean`	`isSpecialFacetId(java.lang.String facetId)`	Is the specified facet ID part of the list of "specials" which are handled by our SOLR service as is?
`void`	`setSpecialFacetIds(java.util.Set<java.lang.String> ids)`

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

- Constructor Detail
  - SolrFacetHelper
```
public SolrFacetHelper(java.util.List<FacetQueryProvider> facetQueryProviders)
```
    Constructor
- Method Detail
  - setSpecialFacetIds
```
public void setSpecialFacetIds(java.util.Set<java.lang.String> ids)
```
  - getDefaultFacetQueries
```
public java.util.List<java.lang.String> getDefaultFacetQueries()
```
    Gets the predefined set of facet queries. Currently the facet queries are:
  - Created date buckets
  - Modified date buckets
  - Content size buckets

Returns:: list of facet queries

hasFacetQueries
```
public boolean hasFacetQueries(java.lang.String facetField)
```
Whether the specified field is defined as a facet.query or not

Parameters:

facetField - String

Returns:

true if the facet is facet.query, false otherwise

getFacetQueries
```
public java.util.List<java.lang.String> getFacetQueries(java.lang.String facetField)
```
Gets all the defined facet queries for the specified field

Parameters:

facetField - the requested field

Returns:

an unmodifiable list of facet queries, or null if none found

getBucketedFieldFacets
```
public java.util.Set<java.lang.String> getBucketedFieldFacets()
```
Gets predefined set of field facets which are used to construct bucketing

Returns:

an unmodifiable view of the set of predefined field facets

createFacetQueriesFromSearchQuery
```
public java.lang.String createFacetQueriesFromSearchQuery(java.lang.String field,
                                                          java.lang.String searchQuery)
```
Creates a facet query by trying to extract the date range from the the search query.

Returns:

the facet query, or null if the date range cannot be extracted

isSpecialFacetId
```
public boolean isSpecialFacetId(java.lang.String facetId)
```
Is the specified facet ID part of the list of "specials" which are handled by our SOLR service as is?