com.exalead.search.v30

Class ExplicitRangesNumericalFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.NumericalFacet

com.exalead.search.v30.ExplicitRangesNumericalFacet

All Implemented Interfaces:

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

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

Facet on a numerical expression

See Also:

Serialized Form

Nested Class Summary

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

NumericalFacet.Transformer<T>, 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
java.util.List<Range>	range

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

DEFAULT_DEFAULT_PRECISION, DEFAULT_LSB, DEFAULT_MAX_VALUES, DEFAULT_MSB, defaultPrecision, expr, lsb, max, maxValues, min, 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
ExplicitRangesNumericalFacet()
ExplicitRangesNumericalFacet(ExplicitRangesNumericalFacet o) Copy constructor
ExplicitRangesNumericalFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr)
ExplicitRangesNumericalFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr, java.lang.Double min, java.lang.Double max, int lsb, int msb)

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)
<T> T	accept(NumericalFacet.Transformer<T> transformer, T[] t)
void	accept(NumericalFacet.Visitor visitor)
<T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this ExplicitRangesNumericalFacet.
static ExplicitRangesNumericalFacet	fromString(java.lang.String s) String representation of this ExplicitRangesNumericalFacet.
java.util.List<Range>	getRange()
ExplicitRangesNumericalFacet	makeCopy() Creates and returns a deep copy of this ExplicitRangesNumericalFacet.
static ExplicitRangesNumericalFacet	readFrom(java.io.InputStream is) Read this ExplicitRangesNumericalFacet from an XML fragment.
java.lang.String	toString() String representation of this ExplicitRangesNumericalFacet.
ExplicitRangesNumericalFacet	withAdditionalFacetView(AdditionalFacetView... __values)
ExplicitRangesNumericalFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
ExplicitRangesNumericalFacet	withAggregateScores(boolean aggregateScores) Deprecated.
ExplicitRangesNumericalFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
ExplicitRangesNumericalFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
ExplicitRangesNumericalFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
ExplicitRangesNumericalFacet	withDataModelClass(java.lang.String dataModelClass)
ExplicitRangesNumericalFacet	withDataModelProperty(java.lang.String dataModelProperty)
ExplicitRangesNumericalFacet	withDataModelState(java.lang.String dataModelState)
ExplicitRangesNumericalFacet	withDefaultPrecision(int defaultPrecision)
ExplicitRangesNumericalFacet	withDefaultPrecision(java.lang.Integer defaultPrecision)
ExplicitRangesNumericalFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
ExplicitRangesNumericalFacet	withExpr(java.lang.String expr)
ExplicitRangesNumericalFacet	withFromDataModel(Facet fromDataModel)
ExplicitRangesNumericalFacet	withId(java.lang.String id)
ExplicitRangesNumericalFacet	withImplementation(java.lang.String implementation)
ExplicitRangesNumericalFacet	withIndex(int index)
ExplicitRangesNumericalFacet	withIndex(java.lang.Integer index)
ExplicitRangesNumericalFacet	withInHits(boolean inHits)
ExplicitRangesNumericalFacet	withInHits(java.lang.Boolean inHits)
ExplicitRangesNumericalFacet	withInNavigation(boolean inNavigation)
ExplicitRangesNumericalFacet	withInNavigation(java.lang.Boolean inNavigation)
ExplicitRangesNumericalFacet	withLsb(int lsb)
ExplicitRangesNumericalFacet	withLsb(java.lang.Integer lsb)
ExplicitRangesNumericalFacet	withMax(double max)
ExplicitRangesNumericalFacet	withMax(java.lang.Double max)
ExplicitRangesNumericalFacet	withMaxCategories(int maxCategories)
ExplicitRangesNumericalFacet	withMaxCategories(java.lang.Integer maxCategories)
ExplicitRangesNumericalFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
ExplicitRangesNumericalFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
ExplicitRangesNumericalFacet	withMaxSliceCategories(int maxSliceCategories)
ExplicitRangesNumericalFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
ExplicitRangesNumericalFacet	withMaxValues(int maxValues)
ExplicitRangesNumericalFacet	withMaxValues(java.lang.Integer maxValues)
ExplicitRangesNumericalFacet	withMin(double min)
ExplicitRangesNumericalFacet	withMin(java.lang.Double min)
ExplicitRangesNumericalFacet	withMinDocsPerCategory(int minDocsPerCategory)
ExplicitRangesNumericalFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
ExplicitRangesNumericalFacet	withMsb(int msb)
ExplicitRangesNumericalFacet	withMsb(java.lang.Integer msb)
ExplicitRangesNumericalFacet	withRange(java.util.Collection<Range> __values)
ExplicitRangesNumericalFacet	withRange(Range... __values)
ExplicitRangesNumericalFacet	withRefinementPolicy(java.lang.String refinementPolicy)
ExplicitRangesNumericalFacet	withReverse(boolean reverse)
ExplicitRangesNumericalFacet	withReverse(java.lang.Boolean reverse)
ExplicitRangesNumericalFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
ExplicitRangesNumericalFacet	withSortFunction(java.lang.String sortFunction)
ExplicitRangesNumericalFacet	withType(java.lang.String type)
ExplicitRangesNumericalFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this ExplicitRangesNumericalFacet as an XML fragment

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

