com.exalead.search.v30

Class NumericalFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.NumericalFacet

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicRangesNumericalFacet, ExplicitRangesNumericalFacet, FixedRangesNumericalFacet

public abstract class NumericalFacet
extends VirtualFacet
implements com.exalead.util.Checkable, java.io.Serializable

Facet on a numerical expression

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NumericalFacet.Transformer<T>
static interface	NumericalFacet.Visitor

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

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type

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_DEFAULT_PRECISION
static int	DEFAULT_LSB
static int	DEFAULT_MAX_VALUES
static int	DEFAULT_MSB
int	defaultPrecision
java.lang.String	expr
int	lsb
java.lang.Double	max
int	maxValues
java.lang.Double	min
int	msb

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

virtualRoot

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(NumericalFacet.Transformer<T> transformer, T[] t)
abstract void	accept(NumericalFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this NumericalFacet.
static NumericalFacet	fromString(java.lang.String s) String representation of this NumericalFacet.
int	getDefaultPrecision() Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g.
java.lang.String	getExpr() Virtual field expression for this facet.
int	getLsb() Least significant bit of the numerical value to use.
double	getMax() Excludes values above this threshold from the facet.
int	getMaxValues() Maximum number of displayed values.
double	getMin() Excludes values below this threshold from the facet.
int	getMsb() Most significant bit of the numerical value to use.
NumericalFacet	makeCopy()
static NumericalFacet	readFrom(java.io.InputStream is) Read this NumericalFacet from an XML fragment.
void	setDefaultPrecision(int defaultPrecision) Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g.
void	setExpr(java.lang.String expr) Virtual field expression for this facet.
void	setLsb(int lsb) Least significant bit of the numerical value to use.
void	setMax(double max) Excludes values above this threshold from the facet.
void	setMax(java.lang.Double max) Excludes values above this threshold from the facet.
void	setMaxValues(int maxValues) Maximum number of displayed values.
void	setMin(double min) Excludes values below this threshold from the facet.
void	setMin(java.lang.Double min) Excludes values below this threshold from the facet.
void	setMsb(int msb) Most significant bit of the numerical value to use.
java.lang.String	toString() String representation of this NumericalFacet.
NumericalFacet	withAdditionalFacetView(AdditionalFacetView... __values)
NumericalFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
NumericalFacet	withAggregateScores(boolean aggregateScores) Deprecated.
NumericalFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
NumericalFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
NumericalFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
NumericalFacet	withDataModelClass(java.lang.String dataModelClass)
NumericalFacet	withDataModelProperty(java.lang.String dataModelProperty)
NumericalFacet	withDataModelState(java.lang.String dataModelState)
NumericalFacet	withDefaultPrecision(int defaultPrecision)
NumericalFacet	withDefaultPrecision(java.lang.Integer defaultPrecision)
NumericalFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
NumericalFacet	withExpr(java.lang.String expr)
NumericalFacet	withFromDataModel(Facet fromDataModel)
NumericalFacet	withId(java.lang.String id)
NumericalFacet	withImplementation(java.lang.String implementation)
NumericalFacet	withIndex(int index)
NumericalFacet	withIndex(java.lang.Integer index)
NumericalFacet	withInHits(boolean inHits)
NumericalFacet	withInHits(java.lang.Boolean inHits)
NumericalFacet	withInNavigation(boolean inNavigation)
NumericalFacet	withInNavigation(java.lang.Boolean inNavigation)
NumericalFacet	withLsb(int lsb)
NumericalFacet	withLsb(java.lang.Integer lsb)
NumericalFacet	withMax(double max)
NumericalFacet	withMax(java.lang.Double max)
NumericalFacet	withMaxCategories(int maxCategories)
NumericalFacet	withMaxCategories(java.lang.Integer maxCategories)
NumericalFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
NumericalFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
NumericalFacet	withMaxSliceCategories(int maxSliceCategories)
NumericalFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
NumericalFacet	withMaxValues(int maxValues)
NumericalFacet	withMaxValues(java.lang.Integer maxValues)
NumericalFacet	withMin(double min)
NumericalFacet	withMin(java.lang.Double min)
NumericalFacet	withMinDocsPerCategory(int minDocsPerCategory)
NumericalFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
NumericalFacet	withMsb(int msb)
NumericalFacet	withMsb(java.lang.Integer msb)
NumericalFacet	withRefinementPolicy(java.lang.String refinementPolicy)
NumericalFacet	withReverse(boolean reverse)
NumericalFacet	withReverse(java.lang.Boolean reverse)
NumericalFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
NumericalFacet	withSortFunction(java.lang.String sortFunction)
NumericalFacet	withType(java.lang.String type)
NumericalFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os)

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

