com.exalead.search.v30

Class FacetView

java.lang.Object

com.exalead.search.v30.FacetView

All Implemented Interfaces:

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

Direct Known Subclasses:

AdditionalFacetView, Facet

public abstract class FacetView
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetView.SortFunction
static interface	FacetView.Transformer<T>
static interface	FacetView.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	aggregateScores Deprecated.
static boolean	DEFAULT_AGGREGATE_SCORES
static int	DEFAULT_MAX_CATEGORIES
static int	DEFAULT_MAX_CATEGORIES_PER_LEVEL
static int	DEFAULT_MIN_DOCS_PER_CATEGORY
static boolean	DEFAULT_REVERSE
static java.lang.String	DEFAULT_SORT_FUNCTION
java.lang.String	explicitSortOrderValues
int	maxCategories
int	maxCategoriesPerLevel
int	minDocsPerCategory
boolean	reverse
java.lang.String	sortAggregationFunction
java.lang.String	sortFunction

Constructor Summary

Constructors

Constructor and Description
FacetView()
FacetView(FacetView o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(FacetView.Transformer<T> transformer, T[] t)
abstract void	accept(FacetView.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this FacetView.
static FacetView	fromString(java.lang.String s) String representation of this FacetView.
java.lang.String	getExplicitSortOrderValues() Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).
int	getMaxCategories() Maximum number of categories to display in the facet. 0 means all categories will be displayed.
int	getMaxCategoriesPerLevel() Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level.
int	getMinDocsPerCategory() Minimum number of docs in a category for it to be included in the Refinements panel.
java.lang.String	getSortAggregationFunction() Aggregation function used to sort by aggregation values.
java.lang.String	getSortFunction() Specifies a sorting function: Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations".
FacetView.SortFunction	getSortFunctionAsEnum() Specifies a sorting function: Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations".
static boolean	isA(java.lang.String str, FacetView.SortFunction item)
boolean	isAggregateScores() Deprecated.
static boolean	isOneOf(java.lang.String str, FacetView.SortFunction... items)
boolean	isReverse() Reverse sorting order.
FacetView	makeCopy()
static FacetView	readFrom(java.io.InputStream is) Read this FacetView from an XML fragment.
void	setAggregateScores(boolean aggregateScores) Deprecated.
void	setExplicitSortOrderValues(java.lang.String explicitSortOrderValues) Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).
void	setMaxCategories(int maxCategories) Maximum number of categories to display in the facet. 0 means all categories will be displayed.
void	setMaxCategoriesPerLevel(int maxCategoriesPerLevel) Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level.
void	setMinDocsPerCategory(int minDocsPerCategory) Minimum number of docs in a category for it to be included in the Refinements panel.
void	setReverse(boolean reverse) Reverse sorting order.
void	setSortAggregationFunction(java.lang.String sortAggregationFunction) Aggregation function used to sort by aggregation values.
void	setSortFunction(FacetView.SortFunction item) Specifies a sorting function: Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations".
void	setSortFunction(java.lang.String sortFunction) Specifies a sorting function: Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations".
java.lang.String	toString() String representation of this FacetView.
FacetView	withAggregateScores(boolean aggregateScores) Deprecated.
FacetView	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
FacetView	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
FacetView	withMaxCategories(int maxCategories)
FacetView	withMaxCategories(java.lang.Integer maxCategories)
FacetView	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
FacetView	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
FacetView	withMinDocsPerCategory(int minDocsPerCategory)
FacetView	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
FacetView	withReverse(boolean reverse)
FacetView	withReverse(java.lang.Boolean reverse)
FacetView	withSortAggregationFunction(java.lang.String sortAggregationFunction)
FacetView	withSortFunction(java.lang.String sortFunction)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

minDocsPerCategory

public int minDocsPerCategory

DEFAULT_MIN_DOCS_PER_CATEGORY

public static final int DEFAULT_MIN_DOCS_PER_CATEGORY

See Also:

Constant Field Values

maxCategories

public int maxCategories

DEFAULT_MAX_CATEGORIES

public static final int DEFAULT_MAX_CATEGORIES

See Also:

Constant Field Values

maxCategoriesPerLevel

public int maxCategoriesPerLevel

DEFAULT_MAX_CATEGORIES_PER_LEVEL

public static final int DEFAULT_MAX_CATEGORIES_PER_LEVEL

See Also:

Constant Field Values

sortFunction

public java.lang.String sortFunction

DEFAULT_SORT_FUNCTION

public static final java.lang.String DEFAULT_SORT_FUNCTION

See Also:

Constant Field Values

sortAggregationFunction

public java.lang.String sortAggregationFunction

explicitSortOrderValues

public java.lang.String explicitSortOrderValues

reverse

public boolean reverse

DEFAULT_REVERSE

public static final boolean DEFAULT_REVERSE

See Also:

Constant Field Values

aggregateScores

@Deprecated
public boolean aggregateScores

Deprecated.

DEFAULT_AGGREGATE_SCORES

