com.exalead.search.v30

Class CategoryFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.CategoryFacet

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class CategoryFacet
extends Facet
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for a facet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CategoryFacet.Form

Nested classes/interfaces inherited from class com.exalead.search.v30.Facet

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Transformer<T>, Facet.Type, Facet.Visitor

Nested classes/interfaces inherited from class com.exalead.search.v30.FacetView

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	categoryField
static java.lang.String	DEFAULT_FORM
static int	DEFAULT_HITS_MAX_CATEGORIES
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT
java.lang.String	form
int	hitsMaxCategories
int	maxCategoryTreeDepth
int	maxCategoryTreeDepthFromRoot
java.lang.String	root

Fields inherited from class com.exalead.search.v30.Facet

additionalFacetView, aggregationFunction, dataModelClass, dataModelProperty, dataModelState, DEFAULT_IMPLEMENTATION, DEFAULT_IN_HITS, DEFAULT_IN_NAVIGATION, DEFAULT_MAX_SLICE_CATEGORIES, DEFAULT_REFINEMENT_POLICY, fromDataModel, id, implementation, index, inHits, inNavigation, maxSliceCategories, refinementPolicy, type

Fields inherited from class com.exalead.search.v30.FacetView

aggregateScores, DEFAULT_AGGREGATE_SCORES, DEFAULT_MAX_CATEGORIES, DEFAULT_MAX_CATEGORIES_PER_LEVEL, DEFAULT_MIN_DOCS_PER_CATEGORY, DEFAULT_REVERSE, DEFAULT_SORT_FUNCTION, explicitSortOrderValues, maxCategories, maxCategoriesPerLevel, minDocsPerCategory, reverse, sortAggregationFunction, sortFunction

Constructor Summary

Constructors

Constructor and Description
CategoryFacet()
CategoryFacet(CategoryFacet o) Copy constructor
CategoryFacet(java.lang.String id, java.lang.String categoryField, java.lang.String root)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Facet.Transformer<T> transformer, T[] t)
void	accept(Facet.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this CategoryFacet.
static CategoryFacet	fromString(java.lang.String s) String representation of this CategoryFacet.
java.lang.String	getCategoryField() Specifies from which field the categories should be retrieved.
java.lang.String	getForm() Normalization form for the category path.
CategoryFacet.Form	getFormAsEnum() Normalization form for the category path.
int	getHitsMaxCategories() Maximum number of facet values displayed in hits.
int	getMaxCategoryTreeDepth() Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).
int	getMaxCategoryTreeDepthFromRoot() Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level.
java.lang.String	getRoot() In the categories field, category values are stored in a tree.
static boolean	isA(java.lang.String str, CategoryFacet.Form item)
static boolean	isOneOf(java.lang.String str, CategoryFacet.Form... items)
CategoryFacet	makeCopy() Creates and returns a deep copy of this CategoryFacet.
static CategoryFacet	readFrom(java.io.InputStream is) Read this CategoryFacet from an XML fragment.
void	setCategoryField(java.lang.String categoryField) Specifies from which field the categories should be retrieved.
void	setForm(CategoryFacet.Form item) Normalization form for the category path.
void	setForm(java.lang.String form) Normalization form for the category path.
void	setHitsMaxCategories(int hitsMaxCategories) Maximum number of facet values displayed in hits.
void	setMaxCategoryTreeDepth(int maxCategoryTreeDepth) Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).
void	setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot) Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level.
void	setRoot(java.lang.String root) In the categories field, category values are stored in a tree.
java.lang.String	toString() String representation of this CategoryFacet.
CategoryFacet	withAdditionalFacetView(AdditionalFacetView... __values)
CategoryFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
CategoryFacet	withAggregateScores(boolean aggregateScores) Deprecated.
CategoryFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
CategoryFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
CategoryFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
CategoryFacet	withCategoryField(java.lang.String categoryField)
CategoryFacet	withDataModelClass(java.lang.String dataModelClass)
CategoryFacet	withDataModelProperty(java.lang.String dataModelProperty)
CategoryFacet	withDataModelState(java.lang.String dataModelState)
CategoryFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
CategoryFacet	withForm(java.lang.String form)
CategoryFacet	withFromDataModel(Facet fromDataModel)
CategoryFacet	withHitsMaxCategories(int hitsMaxCategories)
CategoryFacet	withHitsMaxCategories(java.lang.Integer hitsMaxCategories)
CategoryFacet	withId(java.lang.String id)
CategoryFacet	withImplementation(java.lang.String implementation)
CategoryFacet	withIndex(int index)
CategoryFacet	withIndex(java.lang.Integer index)
CategoryFacet	withInHits(boolean inHits)
CategoryFacet	withInHits(java.lang.Boolean inHits)
CategoryFacet	withInNavigation(boolean inNavigation)
CategoryFacet	withInNavigation(java.lang.Boolean inNavigation)
CategoryFacet	withMaxCategories(int maxCategories)
CategoryFacet	withMaxCategories(java.lang.Integer maxCategories)
CategoryFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
CategoryFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
CategoryFacet	withMaxCategoryTreeDepth(int maxCategoryTreeDepth)
CategoryFacet	withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)
CategoryFacet	withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)
CategoryFacet	withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)
CategoryFacet	withMaxSliceCategories(int maxSliceCategories)
CategoryFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
CategoryFacet	withMinDocsPerCategory(int minDocsPerCategory)
CategoryFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
CategoryFacet	withRefinementPolicy(java.lang.String refinementPolicy)
CategoryFacet	withReverse(boolean reverse)
CategoryFacet	withReverse(java.lang.Boolean reverse)
CategoryFacet	withRoot(java.lang.String root)
CategoryFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
CategoryFacet	withSortFunction(java.lang.String sortFunction)
CategoryFacet	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this CategoryFacet as an XML fragment