getDefaultPrecision, getExpr, getLsb, getMax, getMaxValues, getMin, getMsb, setDefaultPrecision, setExpr, setLsb, setMax, setMax, setMaxValues, setMin, setMin, setMsb

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

getVirtualRoot, setVirtualRoot

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

range

public java.util.List<Range> range

Constructor Detail

ExplicitRangesNumericalFacet

public ExplicitRangesNumericalFacet()

ExplicitRangesNumericalFacet

public ExplicitRangesNumericalFacet(java.lang.String id,
                                    java.lang.String virtualRoot,
                                    java.lang.String expr,
                                    java.lang.Double min,
                                    java.lang.Double max,
                                    int lsb,
                                    int msb)

ExplicitRangesNumericalFacet

public ExplicitRangesNumericalFacet(java.lang.String id,
                                    java.lang.String virtualRoot,
                                    java.lang.String expr)

ExplicitRangesNumericalFacet

public ExplicitRangesNumericalFacet(ExplicitRangesNumericalFacet o)

Copy constructor

Method Detail

withExpr

public ExplicitRangesNumericalFacet withExpr(java.lang.String expr)

Overrides:

withExpr in class NumericalFacet

withMin

public ExplicitRangesNumericalFacet withMin(java.lang.Double min)

Overrides:

withMin in class NumericalFacet

withMin

public ExplicitRangesNumericalFacet withMin(double min)

Overrides:

withMin in class NumericalFacet

withMax

public ExplicitRangesNumericalFacet withMax(java.lang.Double max)

Overrides:

withMax in class NumericalFacet

withMax

public ExplicitRangesNumericalFacet withMax(double max)

Overrides:

withMax in class NumericalFacet

withLsb

public ExplicitRangesNumericalFacet withLsb(int lsb)

Overrides:

withLsb in class NumericalFacet

withLsb

public ExplicitRangesNumericalFacet withLsb(java.lang.Integer lsb)

Overrides:

withLsb in class NumericalFacet

withMsb

public ExplicitRangesNumericalFacet withMsb(int msb)

Overrides:

withMsb in class NumericalFacet

withMsb

public ExplicitRangesNumericalFacet withMsb(java.lang.Integer msb)

Overrides:

withMsb in class NumericalFacet

withMaxValues

public ExplicitRangesNumericalFacet withMaxValues(int maxValues)

Overrides:

withMaxValues in class NumericalFacet

withMaxValues

public ExplicitRangesNumericalFacet withMaxValues(java.lang.Integer maxValues)

Overrides:

withMaxValues in class NumericalFacet

withDefaultPrecision

public ExplicitRangesNumericalFacet withDefaultPrecision(int defaultPrecision)