accept, accept, getVirtualRoot, setVirtualRoot

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

accept, accept, 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

accept, accept, 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

expr

public java.lang.String expr

min

public java.lang.Double min

max

public java.lang.Double max

lsb

public int lsb

DEFAULT_LSB

public static final int DEFAULT_LSB

See Also:

Constant Field Values

msb

public int msb

DEFAULT_MSB

public static final int DEFAULT_MSB

See Also:

Constant Field Values

maxValues

public int maxValues

DEFAULT_MAX_VALUES

public static final int DEFAULT_MAX_VALUES

See Also:

Constant Field Values

defaultPrecision

public int defaultPrecision

DEFAULT_DEFAULT_PRECISION

public static final int DEFAULT_DEFAULT_PRECISION

See Also:

Constant Field Values

Constructor Detail

NumericalFacet

public NumericalFacet()

NumericalFacet

public NumericalFacet(NumericalFacet o)

Copy constructor

Method Detail

withVirtualRoot

public NumericalFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public NumericalFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public NumericalFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public NumericalFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public NumericalFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public NumericalFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public NumericalFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public NumericalFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public NumericalFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public NumericalFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public NumericalFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public NumericalFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public NumericalFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public NumericalFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public NumericalFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public NumericalFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public NumericalFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public NumericalFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public NumericalFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public NumericalFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public NumericalFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public NumericalFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public NumericalFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public NumericalFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public NumericalFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public NumericalFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public NumericalFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public NumericalFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public NumericalFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public NumericalFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public NumericalFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setExpr

public void setExpr(java.lang.String expr)

Virtual field expression for this facet.

getExpr

public java.lang.String getExpr()

Virtual field expression for this facet.

withExpr

public NumericalFacet withExpr(java.lang.String expr)

setMin

public void setMin(double min)

Excludes values below this threshold from the facet.

setMin

public void setMin(java.lang.Double min)

Excludes values below this threshold from the facet.

getMin

public double getMin()

Excludes values below this threshold from the facet.

withMin

public NumericalFacet withMin(java.lang.Double min)

withMin

public NumericalFacet withMin(double min)

setMax

public void setMax(double max)

Excludes values above this threshold from the facet.

setMax

public void setMax(java.lang.Double max)

Excludes values above this threshold from the facet.

getMax

public double getMax()

Excludes values above this threshold from the facet.

withMax

public NumericalFacet withMax(java.lang.Double max)

withMax

public NumericalFacet withMax(double max)

setLsb

public void setLsb(int lsb)

Least significant bit of the numerical value to use.
Only used for integral types.

getLsb

public int getLsb()

Least significant bit of the numerical value to use.
Only used for integral types.

withLsb

public NumericalFacet withLsb(int lsb)

withLsb

public NumericalFacet withLsb(java.lang.Integer lsb)

setMsb

public void setMsb(int msb)

Most significant bit of the numerical value to use.
Only used for integral types.

getMsb

public int getMsb()

Most significant bit of the numerical value to use.
Only used for integral types.

withMsb

public NumericalFacet withMsb(int msb)

withMsb

public NumericalFacet withMsb(java.lang.Integer msb)

setMaxValues

public void setMaxValues(int maxValues)

Maximum number of displayed values.

getMaxValues

public int getMaxValues()

Maximum number of displayed values.

withMaxValues

public NumericalFacet withMaxValues(int maxValues)

withMaxValues

public NumericalFacet withMaxValues(java.lang.Integer maxValues)

setDefaultPrecision

public void setDefaultPrecision(int defaultPrecision)

Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g. "#random()").
For example, if defaultPrecision is 2, 0.011 and 0.012 will be considered similar, and categories will be displayed with two significant digits (e.g. [0.00;0.99])

getDefaultPrecision

public int getDefaultPrecision()

Default precision, in number of trailing digits, for float-typed expressions with double precision (e.g. "#random()").
For example, if defaultPrecision is 2, 0.011 and 0.012 will be considered similar, and categories will be displayed with two significant digits (e.g. [0.00;0.99])

withDefaultPrecision

public NumericalFacet withDefaultPrecision(int defaultPrecision)

withDefaultPrecision

public NumericalFacet withDefaultPrecision(java.lang.Integer defaultPrecision)

makeCopy

public NumericalFacet makeCopy()

Overrides:

makeCopy in class VirtualFacet

readFrom

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

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

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NumericalFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NumericalFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this NumericalFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException