com.exalead.search.v30

Class MultiFacetDimension

java.lang.Object

com.exalead.search.v30.MultiFacetDimension

All Implemented Interfaces:

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

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

Determines the features of one dimension for a MultiDimensionFacet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiFacetDimension.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CATEGORIES
static boolean	DEFAULT_REVERSE
static java.lang.String	DEFAULT_SORT_FUNCTION
java.lang.String	explicitSortOrderValues
java.lang.String	id
int	maxCategories
boolean	reverse
java.lang.String	sortAggregationFunction
java.lang.String	sortFunction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this MultiFacetDimension.
static MultiFacetDimension	fromString(java.lang.String s) String representation of this MultiFacetDimension.
java.lang.String	getExplicitSortOrderValues() The ordered list of values used to sort, comma-separated (use the backslash to escape a comma).
java.lang.String	getId() The existing 1d facet id to use for this dimension.
int	getMaxCategories() The maximum number of categories after sorting in this dimension.
java.lang.String	getSortAggregationFunction() The aggregation function used to sort by aggregation values.
java.lang.String	getSortFunction() The sort function on this dimension (does not apply to other dimensions).
MultiFacetDimension.SortFunction	getSortFunctionAsEnum() The sort function on this dimension (does not apply to other dimensions).
static boolean	isA(java.lang.String str, MultiFacetDimension.SortFunction item)
static boolean	isOneOf(java.lang.String str, MultiFacetDimension.SortFunction... items)
boolean	isReverse() Reverses the sort (see 'reverse' in Facet).
MultiFacetDimension	makeCopy() Creates and returns a deep copy of this MultiFacetDimension.
static MultiFacetDimension	readFrom(java.io.InputStream is) Read this MultiFacetDimension from an XML fragment.
void	setExplicitSortOrderValues(java.lang.String explicitSortOrderValues) The ordered list of values used to sort, comma-separated (use the backslash to escape a comma).
void	setId(java.lang.String id) The existing 1d facet id to use for this dimension.
void	setMaxCategories(int maxCategories) The maximum number of categories after sorting in this dimension.
void	setReverse(boolean reverse) Reverses the sort (see 'reverse' in Facet).
void	setSortAggregationFunction(java.lang.String sortAggregationFunction) The aggregation function used to sort by aggregation values.
void	setSortFunction(MultiFacetDimension.SortFunction item) The sort function on this dimension (does not apply to other dimensions).
void	setSortFunction(java.lang.String sortFunction) The sort function on this dimension (does not apply to other dimensions).
java.lang.String	toString() String representation of this MultiFacetDimension.
MultiFacetDimension	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
MultiFacetDimension	withId(java.lang.String id)
MultiFacetDimension	withMaxCategories(int maxCategories)
MultiFacetDimension	withMaxCategories(java.lang.Integer maxCategories)
MultiFacetDimension	withReverse(boolean reverse)
MultiFacetDimension	withReverse(java.lang.Boolean reverse)
MultiFacetDimension	withSortAggregationFunction(java.lang.String sortAggregationFunction)
MultiFacetDimension	withSortFunction(java.lang.String sortFunction)
void	writeTo(java.io.OutputStream os) Write this MultiFacetDimension as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

sortFunction

public java.lang.String sortFunction

DEFAULT_SORT_FUNCTION

public static final java.lang.String DEFAULT_SORT_FUNCTION

See Also:

Constant Field Values

reverse

public boolean reverse

DEFAULT_REVERSE

public static final boolean DEFAULT_REVERSE

See Also:

Constant Field Values

sortAggregationFunction

public java.lang.String sortAggregationFunction

explicitSortOrderValues

public java.lang.String explicitSortOrderValues

maxCategories

public int maxCategories

DEFAULT_MAX_CATEGORIES

public static final int DEFAULT_MAX_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

MultiFacetDimension

public MultiFacetDimension()

MultiFacetDimension

public MultiFacetDimension(MultiFacetDimension o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setSortFunction

public void setSortFunction(MultiFacetDimension.SortFunction item)

The sort function on this dimension (does not apply to other dimensions).

getSortFunctionAsEnum

public MultiFacetDimension.SortFunction getSortFunctionAsEnum()

The sort function on this dimension (does not apply to other dimensions).

setId

public void setId(java.lang.String id)

The existing 1d facet id to use for this dimension.

getId

public java.lang.String getId()

The existing 1d facet id to use for this dimension.

withId

public MultiFacetDimension withId(java.lang.String id)

setSortFunction

public void setSortFunction(java.lang.String sortFunction)

The sort function on this dimension (does not apply to other dimensions).

getSortFunction

public java.lang.String getSortFunction()

The sort function on this dimension (does not apply to other dimensions).

withSortFunction

public MultiFacetDimension withSortFunction(java.lang.String sortFunction)

setReverse

public void setReverse(boolean reverse)

Reverses the sort (see 'reverse' in Facet).

isReverse

public boolean isReverse()

Reverses the sort (see 'reverse' in Facet).

withReverse

public MultiFacetDimension withReverse(boolean reverse)

withReverse

public MultiFacetDimension withReverse(java.lang.Boolean reverse)

setSortAggregationFunction

public void setSortAggregationFunction(java.lang.String sortAggregationFunction)

The aggregation function used to sort by aggregation values.

getSortAggregationFunction

public java.lang.String getSortAggregationFunction()

The aggregation function used to sort by aggregation values.

withSortAggregationFunction

public MultiFacetDimension withSortAggregationFunction(java.lang.String sortAggregationFunction)

setExplicitSortOrderValues

public void setExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

The ordered list of values used to sort, comma-separated (use the backslash to escape a comma).

getExplicitSortOrderValues

public java.lang.String getExplicitSortOrderValues()

The ordered list of values used to sort, comma-separated (use the backslash to escape a comma).

withExplicitSortOrderValues

public MultiFacetDimension withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

setMaxCategories

public void setMaxCategories(int maxCategories)

The maximum number of categories after sorting in this dimension.

getMaxCategories

public int getMaxCategories()

The maximum number of categories after sorting in this dimension.

withMaxCategories

public MultiFacetDimension withMaxCategories(int maxCategories)

withMaxCategories

public MultiFacetDimension withMaxCategories(java.lang.Integer maxCategories)

makeCopy

public MultiFacetDimension makeCopy()

Creates and returns a deep copy of this MultiFacetDimension.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MultiFacetDimension.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MultiFacetDimension.

Overrides:

toString in class java.lang.Object

check

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

Checks this MultiFacetDimension.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException