public class DynamicRangesNumericalFacet extends NumericalFacet implements com.exalead.util.Checkable, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
DynamicRangesNumericalFacet.Policy |
NumericalFacet.Transformer<T>, NumericalFacet.Visitor
Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type
FacetView.SortFunction
Modifier and Type | Field and Description |
---|---|
boolean |
adjustRanges
Deprecated.
|
static boolean |
DEFAULT_ADJUST_RANGES |
static boolean |
DEFAULT_EXCLUSIVE_RIGHT_BRACKET |
static double |
DEFAULT_MINIMUM_RANGE_SIZE |
static boolean |
DEFAULT_MORE_ACCURATE |
static int |
DEFAULT_NB_RANGES |
static java.lang.String |
DEFAULT_POLICY |
static java.lang.String |
DEFAULT_RANGE_TITLE_FORMAT |
boolean |
exclusiveRightBracket |
double |
minimumRangeSize |
boolean |
moreAccurate
Deprecated.
|
int |
nbRanges |
java.lang.String |
policy |
java.lang.String |
rangeTitleFormat |
DEFAULT_DEFAULT_PRECISION, DEFAULT_LSB, DEFAULT_MAX_VALUES, DEFAULT_MSB, defaultPrecision, expr, lsb, max, maxValues, min, msb
virtualRoot
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
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 and Description |
---|
DynamicRangesNumericalFacet() |
DynamicRangesNumericalFacet(DynamicRangesNumericalFacet o)
Copy constructor
|
DynamicRangesNumericalFacet(java.lang.String id,
java.lang.String virtualRoot,
java.lang.String expr,
int nbRanges) |
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 DynamicRangesNumericalFacet.
|
static DynamicRangesNumericalFacet |
fromString(java.lang.String s)
String representation of this DynamicRangesNumericalFacet.
|
double |
getMinimumRangeSize()
Size of each bin used to compute cardinality.
|
int |
getNbRanges()
The maximal number of ranges to output.
|
java.lang.String |
getPolicy()
The policy to generate the ranges
Value can be null or one of
linear
geometrical
auto
|
DynamicRangesNumericalFacet.Policy |
getPolicyAsEnum()
The policy to generate the ranges
Value can be null or one of
linear
geometrical
auto
|
java.lang.String |
getRangeTitleFormat()
Format for the generated range titles.
The first dollar sign will be replaced with the range's lower bound, and the second dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
static boolean |
isA(java.lang.String str,
DynamicRangesNumericalFacet.Policy item) |
boolean |
isAdjustRanges()
Deprecated.
|
boolean |
isExclusiveRightBracket()
If exclusiveRightBracket is set to true then the facet will be represented by an open range [a,b[, that means it will not contain hits with value equal to b.
otherwise the facet will be in inclusive mode [a,b]. |
boolean |
isMoreAccurate()
Deprecated.
|
static boolean |
isOneOf(java.lang.String str,
DynamicRangesNumericalFacet.Policy... items) |
DynamicRangesNumericalFacet |
makeCopy()
Creates and returns a deep copy of this DynamicRangesNumericalFacet.
|
static DynamicRangesNumericalFacet |
readFrom(java.io.InputStream is)
Read this DynamicRangesNumericalFacet from an XML fragment.
|
void |
setAdjustRanges(boolean adjustRanges)
Deprecated.
|
void |
setExclusiveRightBracket(boolean exclusiveRightBracket)
If exclusiveRightBracket is set to true then the facet will be represented by an open range [a,b[, that means it will not contain hits with value equal to b.
otherwise the facet will be in inclusive mode [a,b]. |
void |
setMinimumRangeSize(double minimumRangeSize)
Size of each bin used to compute cardinality.
|
void |
setMoreAccurate(boolean moreAccurate)
Deprecated.
|
void |
setNbRanges(int nbRanges)
The maximal number of ranges to output.
|
void |
setPolicy(DynamicRangesNumericalFacet.Policy item)
The policy to generate the ranges
Value can be null or one of
linear
geometrical
auto
|
void |
setPolicy(java.lang.String policy)
The policy to generate the ranges
Value can be null or one of
linear
geometrical
auto
|
void |
setRangeTitleFormat(java.lang.String rangeTitleFormat)
Format for the generated range titles.
The first dollar sign will be replaced with the range's lower bound, and the second dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
java.lang.String |
toString()
String representation of this DynamicRangesNumericalFacet.
|
DynamicRangesNumericalFacet |
withAdditionalFacetView(AdditionalFacetView... __values) |
DynamicRangesNumericalFacet |
withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values) |
DynamicRangesNumericalFacet |
withAdjustRanges(boolean adjustRanges)
Deprecated.
|
DynamicRangesNumericalFacet |
withAdjustRanges(java.lang.Boolean adjustRanges)
Deprecated.
|
DynamicRangesNumericalFacet |
withAggregateScores(boolean aggregateScores)
Deprecated.
|
DynamicRangesNumericalFacet |
withAggregateScores(java.lang.Boolean aggregateScores)
Deprecated.
|
DynamicRangesNumericalFacet |
withAggregationFunction(AggregationFunction... __values)
A numerical computation to perform on hits matching each value of the facet.
|
DynamicRangesNumericalFacet |
withAggregationFunction(java.util.Collection<AggregationFunction> __values) |
DynamicRangesNumericalFacet |
withDataModelClass(java.lang.String dataModelClass) |
DynamicRangesNumericalFacet |
withDataModelProperty(java.lang.String dataModelProperty) |
DynamicRangesNumericalFacet |
withDataModelState(java.lang.String dataModelState) |
DynamicRangesNumericalFacet |
withDefaultPrecision(int defaultPrecision) |
DynamicRangesNumericalFacet |
withDefaultPrecision(java.lang.Integer defaultPrecision) |
DynamicRangesNumericalFacet |
withExclusiveRightBracket(boolean exclusiveRightBracket) |
DynamicRangesNumericalFacet |
withExclusiveRightBracket(java.lang.Boolean exclusiveRightBracket) |
DynamicRangesNumericalFacet |
withExplicitSortOrderValues(java.lang.String explicitSortOrderValues) |
DynamicRangesNumericalFacet |
withExpr(java.lang.String expr) |
DynamicRangesNumericalFacet |
withFromDataModel(Facet fromDataModel) |
DynamicRangesNumericalFacet |
withId(java.lang.String id) |
DynamicRangesNumericalFacet |
withImplementation(java.lang.String implementation) |
DynamicRangesNumericalFacet |
withIndex(int index) |
DynamicRangesNumericalFacet |
withIndex(java.lang.Integer index) |
DynamicRangesNumericalFacet |
withInHits(boolean inHits) |
DynamicRangesNumericalFacet |
withInHits(java.lang.Boolean inHits) |
DynamicRangesNumericalFacet |
withInNavigation(boolean inNavigation) |
DynamicRangesNumericalFacet |
withInNavigation(java.lang.Boolean inNavigation) |
DynamicRangesNumericalFacet |
withLsb(int lsb) |
DynamicRangesNumericalFacet |
withLsb(java.lang.Integer lsb) |
DynamicRangesNumericalFacet |
withMax(double max) |
DynamicRangesNumericalFacet |
withMax(java.lang.Double max) |
DynamicRangesNumericalFacet |
withMaxCategories(int maxCategories) |
DynamicRangesNumericalFacet |
withMaxCategories(java.lang.Integer maxCategories) |
DynamicRangesNumericalFacet |
withMaxCategoriesPerLevel(int maxCategoriesPerLevel) |
DynamicRangesNumericalFacet |
withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel) |
DynamicRangesNumericalFacet |
withMaxSliceCategories(int maxSliceCategories) |
DynamicRangesNumericalFacet |
withMaxSliceCategories(java.lang.Integer maxSliceCategories) |
DynamicRangesNumericalFacet |
withMaxValues(int maxValues) |
DynamicRangesNumericalFacet |
withMaxValues(java.lang.Integer maxValues) |
DynamicRangesNumericalFacet |
withMin(double min) |
DynamicRangesNumericalFacet |
withMin(java.lang.Double min) |
DynamicRangesNumericalFacet |
withMinDocsPerCategory(int minDocsPerCategory) |
DynamicRangesNumericalFacet |
withMinDocsPerCategory(java.lang.Integer minDocsPerCategory) |
DynamicRangesNumericalFacet |
withMinimumRangeSize(double minimumRangeSize) |
DynamicRangesNumericalFacet |
withMoreAccurate(boolean moreAccurate)
Deprecated.
|
DynamicRangesNumericalFacet |
withMoreAccurate(java.lang.Boolean moreAccurate)
Deprecated.
|
DynamicRangesNumericalFacet |
withMsb(int msb) |
DynamicRangesNumericalFacet |
withMsb(java.lang.Integer msb) |
DynamicRangesNumericalFacet |
withNbRanges(int nbRanges) |
DynamicRangesNumericalFacet |
withNbRanges(java.lang.Integer nbRanges) |
DynamicRangesNumericalFacet |
withPolicy(java.lang.String policy) |
DynamicRangesNumericalFacet |
withRangeTitleFormat(java.lang.String rangeTitleFormat) |
DynamicRangesNumericalFacet |
withRefinementPolicy(java.lang.String refinementPolicy) |
DynamicRangesNumericalFacet |
withReverse(boolean reverse) |
DynamicRangesNumericalFacet |
withReverse(java.lang.Boolean reverse) |
DynamicRangesNumericalFacet |
withSortAggregationFunction(java.lang.String sortAggregationFunction) |
DynamicRangesNumericalFacet |
withSortFunction(java.lang.String sortFunction) |
DynamicRangesNumericalFacet |
withType(java.lang.String type) |
DynamicRangesNumericalFacet |
withVirtualRoot(java.lang.String virtualRoot) |
void |
writeTo(java.io.OutputStream os)
Write this DynamicRangesNumericalFacet as an XML fragment
|
getDefaultPrecision, getExpr, getLsb, getMax, getMaxValues, getMin, getMsb, setDefaultPrecision, setExpr, setLsb, setMax, setMax, setMaxValues, setMin, setMin, setMsb
getVirtualRoot, setVirtualRoot
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
getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction
public double minimumRangeSize
public static final double DEFAULT_MINIMUM_RANGE_SIZE
public int nbRanges
public static final int DEFAULT_NB_RANGES
public java.lang.String policy
public static final java.lang.String DEFAULT_POLICY
@Deprecated public boolean adjustRanges
public static final boolean DEFAULT_ADJUST_RANGES
@Deprecated public boolean moreAccurate
public static final boolean DEFAULT_MORE_ACCURATE
public java.lang.String rangeTitleFormat
public static final java.lang.String DEFAULT_RANGE_TITLE_FORMAT
public boolean exclusiveRightBracket
public static final boolean DEFAULT_EXCLUSIVE_RIGHT_BRACKET
public DynamicRangesNumericalFacet()
public DynamicRangesNumericalFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr, int nbRanges)
public DynamicRangesNumericalFacet(DynamicRangesNumericalFacet o)
public static boolean isA(java.lang.String str, DynamicRangesNumericalFacet.Policy item)
public static boolean isOneOf(java.lang.String str, DynamicRangesNumericalFacet.Policy... items)
public void setPolicy(DynamicRangesNumericalFacet.Policy item)
public DynamicRangesNumericalFacet.Policy getPolicyAsEnum()
public DynamicRangesNumericalFacet withExpr(java.lang.String expr)
withExpr
in class NumericalFacet
public DynamicRangesNumericalFacet withMin(java.lang.Double min)
withMin
in class NumericalFacet
public DynamicRangesNumericalFacet withMin(double min)
withMin
in class NumericalFacet
public DynamicRangesNumericalFacet withMax(java.lang.Double max)
withMax
in class NumericalFacet
public DynamicRangesNumericalFacet withMax(double max)
withMax
in class NumericalFacet
public DynamicRangesNumericalFacet withLsb(int lsb)
withLsb
in class NumericalFacet
public DynamicRangesNumericalFacet withLsb(java.lang.Integer lsb)
withLsb
in class NumericalFacet
public DynamicRangesNumericalFacet withMsb(int msb)
withMsb
in class NumericalFacet
public DynamicRangesNumericalFacet withMsb(java.lang.Integer msb)
withMsb
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxValues(int maxValues)
withMaxValues
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxValues(java.lang.Integer maxValues)
withMaxValues
in class NumericalFacet
public DynamicRangesNumericalFacet withDefaultPrecision(int defaultPrecision)
withDefaultPrecision
in class NumericalFacet
public DynamicRangesNumericalFacet withDefaultPrecision(java.lang.Integer defaultPrecision)
withDefaultPrecision
in class NumericalFacet
public DynamicRangesNumericalFacet withVirtualRoot(java.lang.String virtualRoot)
withVirtualRoot
in class NumericalFacet
public DynamicRangesNumericalFacet withId(java.lang.String id)
withId
in class NumericalFacet
public DynamicRangesNumericalFacet withType(java.lang.String type)
withType
in class NumericalFacet
public DynamicRangesNumericalFacet withIndex(int index)
withIndex
in class NumericalFacet
public DynamicRangesNumericalFacet withIndex(java.lang.Integer index)
withIndex
in class NumericalFacet
public DynamicRangesNumericalFacet withRefinementPolicy(java.lang.String refinementPolicy)
withRefinementPolicy
in class NumericalFacet
public DynamicRangesNumericalFacet withImplementation(java.lang.String implementation)
withImplementation
in class NumericalFacet
public DynamicRangesNumericalFacet withDataModelState(java.lang.String dataModelState)
withDataModelState
in class NumericalFacet
public DynamicRangesNumericalFacet withFromDataModel(Facet fromDataModel)
withFromDataModel
in class NumericalFacet
public DynamicRangesNumericalFacet withDataModelClass(java.lang.String dataModelClass)
withDataModelClass
in class NumericalFacet
public DynamicRangesNumericalFacet withDataModelProperty(java.lang.String dataModelProperty)
withDataModelProperty
in class NumericalFacet
public DynamicRangesNumericalFacet withInNavigation(boolean inNavigation)
withInNavigation
in class NumericalFacet
public DynamicRangesNumericalFacet withInNavigation(java.lang.Boolean inNavigation)
withInNavigation
in class NumericalFacet
public DynamicRangesNumericalFacet withInHits(boolean inHits)
withInHits
in class NumericalFacet
public DynamicRangesNumericalFacet withInHits(java.lang.Boolean inHits)
withInHits
in class NumericalFacet
public DynamicRangesNumericalFacet withAggregationFunction(AggregationFunction... __values)
withAggregationFunction
in class NumericalFacet
public DynamicRangesNumericalFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)
withAggregationFunction
in class NumericalFacet
public DynamicRangesNumericalFacet withAdditionalFacetView(AdditionalFacetView... __values)
withAdditionalFacetView
in class NumericalFacet
public DynamicRangesNumericalFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
withAdditionalFacetView
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxSliceCategories(int maxSliceCategories)
withMaxSliceCategories
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)
withMaxSliceCategories
in class NumericalFacet
public DynamicRangesNumericalFacet withMinDocsPerCategory(int minDocsPerCategory)
withMinDocsPerCategory
in class NumericalFacet
public DynamicRangesNumericalFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
withMinDocsPerCategory
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxCategories(int maxCategories)
withMaxCategories
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxCategories(java.lang.Integer maxCategories)
withMaxCategories
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class NumericalFacet
public DynamicRangesNumericalFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class NumericalFacet
public DynamicRangesNumericalFacet withSortFunction(java.lang.String sortFunction)
withSortFunction
in class NumericalFacet
public DynamicRangesNumericalFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)
withSortAggregationFunction
in class NumericalFacet
public DynamicRangesNumericalFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
withExplicitSortOrderValues
in class NumericalFacet
public DynamicRangesNumericalFacet withReverse(boolean reverse)
withReverse
in class NumericalFacet
public DynamicRangesNumericalFacet withReverse(java.lang.Boolean reverse)
withReverse
in class NumericalFacet
@Deprecated public DynamicRangesNumericalFacet withAggregateScores(boolean aggregateScores)
withAggregateScores
in class NumericalFacet
@Deprecated public DynamicRangesNumericalFacet withAggregateScores(java.lang.Boolean aggregateScores)
withAggregateScores
in class NumericalFacet
public void setMinimumRangeSize(double minimumRangeSize)
public double getMinimumRangeSize()
public DynamicRangesNumericalFacet withMinimumRangeSize(double minimumRangeSize)
public void setNbRanges(int nbRanges)
public int getNbRanges()
public DynamicRangesNumericalFacet withNbRanges(int nbRanges)
public DynamicRangesNumericalFacet withNbRanges(java.lang.Integer nbRanges)
public void setPolicy(java.lang.String policy)
public java.lang.String getPolicy()
public DynamicRangesNumericalFacet withPolicy(java.lang.String policy)
@Deprecated public void setAdjustRanges(boolean adjustRanges)
@Deprecated public boolean isAdjustRanges()
@Deprecated public DynamicRangesNumericalFacet withAdjustRanges(boolean adjustRanges)
@Deprecated public DynamicRangesNumericalFacet withAdjustRanges(java.lang.Boolean adjustRanges)
@Deprecated public void setMoreAccurate(boolean moreAccurate)
@Deprecated public boolean isMoreAccurate()
@Deprecated public DynamicRangesNumericalFacet withMoreAccurate(boolean moreAccurate)
@Deprecated public DynamicRangesNumericalFacet withMoreAccurate(java.lang.Boolean moreAccurate)
public void setRangeTitleFormat(java.lang.String rangeTitleFormat)
public java.lang.String getRangeTitleFormat()
public DynamicRangesNumericalFacet withRangeTitleFormat(java.lang.String rangeTitleFormat)
public void setExclusiveRightBracket(boolean exclusiveRightBracket)
public boolean isExclusiveRightBracket()
public DynamicRangesNumericalFacet withExclusiveRightBracket(boolean exclusiveRightBracket)
public DynamicRangesNumericalFacet withExclusiveRightBracket(java.lang.Boolean exclusiveRightBracket)
public DynamicRangesNumericalFacet makeCopy()
makeCopy
in class NumericalFacet
public static DynamicRangesNumericalFacet readFrom(java.io.InputStream is) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
public void writeTo(java.io.OutputStream os) throws javax.xml.bind.JAXBException, java.io.IOException
writeTo
in class NumericalFacet
javax.xml.bind.JAXBException
java.io.IOException
public static DynamicRangesNumericalFacet fromString(java.lang.String s) throws javax.xml.bind.JAXBException, java.io.UnsupportedEncodingException
javax.xml.bind.JAXBException
java.io.UnsupportedEncodingException
public java.lang.String toString()
toString
in class NumericalFacet
public void check(boolean deep, java.lang.String errorContext) throws com.exalead.util.TypedException
check
in interface com.exalead.util.Checkable
check
in class NumericalFacet
com.exalead.util.TypedException
public void accept(NumericalFacet.Visitor visitor) throws com.exalead.util.TypedException
accept
in class NumericalFacet
com.exalead.util.TypedException
public void accept(VirtualFacet.Visitor visitor) throws com.exalead.util.TypedException
accept
in class VirtualFacet
com.exalead.util.TypedException
public void accept(Facet.Visitor visitor) throws com.exalead.util.TypedException
public void accept(FacetView.Visitor visitor) throws com.exalead.util.TypedException
public <T> T accept(NumericalFacet.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
accept
in class NumericalFacet
com.exalead.util.TypedException
public <T> T accept(VirtualFacet.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
accept
in class VirtualFacet
com.exalead.util.TypedException
public <T> T accept(Facet.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
public <T> T accept(FacetView.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
Copyright © 2013 Dassault Systèmes, All Rights Reserved.