EnumFacetGroupImpl (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.searchapi.xmlv10.client.results.fleaimpl.EnumFacetGroupImpl

All Implemented Interfaces:: CategoryGroup, java.io.Serializable

public class EnumFacetGroupImpl
extends java.lang.Object
implements CategoryGroup, java.io.Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

com.exalead.search.internal.answer.HitEnumFacet fleaHitEnumFacet

Fields
Modifier and Type	Field and Description
`com.exalead.search.internal.answer.HitEnumFacet`	`fleaHitEnumFacet`

Constructor Summary

Constructors
Constructor and Description

EnumFacetGroupImpl(com.exalead.search.internal.answer.HitEnumFacet facet)

Constructors
Constructor and Description
`EnumFacetGroupImpl(com.exalead.search.internal.answer.HitEnumFacet facet)`

Method Summary

All Methods Instance Methods Concrete 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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class EnumFacetGroupImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fleaHitEnumFacet

Constructor Detail

EnumFacetGroupImpl

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