public static final boolean DEFAULT_AGGREGATE_SCORES

See Also:

Constant Field Values

Constructor Detail

FacetView

public FacetView()

FacetView

public FacetView(FacetView o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          FacetView.SortFunction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              FacetView.SortFunction... items)

setSortFunction

public void setSortFunction(FacetView.SortFunction item)

Specifies a sorting function:

• Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending.
• Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• Date: Sorts the categories by:
  • Default with decreasing year, increasing month, increasing day
  • Reverse with increasing year, decreasing month, decreasing day
• Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values.
• Latitude: Sorts the categories by latitude, using the average of points.
• Longitude: Sorts the categories by longitude, using the average of points.
• Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.

getSortFunctionAsEnum

public FacetView.SortFunction getSortFunctionAsEnum()

Specifies a sorting function:

• Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending.
• Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• Date: Sorts the categories by:
  • Default with decreasing year, increasing month, increasing day
  • Reverse with increasing year, decreasing month, decreasing day
• Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values.
• Latitude: Sorts the categories by latitude, using the average of points.
• Longitude: Sorts the categories by longitude, using the average of points.
• Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.

setMinDocsPerCategory

public void setMinDocsPerCategory(int minDocsPerCategory)

Minimum number of docs in a category for it to be included in the Refinements panel.

getMinDocsPerCategory

public int getMinDocsPerCategory()

Minimum number of docs in a category for it to be included in the Refinements panel.

withMinDocsPerCategory

public FacetView withMinDocsPerCategory(int minDocsPerCategory)

withMinDocsPerCategory

public FacetView withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

setMaxCategories

public void setMaxCategories(int maxCategories)

Maximum number of categories to display in the facet.
0 means all categories will be displayed.

getMaxCategories

public int getMaxCategories()

Maximum number of categories to display in the facet.
0 means all categories will be displayed.

withMaxCategories

public FacetView withMaxCategories(int maxCategories)

withMaxCategories

public FacetView withMaxCategories(java.lang.Integer maxCategories)

setMaxCategoriesPerLevel

public void setMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Maximum number of facet values in each level of the categories hierarchy.
0 means that all values are selected.
The sortFunction is used to select the "best" facet values for each level.

getMaxCategoriesPerLevel

public int getMaxCategoriesPerLevel()

Maximum number of facet values in each level of the categories hierarchy.
0 means that all values are selected.
The sortFunction is used to select the "best" facet values for each level.

withMaxCategoriesPerLevel

public FacetView withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

withMaxCategoriesPerLevel

public FacetView withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

setSortFunction

public void setSortFunction(java.lang.String sortFunction)

Specifies a sorting function:

• Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending.
• Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• Date: Sorts the categories by:
  • Default with decreasing year, increasing month, increasing day
  • Reverse with increasing year, decreasing month, decreasing day
• Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values.
• Latitude: Sorts the categories by latitude, using the average of points.
• Longitude: Sorts the categories by longitude, using the average of points.
• Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.

getSortFunction

public java.lang.String getSortFunction()

Specifies a sorting function:

• Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending.
• Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• Date: Sorts the categories by:
  • Default with decreasing year, increasing month, increasing day
  • Reverse with increasing year, decreasing month, decreasing day
• Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values.
• Latitude: Sorts the categories by latitude, using the average of points.
• Longitude: Sorts the categories by longitude, using the average of points.
• Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.

withSortFunction

public FacetView withSortFunction(java.lang.String sortFunction)

setSortAggregationFunction

public void setSortAggregationFunction(java.lang.String sortAggregationFunction)

Aggregation function used to sort by aggregation values.

getSortAggregationFunction

public java.lang.String getSortAggregationFunction()

Aggregation function used to sort by aggregation values.

withSortAggregationFunction

public FacetView withSortAggregationFunction(java.lang.String sortAggregationFunction)

setExplicitSortOrderValues

public void setExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).

getExplicitSortOrderValues

public java.lang.String getExplicitSortOrderValues()

Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).

withExplicitSortOrderValues

public FacetView withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

setReverse

public void setReverse(boolean reverse)

Reverse sorting order.

isReverse

public boolean isReverse()

Reverse sorting order.

withReverse

public FacetView withReverse(boolean reverse)

withReverse

public FacetView withReverse(java.lang.Boolean reverse)

setAggregateScores

@Deprecated
public void setAggregateScores(boolean aggregateScores)

Deprecated.

If selected, the category score will be the sum of the scores of all its hits.

isAggregateScores

@Deprecated
public boolean isAggregateScores()

Deprecated.

If selected, the category score will be the sum of the scores of all its hits.

withAggregateScores

@Deprecated
public FacetView withAggregateScores(boolean aggregateScores)

Deprecated.

withAggregateScores

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

Deprecated.

makeCopy

public FacetView makeCopy()

readFrom

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

Read this FacetView 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FacetView.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FacetView.

Overrides:

toString in class java.lang.Object

check

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

Checks this FacetView.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException