Package com.funnelback.publicui.search.model.transaction

Class Facet.CategoryValue

java.lang.Object

com.funnelback.publicui.search.model.transaction.Facet.CategoryValue

Enclosing class:

Facet

public static class Facet.CategoryValue
extends Object

Value of a facet category, such as "Location = Sydney".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Facet.CategoryValue.CategoryValueBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private int	categoryDefinitionIndex	The category definition index, used for sorting by category definition.
private int	categoryValueDepth	The depth of the category value, used for sorting.
private Integer	count	Count of occurrences for this value
private String	data	Actual value of the category (Ex: "Sydney").
private String	label	Label of the value, usually the same as the data.
private String	queryStringParamName	Name of the query string parameter for this value (e.g.
private String	queryStringParamValue	Value of the query string parameter for this value (e.g.
private boolean	selected	Indicates if this value is currently selected
private String	toggleUrl	URL to use to toggle the select status of the facet value.

Constructor Summary

Constructors

Constructor	Description
CategoryValue(String data, String label, Integer count, boolean selected, String queryStringParamName, String queryStringParamValue, int categoryDefinitionIndex)
CategoryValue(String data, String label, Integer count, boolean selected, String queryStringParamName, String queryStringParamValue, String toggleUrl, int categoryValueDepth, int categoryDefinitionIndex)

Method Summary

Modifier and Type	Method	Description
static Facet.CategoryValue.CategoryValueBuilder	builder()
int	getCategoryDefinitionIndex()
int	getCategoryValueDepth()
Integer	getCount()
String	getData()
String	getLabel()
String	getQueryStringParamName()
String	getQueryStringParamValue()
String	getToggleUrl()
boolean	isSelected()
void	setCategoryValueDepth(int categoryValueDepth)
void	setCount(Integer count)
void	setData(String data)
void	setLabel(String label)
void	setQueryStringParamName(String queryStringParamName)
void	setQueryStringParamValue(String queryStringParamValue)
void	setSelected(boolean selected)
void	setToggleUrl(String toggleUrl)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

data

private String data

Actual value of the category (Ex: "Sydney").

label

private String label

Label of the value, usually the same as the data.

count

private Integer count

Count of occurrences for this value

selected

private boolean selected

Indicates if this value is currently selected

Since:

15.8

queryStringParamName

private String queryStringParamName

Name of the query string parameter for this value (e.g. f.Location|X) For internal use.

queryStringParamValue

private String queryStringParamValue

Value of the query string parameter for this value (e.g. Syndey) For internal use.

toggleUrl

private String toggleUrl

URL to use to toggle the select status of the facet value.

categoryValueDepth

private int categoryValueDepth

The depth of the category value, used for sorting.

Since:

16.0

categoryDefinitionIndex

private final int categoryDefinitionIndex

The category definition index, used for sorting by category definition.

Since:

16.0

Constructor Detail

CategoryValue

public CategoryValue(String data,
                     String label,
                     Integer count,
                     boolean selected,
                     String queryStringParamName,
                     String queryStringParamValue,
                     int categoryDefinitionIndex)

CategoryValue

public CategoryValue(String data,
                     String label,
                     Integer count,
                     boolean selected,
                     String queryStringParamName,
                     String queryStringParamValue,
                     String toggleUrl,
                     int categoryValueDepth,
                     int categoryDefinitionIndex)

Method Detail

builder

public static Facet.CategoryValue.CategoryValueBuilder builder()

toString

public String toString()

Overrides:

toString in class Object

getData

public String getData()

setData

public void setData(String data)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getCount

public Integer getCount()

setCount

public void setCount(Integer count)

isSelected

public boolean isSelected()

setSelected

public void setSelected(boolean selected)

getQueryStringParamName

public String getQueryStringParamName()

setQueryStringParamName

public void setQueryStringParamName(String queryStringParamName)

getQueryStringParamValue

public String getQueryStringParamValue()

setQueryStringParamValue

public void setQueryStringParamValue(String queryStringParamValue)

getToggleUrl

public String getToggleUrl()

setToggleUrl

public void setToggleUrl(String toggleUrl)

getCategoryValueDepth

public int getCategoryValueDepth()

setCategoryValueDepth

public void setCategoryValueDepth(int categoryValueDepth)

getCategoryDefinitionIndex

public int getCategoryDefinitionIndex()