CategoryGroup (NETVIBES Exalead CloudView Clients SDK)

All Known Implementing Classes:

CategoryGroupImpl, CategoryGroupImpl, EnumFacetGroupImpl
```
public interface CategoryGroup
```
Top level component of the category tree which holds a list of categories for a given facet.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`additionalFacetData()` Get optional additional facet data in the form of a FLEA object.
`Hierarchical2DFacet`	`asHierarchical2DFacet()` Get a hierarchical 2D representation of the CategoryGroup.
`MultiDimensionFacet`	`asMultiDimensionFacet()` Get a MultiDimensionFacet representation of the CategoryGroup.
`java.util.Iterator<Category>`	`categoryTreeIterator()` Deprecated. use getCategoryTree()
`java.util.List<AggregationFunction>`	`getAggregationFunctions()`
`java.util.List<Category>`	`getCategories()` Get the top-level categories in this facet.
`java.util.List<CategoryGroupInfo>`	`getCategoryGroupInfos()` Get the list of associated extra informations
`java.lang.Iterable<Category>`	`getCategoryTree()`
`java.lang.Long`	`getCount()`
`double`	`getDoubleAggregationValue(int idx)` Get the value of an aggregation function for the whole group.
`double`	`getDoubleAggregationValue(java.lang.String id)` Get the value of an aggregation function for the whole group.
`java.lang.Long`	`getGlobalCount()`
`java.lang.Iterable<Category>`	`getLeafCategories()`
`long`	`getLongAggregationValue(int idx)` Get the value of an aggregation function for the whole group.
`long`	`getLongAggregationValue(java.lang.String id)` Get the value of an aggregation function for the whole group.
`java.lang.String`	`getName()` Get the name, or identifier of this category group.
`java.lang.Long`	`getNbClippedCategories()`
`java.lang.String`	`getRefinementPolicy()` Get the associated refinement policy
`java.lang.String`	`getRoot()` Get the root path of this facet.
`java.lang.String`	`getStringAggregationValue(int idx)` Get the value of an aggregation function for the whole group.
`java.lang.String`	`getStringAggregationValue(java.lang.String id)` Get the value of an aggregation function for the whole group.
`java.lang.Long`	`getTotalClippedCategories()`
`java.lang.String`	`getType()` Get the associated facet type
`boolean`	`isRefinable()`
`java.util.Iterator<Category>`	`leafCategoriesIterator()` Deprecated. use getLeafCategories()

- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name, or identifier of this category group. This matches the "id" of the QueryCategoryGroup or Facet in the search configuration
  - getRoot
```
java.lang.String getRoot()
```
    Get the root path of this facet.
  - getCategories
```
java.util.List<Category> getCategories()
```
    Get the top-level categories in this facet. Each category holds a list of children categories. See Category
  - getCategoryTree
```
java.lang.Iterable<Category> getCategoryTree()
```
    Returns:
    
    an iterable allowing to iterate over the categories, keeping the order of the categories in tree.
  - categoryTreeIterator
```
@Deprecated
java.util.Iterator<Category> categoryTreeIterator()
```
    Deprecated. use getCategoryTree()
    
    Returns:
    
    an iterator over the categories, keeping the order of the categories in the tree
  - getLeafCategories
```
java.lang.Iterable<Category> getLeafCategories()
```
    Returns:
    
    an iterable allowing to iterate over the leaf categories of the tree.
  - leafCategoriesIterator
```
@Deprecated
java.util.Iterator<Category> leafCategoriesIterator()
```
    Deprecated. use getLeafCategories()
    
    Returns:
    
    an iterator over the categories, keeping the order of the categories in the tree
  - getAggregationFunctions
```
java.util.List<AggregationFunction> getAggregationFunctions()
```
    Returns:
    
    a list of aggregation functions defined for this group
  - getCount
```
java.lang.Long getCount()
```
    Returns:
    
    the number of hits having any of the categories in this tree.
  - getGlobalCount
```
java.lang.Long getGlobalCount()
```
    Returns:
    
    an approximation of the number of documents in the corpus having any of the categories in this tree.
  - getNbClippedCategories
```
java.lang.Long getNbClippedCategories()
```
    Returns:
    
    the number of top-level categories clipped from the results
  - getTotalClippedCategories
```
java.lang.Long getTotalClippedCategories()
```
    Returns:
    
    the recursive total number of categories clipped from the results, from the root
  - getLongAggregationValue
```
long getLongAggregationValue(java.lang.String id)
                      throws SearchClientException
```
    Get the value of an aggregation function for the whole group. 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 for the whole group. 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 for the whole group. 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 for the whole group. 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 for the whole group. 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 for the whole group. 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
  - isRefinable
```
boolean isRefinable()
```
    Returns:
    
    true if the facet corresponding to this category group is refinable.
  - asHierarchical2DFacet
```
Hierarchical2DFacet asHierarchical2DFacet()
                                   throws java.lang.IllegalStateException
```
    Get a hierarchical 2D representation of the CategoryGroup. Throws IllegalStateException if the result cannot be represented as a Hierarchical2DFacet.
    
    Throws:
    
    java.lang.IllegalStateException
  - asMultiDimensionFacet
```
MultiDimensionFacet asMultiDimensionFacet()
                                   throws java.lang.IllegalStateException
```
    Get a MultiDimensionFacet representation of the CategoryGroup. Throws IllegalStateException if the result cannot be represented as a MultiDimensionFacet.
    
    Throws:
    
    java.lang.IllegalStateException
  - additionalFacetData
```
java.lang.Object additionalFacetData()
```
    Get optional additional facet data in the form of a FLEA object. Returns null if there is no available data.
  - getRefinementPolicy
```
java.lang.String getRefinementPolicy()
```
    Get the associated refinement policy
  - getType
```
java.lang.String getType()
```
    Get the associated facet type
  - getCategoryGroupInfos
```
java.util.List<CategoryGroupInfo> getCategoryGroupInfos()
```
    Get the list of associated extra informations

Interface CategoryGroup

Method Summary

Method Detail

getName

getRoot

getCategories

getCategoryTree

categoryTreeIterator

getLeafCategories

leafCategoriesIterator

getAggregationFunctions

getCount

getGlobalCount

getNbClippedCategories

getTotalClippedCategories

getLongAggregationValue

getLongAggregationValue

getDoubleAggregationValue

getDoubleAggregationValue

getStringAggregationValue

getStringAggregationValue

isRefinable

asHierarchical2DFacet

asMultiDimensionFacet

additionalFacetData

getRefinementPolicy

getType

getCategoryGroupInfos