com.exalead.searchapi.xmlv10.client

Interface Category

All Superinterfaces:

Topic

All Known Implementing Classes:

CategoryImpl, CategoryImpl

public interface Category
extends Topic

The Category is the main component of the navigation. The category is a node of the category tree as it may hold a list children categories

Use the id of the category for the refinements

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Category.CategoryAlphanumComparator
static class	Category.CategoryCountComparator
static class	Category.CategoryNumComparator
static class	Category.CategoryReducer
static class	Category.CategoryScoreComparator

Nested classes/interfaces inherited from interface com.exalead.searchapi.xmlv10.client.Topic

Topic.State

Method Summary

Modifier and Type	Method and Description
java.util.List<Category>	getCategories() Get the children of this category.
java.lang.String	getData() Get the data attached to the category.
int	getDepthFromGroupRoot() Get the depth in the tree of this category, relative to the root of the facet.
double	getDoubleAggregationValue(int idx) Get the value of an aggregation function on this category.
double	getDoubleAggregationValue(java.lang.String id) Get the value of an aggregation function on this category.
java.lang.String	getId() Get the id of the category.
java.util.Map<java.lang.String,java.lang.String>	getInfos() Get some additional information about this category.
long	getLongAggregationValue(int idx) Get the value of an aggregation function on this category.
long	getLongAggregationValue(java.lang.String id) Get the value of an aggregation function on this category.
long	getNbClippedChildren() Number of direct children clipped from the results.
Category	getParent() Get the parent of this category within the category tree (eg: for the category with the following path "Top/Source/nntp/microsoft" the parent category returned will have the following path "Top/Source/nntp"
java.lang.String	getPath() Get the full path of the category within the category tree (eg: "Top/Author/Martin").
java.lang.String	getStringAggregationValue(int idx) Get the value of an aggregation function on this category.
java.lang.String	getStringAggregationValue(java.lang.String id) Get the value of an aggregation function on this category.
java.lang.String	getTitle() Returns the 'title' of the category.

Methods inherited from interface com.exalead.searchapi.xmlv10.client.Topic

getCount, getHitCount, getScore, getState, getZapId

Method Detail

getPath

java.lang.String getPath()

Get the full path of the category within the category tree (eg: "Top/Author/Martin"). The category path is the unique identifier of this category. It can be used to drive a search on this category. Do not use the path for refining on this category, use the id.

getTitle

java.lang.String getTitle()

Returns the 'title' of the category. The category title is a suitable display form for this category. It is often the leaf chunk of the category path, but not always. (eg: Martin for Top/Author/Martin) Refer to the documentation for more details on creating category titles.

Specified by:

getTitle in interface Topic

getId

java.lang.String getId()

Get the id of the category. This id must be used to refine on this category. To perform an exclusion refinement, it must be prefixed by "-" when using SearchParameter.REFINE). It can be prefixed by "+" for a regular refinement.

Specified by:

getId in interface Topic

getData

java.lang.String getData()

Get the data attached to the category.

getNbClippedChildren

long getNbClippedChildren()

Number of direct children clipped from the results.

getParent

Category getParent()

Get the parent of this category within the category tree (eg: for the category with the following path "Top/Source/nntp/microsoft" the parent category returned will have the following path "Top/Source/nntp"

getInfos

java.util.Map<java.lang.String,java.lang.String> getInfos()

Get some additional information about this category. The following keys may be available:

• "zapId", Category id for zap action.
• "count", Category count (number of occurrences of this category)
• "score", Category score (sum of the scores of all matching hits)

getCategories

java.util.List<Category> getCategories()

Get the children of this category.

getLongAggregationValue

long getLongAggregationValue(java.lang.String id)
                      throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getLongAggregationValue

long getLongAggregationValue(int idx)
                      throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getDoubleAggregationValue

double getDoubleAggregationValue(java.lang.String id)
                          throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getDoubleAggregationValue

double getDoubleAggregationValue(int idx)
                          throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getStringAggregationValue

java.lang.String getStringAggregationValue(java.lang.String id)
                                    throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getStringAggregationValue

java.lang.String getStringAggregationValue(int idx)
                                    throws SearchClientException

Get the value of an aggregation function on this category. Please refer to the Search Architecture Guide for more information about aggregation functions. returns AggregationFunction.UNDEFINED_VALUE if the function exists but has no value (e.g. when no document in the category has the function's virtualExpr set)

Throws:

SearchClientException

getDepthFromGroupRoot

int getDepthFromGroupRoot()

Get the depth in the tree of this category, relative to the root of the facet.