public class FixedRangesNumericalFacet extends NumericalFacet implements com.exalead.util.Checkable, java.io.Serializable
NumericalFacet.Transformer<T>, NumericalFacet.Visitor
Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type
FacetView.SortFunction
Modifier and Type | Field and Description |
---|---|
boolean |
aboveMax |
java.lang.String |
aboveTitleFormat |
boolean |
belowMin |
java.lang.String |
belowTitleFormat |
static boolean |
DEFAULT_ABOVE_MAX |
static java.lang.String |
DEFAULT_ABOVE_TITLE_FORMAT |
static boolean |
DEFAULT_BELOW_MIN |
static java.lang.String |
DEFAULT_BELOW_TITLE_FORMAT |
static double |
DEFAULT_RANGE_SIZE |
static java.lang.String |
DEFAULT_RANGE_TITLE_FORMAT |
static java.lang.String |
DEFAULT_SINGLETON_TITLE_FORMAT |
double |
rangeSize |
java.lang.String |
rangeTitleFormat |
java.lang.String |
singletonTitleFormat |
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 |
---|
FixedRangesNumericalFacet() |
FixedRangesNumericalFacet(FixedRangesNumericalFacet o)
Copy constructor
|
FixedRangesNumericalFacet(java.lang.String id,
java.lang.String virtualRoot,
java.lang.String expr) |
FixedRangesNumericalFacet(java.lang.String id,
java.lang.String virtualRoot,
java.lang.String expr,
java.lang.Double min,
java.lang.Double max,
int lsb,
int msb) |
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 FixedRangesNumericalFacet.
|
static FixedRangesNumericalFacet |
fromString(java.lang.String s)
String representation of this FixedRangesNumericalFacet.
|
java.lang.String |
getAboveTitleFormat()
Format for the generated "above max" range.
The dollar sign will be replaced with the range's lower bound. To write a dollar sign, use \$. |
java.lang.String |
getBelowTitleFormat()
Format for the generated "below min" range.
The dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
double |
getRangeSize()
Size of each range.
0 means that the resulting facet will contain one range for each unique value. |
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. |
java.lang.String |
getSingletonTitleFormat()
Format for the generated single value range titles (like [3;3]).
The dollar sign will be replaced with the value. To write a dollar sign, use \$. |
boolean |
isAboveMax()
Creates a range [max;] that includes all values above the max.
|
boolean |
isBelowMin()
Creates a range [;min] that includes all values below the min.
|
FixedRangesNumericalFacet |
makeCopy()
Creates and returns a deep copy of this FixedRangesNumericalFacet.
|
static FixedRangesNumericalFacet |
readFrom(java.io.InputStream is)
Read this FixedRangesNumericalFacet from an XML fragment.
|
void |
setAboveMax(boolean aboveMax)
Creates a range [max;] that includes all values above the max.
|
void |
setAboveTitleFormat(java.lang.String aboveTitleFormat)
Format for the generated "above max" range.
The dollar sign will be replaced with the range's lower bound. To write a dollar sign, use \$. |
void |
setBelowMin(boolean belowMin)
Creates a range [;min] that includes all values below the min.
|
void |
setBelowTitleFormat(java.lang.String belowTitleFormat)
Format for the generated "below min" range.
The dollar sign will be replaced with the range's upper bound. To write a dollar sign, use \$. |
void |
setRangeSize(double rangeSize)
Size of each range.
0 means that the resulting facet will contain one range for each unique value. |
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. |
void |
setSingletonTitleFormat(java.lang.String singletonTitleFormat)
Format for the generated single value range titles (like [3;3]).
The dollar sign will be replaced with the value. To write a dollar sign, use \$. |
java.lang.String |
toString()
String representation of this FixedRangesNumericalFacet.
|
FixedRangesNumericalFacet |
withAboveMax(boolean aboveMax) |
FixedRangesNumericalFacet |
withAboveMax(java.lang.Boolean aboveMax) |
FixedRangesNumericalFacet |
withAboveTitleFormat(java.lang.String aboveTitleFormat) |
FixedRangesNumericalFacet |
withAdditionalFacetView(AdditionalFacetView... __values) |
FixedRangesNumericalFacet |
withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values) |
FixedRangesNumericalFacet |
withAggregateScores(boolean aggregateScores)
Deprecated.
|
FixedRangesNumericalFacet |
withAggregateScores(java.lang.Boolean aggregateScores)
Deprecated.
|
FixedRangesNumericalFacet |
withAggregationFunction(AggregationFunction... __values)
A numerical computation to perform on hits matching each value of the facet.
|
FixedRangesNumericalFacet |
withAggregationFunction(java.util.Collection<AggregationFunction> __values) |
FixedRangesNumericalFacet |
withBelowMin(boolean belowMin) |
FixedRangesNumericalFacet |
withBelowMin(java.lang.Boolean belowMin) |
FixedRangesNumericalFacet |
withBelowTitleFormat(java.lang.String belowTitleFormat) |
FixedRangesNumericalFacet |
withDataModelClass(java.lang.String dataModelClass) |
FixedRangesNumericalFacet |
withDataModelProperty(java.lang.String dataModelProperty) |
FixedRangesNumericalFacet |
withDataModelState(java.lang.String dataModelState) |
FixedRangesNumericalFacet |
withDefaultPrecision(int defaultPrecision) |
FixedRangesNumericalFacet |
withDefaultPrecision(java.lang.Integer defaultPrecision) |
FixedRangesNumericalFacet |
withExplicitSortOrderValues(java.lang.String explicitSortOrderValues) |
FixedRangesNumericalFacet |
withExpr(java.lang.String expr) |
FixedRangesNumericalFacet |
withFromDataModel(Facet fromDataModel) |
FixedRangesNumericalFacet |
withId(java.lang.String id) |
FixedRangesNumericalFacet |
withImplementation(java.lang.String implementation) |
FixedRangesNumericalFacet |
withIndex(int index) |
FixedRangesNumericalFacet |
withIndex(java.lang.Integer index) |
FixedRangesNumericalFacet |
withInHits(boolean inHits) |
FixedRangesNumericalFacet |
withInHits(java.lang.Boolean inHits) |
FixedRangesNumericalFacet |
withInNavigation(boolean inNavigation) |
FixedRangesNumericalFacet |
withInNavigation(java.lang.Boolean inNavigation) |
FixedRangesNumericalFacet |
withLsb(int lsb) |
FixedRangesNumericalFacet |
withLsb(java.lang.Integer lsb) |
FixedRangesNumericalFacet |
withMax(double max) |
FixedRangesNumericalFacet |
withMax(java.lang.Double max) |
FixedRangesNumericalFacet |
withMaxCategories(int maxCategories) |
FixedRangesNumericalFacet |
withMaxCategories(java.lang.Integer maxCategories) |
FixedRangesNumericalFacet |
withMaxCategoriesPerLevel(int maxCategoriesPerLevel) |
FixedRangesNumericalFacet |
withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel) |
FixedRangesNumericalFacet |
withMaxSliceCategories(int maxSliceCategories) |
FixedRangesNumericalFacet |
withMaxSliceCategories(java.lang.Integer maxSliceCategories) |
FixedRangesNumericalFacet |
withMaxValues(int maxValues) |
FixedRangesNumericalFacet |
withMaxValues(java.lang.Integer maxValues) |
FixedRangesNumericalFacet |
withMin(double min) |
FixedRangesNumericalFacet |
withMin(java.lang.Double min) |
FixedRangesNumericalFacet |
withMinDocsPerCategory(int minDocsPerCategory) |
FixedRangesNumericalFacet |
withMinDocsPerCategory(java.lang.Integer minDocsPerCategory) |
FixedRangesNumericalFacet |
withMsb(int msb) |
FixedRangesNumericalFacet |
withMsb(java.lang.Integer msb) |
FixedRangesNumericalFacet |
withRangeSize(double rangeSize) |
FixedRangesNumericalFacet |
withRangeTitleFormat(java.lang.String rangeTitleFormat) |
FixedRangesNumericalFacet |
withRefinementPolicy(java.lang.String refinementPolicy) |
FixedRangesNumericalFacet |
withReverse(boolean reverse) |
FixedRangesNumericalFacet |
withReverse(java.lang.Boolean reverse) |
FixedRangesNumericalFacet |
withSingletonTitleFormat(java.lang.String singletonTitleFormat) |
FixedRangesNumericalFacet |
withSortAggregationFunction(java.lang.String sortAggregationFunction) |
FixedRangesNumericalFacet |
withSortFunction(java.lang.String sortFunction) |
FixedRangesNumericalFacet |
withType(java.lang.String type) |
FixedRangesNumericalFacet |
withVirtualRoot(java.lang.String virtualRoot) |
void |
writeTo(java.io.OutputStream os)
Write this FixedRangesNumericalFacet 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 rangeSize
public static final double DEFAULT_RANGE_SIZE
public boolean aboveMax
public static final boolean DEFAULT_ABOVE_MAX
public boolean belowMin
public static final boolean DEFAULT_BELOW_MIN
public java.lang.String rangeTitleFormat
public static final java.lang.String DEFAULT_RANGE_TITLE_FORMAT
public java.lang.String aboveTitleFormat
public static final java.lang.String DEFAULT_ABOVE_TITLE_FORMAT
public java.lang.String belowTitleFormat
public static final java.lang.String DEFAULT_BELOW_TITLE_FORMAT
public java.lang.String singletonTitleFormat
public static final java.lang.String DEFAULT_SINGLETON_TITLE_FORMAT
public FixedRangesNumericalFacet()
public FixedRangesNumericalFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr, java.lang.Double min, java.lang.Double max, int lsb, int msb)
public FixedRangesNumericalFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr)
public FixedRangesNumericalFacet(FixedRangesNumericalFacet o)
public FixedRangesNumericalFacet withExpr(java.lang.String expr)
withExpr
in class NumericalFacet
public FixedRangesNumericalFacet withMin(java.lang.Double min)
withMin
in class NumericalFacet
public FixedRangesNumericalFacet withMin(double min)
withMin
in class NumericalFacet
public FixedRangesNumericalFacet withMax(java.lang.Double max)
withMax
in class NumericalFacet
public FixedRangesNumericalFacet withMax(double max)
withMax
in class NumericalFacet
public FixedRangesNumericalFacet withLsb(int lsb)
withLsb
in class NumericalFacet
public FixedRangesNumericalFacet withLsb(java.lang.Integer lsb)
withLsb
in class NumericalFacet
public FixedRangesNumericalFacet withMsb(int msb)
withMsb
in class NumericalFacet
public FixedRangesNumericalFacet withMsb(java.lang.Integer msb)
withMsb
in class NumericalFacet
public FixedRangesNumericalFacet withMaxValues(int maxValues)
withMaxValues
in class NumericalFacet
public FixedRangesNumericalFacet withMaxValues(java.lang.Integer maxValues)
withMaxValues
in class NumericalFacet
public FixedRangesNumericalFacet withDefaultPrecision(int defaultPrecision)
withDefaultPrecision
in class NumericalFacet
public FixedRangesNumericalFacet withDefaultPrecision(java.lang.Integer defaultPrecision)
withDefaultPrecision
in class NumericalFacet
public FixedRangesNumericalFacet withVirtualRoot(java.lang.String virtualRoot)
withVirtualRoot
in class NumericalFacet
public FixedRangesNumericalFacet withId(java.lang.String id)
withId
in class NumericalFacet
public FixedRangesNumericalFacet withType(java.lang.String type)
withType
in class NumericalFacet
public FixedRangesNumericalFacet withIndex(int index)
withIndex
in class NumericalFacet
public FixedRangesNumericalFacet withIndex(java.lang.Integer index)
withIndex
in class NumericalFacet
public FixedRangesNumericalFacet withRefinementPolicy(java.lang.String refinementPolicy)
withRefinementPolicy
in class NumericalFacet
public FixedRangesNumericalFacet withImplementation(java.lang.String implementation)
withImplementation
in class NumericalFacet
public FixedRangesNumericalFacet withDataModelState(java.lang.String dataModelState)
withDataModelState
in class NumericalFacet
public FixedRangesNumericalFacet withFromDataModel(Facet fromDataModel)
withFromDataModel
in class NumericalFacet
public FixedRangesNumericalFacet withDataModelClass(java.lang.String dataModelClass)
withDataModelClass
in class NumericalFacet
public FixedRangesNumericalFacet withDataModelProperty(java.lang.String dataModelProperty)
withDataModelProperty
in class NumericalFacet
public FixedRangesNumericalFacet withInNavigation(boolean inNavigation)
withInNavigation
in class NumericalFacet
public FixedRangesNumericalFacet withInNavigation(java.lang.Boolean inNavigation)
withInNavigation
in class NumericalFacet
public FixedRangesNumericalFacet withInHits(boolean inHits)
withInHits
in class NumericalFacet
public FixedRangesNumericalFacet withInHits(java.lang.Boolean inHits)
withInHits
in class NumericalFacet
public FixedRangesNumericalFacet withAggregationFunction(AggregationFunction... __values)
withAggregationFunction
in class NumericalFacet
public FixedRangesNumericalFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)
withAggregationFunction
in class NumericalFacet
public FixedRangesNumericalFacet withAdditionalFacetView(AdditionalFacetView... __values)
withAdditionalFacetView
in class NumericalFacet
public FixedRangesNumericalFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
withAdditionalFacetView
in class NumericalFacet
public FixedRangesNumericalFacet withMaxSliceCategories(int maxSliceCategories)
withMaxSliceCategories
in class NumericalFacet
public FixedRangesNumericalFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)
withMaxSliceCategories
in class NumericalFacet
public FixedRangesNumericalFacet withMinDocsPerCategory(int minDocsPerCategory)
withMinDocsPerCategory
in class NumericalFacet
public FixedRangesNumericalFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
withMinDocsPerCategory
in class NumericalFacet
public FixedRangesNumericalFacet withMaxCategories(int maxCategories)
withMaxCategories
in class NumericalFacet
public FixedRangesNumericalFacet withMaxCategories(java.lang.Integer maxCategories)
withMaxCategories
in class NumericalFacet
public FixedRangesNumericalFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class NumericalFacet
public FixedRangesNumericalFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class NumericalFacet
public FixedRangesNumericalFacet withSortFunction(java.lang.String sortFunction)
withSortFunction
in class NumericalFacet
public FixedRangesNumericalFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)
withSortAggregationFunction
in class NumericalFacet
public FixedRangesNumericalFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
withExplicitSortOrderValues
in class NumericalFacet
public FixedRangesNumericalFacet withReverse(boolean reverse)
withReverse
in class NumericalFacet
public FixedRangesNumericalFacet withReverse(java.lang.Boolean reverse)
withReverse
in class NumericalFacet
@Deprecated public FixedRangesNumericalFacet withAggregateScores(boolean aggregateScores)
withAggregateScores
in class NumericalFacet
@Deprecated public FixedRangesNumericalFacet withAggregateScores(java.lang.Boolean aggregateScores)
withAggregateScores
in class NumericalFacet
public void setRangeSize(double rangeSize)
public double getRangeSize()
public FixedRangesNumericalFacet withRangeSize(double rangeSize)
public void setAboveMax(boolean aboveMax)
public boolean isAboveMax()
public FixedRangesNumericalFacet withAboveMax(boolean aboveMax)
public FixedRangesNumericalFacet withAboveMax(java.lang.Boolean aboveMax)
public void setBelowMin(boolean belowMin)
public boolean isBelowMin()
public FixedRangesNumericalFacet withBelowMin(boolean belowMin)
public FixedRangesNumericalFacet withBelowMin(java.lang.Boolean belowMin)
public void setRangeTitleFormat(java.lang.String rangeTitleFormat)
public java.lang.String getRangeTitleFormat()
public FixedRangesNumericalFacet withRangeTitleFormat(java.lang.String rangeTitleFormat)
public void setAboveTitleFormat(java.lang.String aboveTitleFormat)
public java.lang.String getAboveTitleFormat()
public FixedRangesNumericalFacet withAboveTitleFormat(java.lang.String aboveTitleFormat)
public void setBelowTitleFormat(java.lang.String belowTitleFormat)
public java.lang.String getBelowTitleFormat()
public FixedRangesNumericalFacet withBelowTitleFormat(java.lang.String belowTitleFormat)
public void setSingletonTitleFormat(java.lang.String singletonTitleFormat)
public java.lang.String getSingletonTitleFormat()
public FixedRangesNumericalFacet withSingletonTitleFormat(java.lang.String singletonTitleFormat)
public FixedRangesNumericalFacet makeCopy()
makeCopy
in class NumericalFacet
public static FixedRangesNumericalFacet 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 FixedRangesNumericalFacet 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.