Methods inherited from class com.exalead.search.v30.Facet

getAdditionalFacetView, getAdditionalFacetViewAsMap, getAdditionalFacetViewById, getAggregationFunction, getAggregationFunctionAsMap, getAggregationFunctionById, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getId, getImplementation, getImplementationAsEnum, getIndex, getMaxSliceCategories, getRefinementPolicy, getRefinementPolicyAsEnum, getType, getTypeAsEnum, isA, isA, isA, isInHits, isInNavigation, isOneOf, isOneOf, isOneOf, removeAdditionalFacetViewById, removeAggregationFunctionById, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setId, setImplementation, setImplementation, setIndex, setInHits, setInNavigation, setMaxSliceCategories, setRefinementPolicy, setRefinementPolicy, setType, setType

Methods inherited from class com.exalead.search.v30.FacetView

getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction

Methods inherited from class java.lang.Object

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

Field Detail

root

public java.lang.String root

maxCategoryTreeDepth

public int maxCategoryTreeDepth

DEFAULT_MAX_CATEGORY_TREE_DEPTH

public static final int DEFAULT_MAX_CATEGORY_TREE_DEPTH

See Also:

Constant Field Values

maxCategoryTreeDepthFromRoot

public int maxCategoryTreeDepthFromRoot

DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT

public static final int DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT

See Also:

Constant Field Values

categoryField

public java.lang.String categoryField

form

public java.lang.String form

DEFAULT_FORM

public static final java.lang.String DEFAULT_FORM

See Also:

Constant Field Values

hitsMaxCategories

public int hitsMaxCategories

DEFAULT_HITS_MAX_CATEGORIES

public static final int DEFAULT_HITS_MAX_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

CategoryFacet

public CategoryFacet()

CategoryFacet

public CategoryFacet(java.lang.String id,
                     java.lang.String categoryField,
                     java.lang.String root)

CategoryFacet

public CategoryFacet(CategoryFacet o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          CategoryFacet.Form item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              CategoryFacet.Form... items)

setForm

public void setForm(CategoryFacet.Form item)

Normalization form for the category path. Value can be one of

• exact
• lowercase
• normalized

This must match the form with which the category has been mapped at indexing time.

getFormAsEnum

public CategoryFacet.Form getFormAsEnum()

Normalization form for the category path. Value can be one of

• exact
• lowercase
• normalized

This must match the form with which the category has been mapped at indexing time.

withId

public CategoryFacet withId(java.lang.String id)

Overrides:

withId in class Facet

withType

public CategoryFacet withType(java.lang.String type)

Overrides:

withType in class Facet

withIndex

public CategoryFacet withIndex(int index)

Overrides:

withIndex in class Facet

withIndex

public CategoryFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class Facet

withRefinementPolicy

public CategoryFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class Facet

withImplementation

public CategoryFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class Facet

withDataModelState

public CategoryFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class Facet

withFromDataModel

public CategoryFacet withFromDataModel(Facet fromDataModel)

withDataModelClass

public CategoryFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class Facet

withDataModelProperty

public CategoryFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class Facet

withInNavigation

public CategoryFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInNavigation

public CategoryFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInHits

public CategoryFacet withInHits(boolean inHits)

Overrides:

withInHits in class Facet

withInHits

public CategoryFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class Facet

withAggregationFunction

public CategoryFacet withAggregationFunction(AggregationFunction... __values)

A numerical computation to perform on hits matching each value of the facet.

Overrides:

withAggregationFunction in class Facet

withAggregationFunction

public CategoryFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)

Overrides:

withAggregationFunction in class Facet

withAdditionalFacetView

public CategoryFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class Facet

withAdditionalFacetView

public CategoryFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)

Overrides:

withAdditionalFacetView in class Facet

withMaxSliceCategories

public CategoryFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMaxSliceCategories

public CategoryFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMinDocsPerCategory

public CategoryFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMinDocsPerCategory

public CategoryFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMaxCategories

public CategoryFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategories

public CategoryFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategoriesPerLevel

public CategoryFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withMaxCategoriesPerLevel

public CategoryFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withSortFunction

public CategoryFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class Facet

withSortAggregationFunction

public CategoryFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class Facet

withExplicitSortOrderValues

public CategoryFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class Facet

withReverse

public CategoryFacet withReverse(boolean reverse)

Overrides:

withReverse in class Facet

withReverse

public CategoryFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class Facet

withAggregateScores

@Deprecated
public CategoryFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class Facet

withAggregateScores

@Deprecated
public CategoryFacet withAggregateScores(java.lang.Boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class Facet

setRoot

public void setRoot(java.lang.String root)

In the categories field, category values are stored in a tree. The root of the tree is called "Top".

getRoot

public java.lang.String getRoot()

In the categories field, category values are stored in a tree. The root of the tree is called "Top".

withRoot

public CategoryFacet withRoot(java.lang.String root)

setMaxCategoryTreeDepth

public void setMaxCategoryTreeDepth(int maxCategoryTreeDepth)

Maximum depth of the returned category tree.
Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).

getMaxCategoryTreeDepth

public int getMaxCategoryTreeDepth()

Maximum depth of the returned category tree.
Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).

withMaxCategoryTreeDepth

public CategoryFacet withMaxCategoryTreeDepth(int maxCategoryTreeDepth)

withMaxCategoryTreeDepth

public CategoryFacet withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)

setMaxCategoryTreeDepthFromRoot

public void setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

Maximum depth of the returned category tree, starting from the global root of the category.
Setting this attribute to N means that no categories will be kept below this level.

getMaxCategoryTreeDepthFromRoot

public int getMaxCategoryTreeDepthFromRoot()

Maximum depth of the returned category tree, starting from the global root of the category.
Setting this attribute to N means that no categories will be kept below this level.

withMaxCategoryTreeDepthFromRoot

public CategoryFacet withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

withMaxCategoryTreeDepthFromRoot

public CategoryFacet withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)

setCategoryField

public void setCategoryField(java.lang.String categoryField)

Specifies from which field the categories should be retrieved.

getCategoryField

public java.lang.String getCategoryField()

Specifies from which field the categories should be retrieved.

withCategoryField

public CategoryFacet withCategoryField(java.lang.String categoryField)

setForm

public void setForm(java.lang.String form)

Normalization form for the category path. Value can be one of

• exact
• lowercase
• normalized

This must match the form with which the category has been mapped at indexing time.

getForm

public java.lang.String getForm()

Normalization form for the category path. Value can be one of

• exact
• lowercase
• normalized

This must match the form with which the category has been mapped at indexing time.

withForm

public CategoryFacet withForm(java.lang.String form)

setHitsMaxCategories

public void setHitsMaxCategories(int hitsMaxCategories)

Maximum number of facet values displayed in hits.

getHitsMaxCategories

public int getHitsMaxCategories()

Maximum number of facet values displayed in hits.

withHitsMaxCategories

public CategoryFacet withHitsMaxCategories(int hitsMaxCategories)

withHitsMaxCategories

public CategoryFacet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

makeCopy

public CategoryFacet makeCopy()

Creates and returns a deep copy of this CategoryFacet.

Overrides:

makeCopy in class Facet

readFrom

public static CategoryFacet readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this CategoryFacet from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this CategoryFacet as an XML fragment

Overrides:

writeTo in class Facet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static CategoryFacet fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this CategoryFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CategoryFacet.

Overrides:

toString in class Facet

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this CategoryFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Facet

Throws:

com.exalead.util.TypedException

accept

public void accept(Facet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public void accept(FacetView.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Facet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException