FacetBase

java.lang.Object
- io.sphere.internal.facets.FacetBase<T>

Type Parameters:
T - Type of items returned for this facet: TermFacetItem, RangeFacetItem.

All Implemented Interfaces:

Facet<T>

Direct Known Subclasses:

AttributeTermFacetBase, Facets.DateTimeAttribute.Ranges, Facets.MoneyAttribute.Ranges, Facets.NumberAttribute.Ranges, Facets.Price.Ranges
```
public abstract class FacetBase<T>
extends java.lang.Object
implements Facet<T>
```
Facet that matches on a custom attribute.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`attribute` Backend name of the custom attribute.
`protected boolean`	`isSingleSelect` If true, only one value can be selected by user at a time.
`protected java.lang.String`	`queryParam` Name of the application-level query parameter for this facet.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FacetBase(java.lang.String attribute)

Constructors
Modifier	Constructor and Description
`protected`	`FacetBase(java.lang.String attribute)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttributeName()` The attribute on which this facet matches and aggregates counts.
`java.lang.String`	`getSelectLink(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)` Adds given item of this facet to application's query string (i.e.
`java.lang.String`	`getUnselectLink(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)` Removes given item of this facet from application's query string (i.e.
`abstract java.util.List<QueryParam>`	`getUrlParams(T item)` Returns application-level URL representation for given item of this facet.
`boolean`	`isSelected(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)` Checks whether given item of this facet is present in application's query string (i.e.

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

Methods inherited from interface io.sphere.client.facets.Facet
parse, setQueryParam, setSingleSelect

- Field Detail
  - queryParam
```
protected java.lang.String queryParam
```
    Name of the application-level query parameter for this facet.
  - attribute
```
protected java.lang.String attribute
```
    Backend name of the custom attribute.
  - isSingleSelect
```
protected boolean isSingleSelect
```
    If true, only one value can be selected by user at a time.
- Constructor Detail
  - FacetBase
```
protected FacetBase(java.lang.String attribute)
```
- Method Detail
  - getAttributeName
```
public java.lang.String getAttributeName()
```
    The attribute on which this facet matches and aggregates counts.
    
    Specified by:
    
    getAttributeName in interface Facet<T>
  - getUrlParams
```
public abstract java.util.List<QueryParam> getUrlParams(T item)
```
    Returns application-level URL representation for given item of this facet.
    
    Specified by:
    
    getUrlParams in interface Facet<T>
  - getSelectLink
```
public final java.lang.String getSelectLink(T item,
                             java.util.Map<java.lang.String,java.lang.String[]> queryParams)
```
    Adds given item of this facet to application's query string (i.e. selects the item).
    
    Specified by:
    
    getSelectLink in interface Facet<T>
  - getUnselectLink
```
public final java.lang.String getUnselectLink(T item,
                               java.util.Map<java.lang.String,java.lang.String[]> queryParams)
```
    Removes given item of this facet from application's query string (i.e. unselects the item).
    
    Specified by:
    
    getUnselectLink in interface Facet<T>
  - isSelected
```
public final boolean isSelected(T item,
                 java.util.Map<java.lang.String,java.lang.String[]> queryParams)
```
    Checks whether given item of this facet is present in application's query string (i.e. it is selected).
    
    Specified by:
    
    isSelected in interface Facet<T>

Class FacetBase<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.sphere.client.facets.Facet

Field Detail

queryParam

attribute

isSingleSelect

Constructor Detail

FacetBase

Method Detail

getAttributeName

getUrlParams

getSelectLink

getUnselectLink

isSelected