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

All Implemented Interfaces:

Serializable
```
public class SolrFacetProperties
extends Object
implements Serializable
```
Domain-Specific Language (DSL) style builder class for encapsulating the facet properties.

Author:

Jamal Kaabi-Mofrad

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SolrFacetProperties.Builder

static class SolrFacetProperties.CustomProperties

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Set<SolrFacetProperties.CustomProperties>`	`getCustomProperties()`	Returns an unmodifiable view of the custom properties set or null.
`String`	`getDisplayControl()`
`String`	`getDisplayName()`
`QName`	`getFacetQName()`
`String`	`getFilterID()`
`int`	`getHitThreshold()`
`int`	`getMaxFilters()`
`int`	`getMinFilterValueLength()`
`String`	`getScope()`
`Set<String>`	`getScopedSites()`	Returns an unmodifiable view of the Scoped Sites set.
`String`	`getSortBy()`
`int`	`hashCode()`
`boolean`	`isDefault()`	Whether the facet is a default facet (loaded from a configuration file) or not
`Boolean`	`isEnabled()`
`String`	`toString()`

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

- Method Detail
  - getFilterID
```
public String getFilterID()
```
    Returns:
    
    the filterID
  - getFacetQName
```
public QName getFacetQName()
```
    Returns:
    
    the facetQName
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    the displayName
  - getDisplayControl
```
public String getDisplayControl()
```
    Returns:
    
    the displayControl
  - getMaxFilters
```
public int getMaxFilters()
```
    Returns:
    
    the maxFilters
  - getHitThreshold
```
public int getHitThreshold()
```
    Returns:
    
    the hitThreshold
  - getMinFilterValueLength
```
public int getMinFilterValueLength()
```
    Returns:
    
    the minFilterValueLength
  - getSortBy
```
public String getSortBy()
```
    Returns:
    
    the sortBy
  - getScope
```
public String getScope()
```
    Returns:
    
    the scope
  - getScopedSites
```
public Set<String> getScopedSites()
```
    Returns an unmodifiable view of the Scoped Sites set. Never null.
    
    Returns:
    
    the scopedSites
  - isEnabled
```
public Boolean isEnabled()
```
    Returns:
    
    null if the value is not set
  - isDefault
```
public boolean isDefault()
```
    Whether the facet is a default facet (loaded from a configuration file) or not
    
    Returns:
    
    true if the facet is default, false otherwise
  - getCustomProperties
```
public Set<SolrFacetProperties.CustomProperties> getCustomProperties()
```
    Returns an unmodifiable view of the custom properties set or null.
    
    Returns:
    
    the customProperties
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Modifier and Type	Class	Description
`static class`	`SolrFacetProperties.Builder`
`static class`	`SolrFacetProperties.CustomProperties`

Class SolrFacetProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFilterID

getFacetQName

getDisplayName

getDisplayControl

getMaxFilters

getHitThreshold

getMinFilterValueLength

getSortBy

getScope

getScopedSites

isEnabled

isDefault

getCustomProperties

hashCode

equals

toString