T
- Type of items returned for this facet:
TermFacetItem
,
RangeFacetItem
.public interface Facet<T>
FacetParser
for reconstructing state of multiple facets from application's URL.
Use {#getUrlParams} to construct URLs for selecting individual facet items.
You can also use helper methods {#getSelectLink}, {#getUnselectLink} and {#isSelected}
that make use of {#getUrlParams}.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttributeName()
The attribute for which this facet is aggregating 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.
|
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.
|
FacetExpression |
parse(java.util.Map<java.lang.String,java.lang.String[]> queryString)
Creates a backend facet query based on application's URL query parameters.
|
Facet<T> |
setQueryParam(java.lang.String queryParam)
Sets a custom query parameter name that will represent this facet in application's query string.
|
Facet<T> |
setSingleSelect(boolean isSingleSelect)
If set to true, the user will only be able to select a single value at a time.
|
java.lang.String getAttributeName()
FacetExpression parse(java.util.Map<java.lang.String,java.lang.String[]> queryString)
Facet<T> setQueryParam(java.lang.String queryParam)
Facet<T> setSingleSelect(boolean isSingleSelect)
isSingleSelect
influences the behavior of getSelectLink(T, java.util.Map<java.lang.String, java.lang.String[]>)
.java.util.List<QueryParam> getUrlParams(T item)
boolean isSelected(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)
java.lang.String getSelectLink(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)
java.lang.String getUnselectLink(T item, java.util.Map<java.lang.String,java.lang.String[]> queryParams)