sirius.web.controller

Class FacetItem

java.lang.Object

sirius.web.controller.FacetItem

public class FacetItem
extends Object

Represents a single item of a Facet.

Constructor Summary

Constructors

Constructor and Description
FacetItem(String key, String title, int count, boolean active) Creates a new FacesItem.

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns the number of matches of the represented key.
String	getKey() Returns the content value represented by this item.
String	getTitle() Returns the title shown to the user when displaying this item.
boolean	isActive() Determines if this item is an currently active filter.
void	setActive(boolean active) Sets the active flag indicating if this is currently an active filter.
void	setCount(int count) Sets the number of matches.
void	setKey(String key) Sets the key or content represented by this item.
void	setTitle(String title) Sets the title shown to the user when displaying this item.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetItem

public FacetItem(String key,
                 String title,
                 int count,
                 boolean active)

Creates a new FacesItem.

Parameters:

key - the content value represented by this item

title - the visual item used to display this item to the user

count - the number of matches found

active - determines if this item is an active filter setting

Method Detail

getKey

public String getKey()

Returns the content value represented by this item.

Returns:

the key or content represented by this item

setKey

public void setKey(String key)

Sets the key or content represented by this item.

Parameters:

key - the content to set

getTitle

public String getTitle()

Returns the title shown to the user when displaying this item.

Returns:

the user representation of this item

setTitle

public void setTitle(String title)

Sets the title shown to the user when displaying this item.

Parameters:

title - the new title

getCount

public int getCount()

Returns the number of matches of the represented key.

Returns:

the number of matches

setCount

public void setCount(int count)

Sets the number of matches.

Parameters:

count - the new number of matches

isActive

public boolean isActive()

Determines if this item is an currently active filter.

Returns:

true if this is currently an active filter, false otherwise

setActive

public void setActive(boolean active)

Sets the active flag indicating if this is currently an active filter.

Parameters:

active - true to mark this as an active filter, false otherwise

toString

public String toString()

Overrides:

toString in class Object