Overrides:

withDefaultPrecision in class NumericalFacet

withDefaultPrecision

public ExplicitRangesNumericalFacet withDefaultPrecision(java.lang.Integer defaultPrecision)

Overrides:

withDefaultPrecision in class NumericalFacet

withVirtualRoot

public ExplicitRangesNumericalFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class NumericalFacet

withId

public ExplicitRangesNumericalFacet withId(java.lang.String id)

Overrides:

withId in class NumericalFacet

withType

public ExplicitRangesNumericalFacet withType(java.lang.String type)

Overrides:

withType in class NumericalFacet

withIndex

public ExplicitRangesNumericalFacet withIndex(int index)

Overrides:

withIndex in class NumericalFacet

withIndex

public ExplicitRangesNumericalFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class NumericalFacet

withRefinementPolicy

public ExplicitRangesNumericalFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class NumericalFacet

withImplementation

public ExplicitRangesNumericalFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class NumericalFacet

withDataModelState

public ExplicitRangesNumericalFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class NumericalFacet

withFromDataModel

public ExplicitRangesNumericalFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class NumericalFacet

withDataModelClass

public ExplicitRangesNumericalFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class NumericalFacet

withDataModelProperty

public ExplicitRangesNumericalFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class NumericalFacet

withInNavigation

public ExplicitRangesNumericalFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class NumericalFacet

withInNavigation

public ExplicitRangesNumericalFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class NumericalFacet

withInHits

public ExplicitRangesNumericalFacet withInHits(boolean inHits)

Overrides:

withInHits in class NumericalFacet

withInHits

public ExplicitRangesNumericalFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class NumericalFacet

withAggregationFunction

public ExplicitRangesNumericalFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class NumericalFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class NumericalFacet

withAdditionalFacetView

public ExplicitRangesNumericalFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class NumericalFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class NumericalFacet

withMaxSliceCategories

public ExplicitRangesNumericalFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class NumericalFacet

withMaxSliceCategories

public ExplicitRangesNumericalFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class NumericalFacet

withMinDocsPerCategory

public ExplicitRangesNumericalFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class NumericalFacet

withMinDocsPerCategory

public ExplicitRangesNumericalFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class NumericalFacet

withMaxCategories

public ExplicitRangesNumericalFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class NumericalFacet

withMaxCategories

public ExplicitRangesNumericalFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class NumericalFacet

withMaxCategoriesPerLevel

public ExplicitRangesNumericalFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class NumericalFacet

withMaxCategoriesPerLevel

public ExplicitRangesNumericalFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class NumericalFacet

withSortFunction

public ExplicitRangesNumericalFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class NumericalFacet

withSortAggregationFunction

public ExplicitRangesNumericalFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class NumericalFacet

withExplicitSortOrderValues

public ExplicitRangesNumericalFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class NumericalFacet

withReverse

public ExplicitRangesNumericalFacet withReverse(boolean reverse)

Overrides:

withReverse in class NumericalFacet

withReverse

public ExplicitRangesNumericalFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class NumericalFacet

withAggregateScores

@Deprecated
public ExplicitRangesNumericalFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class NumericalFacet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class NumericalFacet

getRange

public java.util.List<Range> getRange()

withRange

public ExplicitRangesNumericalFacet withRange(Range... __values)

withRange

public ExplicitRangesNumericalFacet withRange(java.util.Collection<Range> __values)

makeCopy

public ExplicitRangesNumericalFacet makeCopy()

Creates and returns a deep copy of this ExplicitRangesNumericalFacet.

Overrides:

makeCopy in class NumericalFacet

readFrom

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

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

Overrides:

writeTo in class NumericalFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ExplicitRangesNumericalFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ExplicitRangesNumericalFacet.

Overrides:

toString in class NumericalFacet

check

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

Checks this ExplicitRangesNumericalFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class NumericalFacet

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class NumericalFacet

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class VirtualFacet

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(NumericalFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class NumericalFacet

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class VirtualFacet

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