com.exalead.search.v30

Class AdditionalCategoryFacetView

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.AdditionalFacetView

com.exalead.search.v30.AdditionalCategoryFacetView

All Implemented Interfaces:

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

public class AdditionalCategoryFacetView
extends AdditionalFacetView
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

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

AdditionalFacetView.Transformer<T>, AdditionalFacetView.Visitor

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

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT
int	maxCategoryTreeDepth
int	maxCategoryTreeDepthFromRoot

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

id

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
AdditionalCategoryFacetView()
AdditionalCategoryFacetView(AdditionalCategoryFacetView o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(AdditionalFacetView.Transformer<T> transformer, T[] t)
void	accept(AdditionalFacetView.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 AdditionalCategoryFacetView.
static AdditionalCategoryFacetView	fromString(java.lang.String s) String representation of this AdditionalCategoryFacetView.
int	getMaxCategoryTreeDepth() Maximum number of categories displayed in the facet from the current refinement. Setting this attribute to N means that no categories will be kept below this level. 0 means no limit.
int	getMaxCategoryTreeDepthFromRoot() Maximum depth of the category tree displayed in the facet from the Top/ level.
AdditionalCategoryFacetView	makeCopy() Creates and returns a deep copy of this AdditionalCategoryFacetView.
static AdditionalCategoryFacetView	readFrom(java.io.InputStream is) Read this AdditionalCategoryFacetView from an XML fragment.
void	setMaxCategoryTreeDepth(int maxCategoryTreeDepth) Maximum number of categories displayed in the facet from the current refinement. Setting this attribute to N means that no categories will be kept below this level. 0 means no limit.
void	setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot) Maximum depth of the category tree displayed in the facet from the Top/ level.
java.lang.String	toString() String representation of this AdditionalCategoryFacetView.
AdditionalCategoryFacetView	withAggregateScores(boolean aggregateScores) Deprecated.
AdditionalCategoryFacetView	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
AdditionalCategoryFacetView	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
AdditionalCategoryFacetView	withId(java.lang.String id)
AdditionalCategoryFacetView	withMaxCategories(int maxCategories)
AdditionalCategoryFacetView	withMaxCategories(java.lang.Integer maxCategories)
AdditionalCategoryFacetView	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
AdditionalCategoryFacetView	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
AdditionalCategoryFacetView	withMaxCategoryTreeDepth(int maxCategoryTreeDepth)
AdditionalCategoryFacetView	withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)
AdditionalCategoryFacetView	withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)
AdditionalCategoryFacetView	withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)
AdditionalCategoryFacetView	withMinDocsPerCategory(int minDocsPerCategory)
AdditionalCategoryFacetView	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
AdditionalCategoryFacetView	withReverse(boolean reverse)
AdditionalCategoryFacetView	withReverse(java.lang.Boolean reverse)
AdditionalCategoryFacetView	withSortAggregationFunction(java.lang.String sortAggregationFunction)
AdditionalCategoryFacetView	withSortFunction(java.lang.String sortFunction)
void	writeTo(java.io.OutputStream os) Write this AdditionalCategoryFacetView as an XML fragment

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

getId, setId

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

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

Constructor Detail

AdditionalCategoryFacetView

public AdditionalCategoryFacetView()

AdditionalCategoryFacetView

public AdditionalCategoryFacetView(AdditionalCategoryFacetView o)

Copy constructor

Method Detail

withId

public AdditionalCategoryFacetView withId(java.lang.String id)

Overrides:

withId in class AdditionalFacetView

withMinDocsPerCategory

public AdditionalCategoryFacetView withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class AdditionalFacetView

withMinDocsPerCategory

public AdditionalCategoryFacetView withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class AdditionalFacetView

withMaxCategories

public AdditionalCategoryFacetView withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class AdditionalFacetView

withMaxCategories

public AdditionalCategoryFacetView withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class AdditionalFacetView

withMaxCategoriesPerLevel

public AdditionalCategoryFacetView withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class AdditionalFacetView

withMaxCategoriesPerLevel

public AdditionalCategoryFacetView withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class AdditionalFacetView

withSortFunction

public AdditionalCategoryFacetView withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class AdditionalFacetView

withSortAggregationFunction

public AdditionalCategoryFacetView withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class AdditionalFacetView

withExplicitSortOrderValues

public AdditionalCategoryFacetView withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class AdditionalFacetView

withReverse

public AdditionalCategoryFacetView withReverse(boolean reverse)

Overrides:

withReverse in class AdditionalFacetView

withReverse

public AdditionalCategoryFacetView withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class AdditionalFacetView

withAggregateScores

@Deprecated
public AdditionalCategoryFacetView withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class AdditionalFacetView

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class AdditionalFacetView

setMaxCategoryTreeDepth

public void setMaxCategoryTreeDepth(int maxCategoryTreeDepth)

Maximum number of categories displayed in the facet from the current refinement.
Setting this attribute to N means that no categories will be kept below this level.
0 means no limit.

getMaxCategoryTreeDepth

public int getMaxCategoryTreeDepth()

Maximum number of categories displayed in the facet from the current refinement.
Setting this attribute to N means that no categories will be kept below this level.
0 means no limit.

withMaxCategoryTreeDepth

public AdditionalCategoryFacetView withMaxCategoryTreeDepth(int maxCategoryTreeDepth)

withMaxCategoryTreeDepth

public AdditionalCategoryFacetView withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)

setMaxCategoryTreeDepthFromRoot

public void setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

Maximum depth of the category tree displayed in the facet from the Top/ level.
You can't go further than this limit whatever the refinement level.
0 means no limit.

getMaxCategoryTreeDepthFromRoot

public int getMaxCategoryTreeDepthFromRoot()

Maximum depth of the category tree displayed in the facet from the Top/ level.
You can't go further than this limit whatever the refinement level.
0 means no limit.

withMaxCategoryTreeDepthFromRoot

public AdditionalCategoryFacetView withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

withMaxCategoryTreeDepthFromRoot

public AdditionalCategoryFacetView withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)

makeCopy

public AdditionalCategoryFacetView makeCopy()

Creates and returns a deep copy of this AdditionalCategoryFacetView.

Overrides:

makeCopy in class AdditionalFacetView

readFrom

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

Read this AdditionalCategoryFacetView 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 AdditionalCategoryFacetView as an XML fragment

Overrides:

writeTo in class AdditionalFacetView

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AdditionalCategoryFacetView.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AdditionalCategoryFacetView.

Overrides:

toString in class AdditionalFacetView

check

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

Checks this AdditionalCategoryFacetView.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AdditionalFacetView

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class AdditionalFacetView

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class AdditionalFacetView

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class AdditionalFacetView

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class AdditionalFacetView

Throws:

com.exalead.util.TypedException