sirius.web.controller

Class Facet

java.lang.Object

sirius.web.controller.Facet

public class Facet
extends Object

Represents a filter facet used by search / query results.

Field Summary

Fields

Modifier and Type	Field and Description
protected Page<?>	parent

Constructor Summary

Constructors

Constructor and Description
Facet(String title, String field, String value, sirius.kernel.cache.ValueComputer<String,String> translator) Creates a new faced with the given parameters.

Method Summary

Modifier and Type	Method and Description
<E extends Enum<E>> Facet	addEnumItem(Class<E> enumClass) Adds the enum constants of the given enum to the facet.
Facet	addItem(String key, String title, int count) Adds a facet item
Facet	addItems(Iterable<String> items) Adds the given collections of items.
String	createToggleQueryString(FacetItem item) Creates a query string which can be appended to a link in order to toggle the given item.
List<FacetItem>	getHiddenItems() Returns all hidden items collected for this facet.
List<FacetItem>	getItems() Returns all visible items collected for this facet.
int	getMaxVisibleFacetItems() Returns the maximum number of items that should be visible.
String	getName() Returns the name of this facet.
FacetRange	getRange() Returns the used facet range.
String	getTitle() Returns the title of this fact.
String	getValue() Returns the selected value.
boolean	hasHiddenItems() Determines if this facet has at least one hidden item
boolean	hasItems() Determines if this facet has at least one item
boolean	hasRange() Determines if this facet has a range for filtering values.
boolean	isFacetCollapsingEnabled() Determines if collapsing is enabled for this facet.
Facet	withFacetCollapsingEnabled(boolean facetCollapsingEnabled) Enables or disables collapsing for this facet.
Facet	withMaxVisibleFacetItems(int maxVisibleFacetItems) Sets the number of visible facet items.
Facet	withRange(FacetRange facetRange) Specifies the facet range to use for this facet.
Facet	withValue(String value) Specifies the value used for this facet.
Facet	withValues(List<String> values) Specifies the values used for this facet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected Page<?> parent

Constructor Detail

Facet

public Facet(String title,
             String field,
             @Nullable
             String value,
             @Nullable
             sirius.kernel.cache.ValueComputer<String,String> translator)

Creates a new faced with the given parameters.

Parameters:

title - the visible name of the facet

field - the internal name of the facet

value - the selected value

translator - the translator which provides "official" labels for filter values.

Method Detail

getItems

public List<FacetItem> getItems()

Returns all visible items collected for this facet.

Returns:

a list of all visible items of this facet

getHiddenItems

public List<FacetItem> getHiddenItems()

Returns all hidden items collected for this facet.

Returns:

a list of all hidden items of this facet, or an empty list if there are none

createToggleQueryString

public String createToggleQueryString(FacetItem item)

Creates a query string which can be appended to a link in order to toggle the given item.

Parameters:

item - the item to toggle

Returns:

a query string (?x=y..) used to toggle the given facet item

getName

public String getName()

Returns the name of this facet.

Returns:

the internal name of this facet

getTitle

public String getTitle()

Returns the title of this fact.

Returns:

the visible title of this facet

getValue

public String getValue()

Returns the selected value.

Returns:

the selected filter value of this facet

addItem

public Facet addItem(String key,
                     String title,
                     int count)

Adds a facet item

Parameters:

key - the filter value of the item

title - the public visible name of the item

count - the number of matched for this item

Returns:

the facet itself for fluent method calls

addItems

public Facet addItems(Iterable<String> items)

Adds the given collections of items.

Parameters:

items - the items to add

Returns:

the facet itself for fluent method calls

addEnumItem

public <E extends Enum<E>> Facet addEnumItem(Class<E> enumClass)

Adds the enum constants of the given enum to the facet.

Type Parameters:

E - the type of the enum

Parameters:

enumClass - the enum class which constants are to be added

Returns:

the facet itself for fluent method calls

withFacetCollapsingEnabled

public Facet withFacetCollapsingEnabled(boolean facetCollapsingEnabled)

Enables or disables collapsing for this facet.

Parameters:

facetCollapsingEnabled - true to enable facet collapsing, false otherwise

Returns:

the facet itself for fluent method calls

isFacetCollapsingEnabled

public boolean isFacetCollapsingEnabled()

Determines if collapsing is enabled for this facet.

Returns:

true if facet collapsing is enabled, false otherwise

withMaxVisibleFacetItems

public Facet withMaxVisibleFacetItems(int maxVisibleFacetItems)

Sets the number of visible facet items.

Parameters:

maxVisibleFacetItems - the number of visible facet items

Returns:

the facet itself for fluent method calls

getMaxVisibleFacetItems

public int getMaxVisibleFacetItems()

Returns the maximum number of items that should be visible.

Returns:

the maximum number of visible facet items

hasItems

public boolean hasItems()

Determines if this facet has at least one item

Returns:

true if this facet has at least one item, false otherwise

hasHiddenItems

public boolean hasHiddenItems()

Determines if this facet has at least one hidden item

Returns:

true if this facet has at least one hidden item, false otherwise

withValue

public Facet withValue(String value)

Specifies the value used for this facet.

Parameters:

value - the active filter value of this facet

Returns:

the facet itself for fluent method calls

withValues

public Facet withValues(List<String> values)

Specifies the values used for this facet.

Parameters:

values - the active filter values of this facet

Returns:

the facet itself for fluent method calls

getRange

public FacetRange getRange()

Returns the used facet range.

Returns:

the facet range

withRange

public Facet withRange(FacetRange facetRange)

Specifies the facet range to use for this facet.

Parameters:

facetRange - the facet range to use

Returns:

the facet itself for fluent method calls

hasRange

public boolean hasRange()

Determines if this facet has a range for filtering values.

Returns:

true if this facet has a range, false otherwise