Interface RangeNameProvider
- All Known Implementing Classes:
DefaultRangeNameProvider
public interface RangeNameProvider
Service responsible for resolving the ranges for indexed property values. This is called during indexing.
-
Method Summary
Modifier and TypeMethodDescriptiongetRangeNameList(IndexedProperty property, Object value) Resolves a list of range names for a specific value.getRangeNameList(IndexedProperty property, Object value, String qualifier) Resolves a list of range names for a specific value.getValueRanges(IndexedProperty property, String qualifier) Returns the ranges associated with an indexed property that match a specific qualifier.booleanisRanged(IndexedProperty property) Checks is an indexed property is ranged.
-
Method Details
-
isRanged
Checks is an indexed property is ranged.- Parameters:
property- - the indexed property- Returns:
trueif the indexed property is ranged,falseotherwise
-
getValueRanges
Returns the ranges associated with an indexed property that match a specific qualifier.- Parameters:
property- - the indexed propertyqualifier- - the qualifier used for matching- Returns:
- the list of ranges
-
getRangeNameList
List<String> getRangeNameList(IndexedProperty property, Object value) throws FieldValueProviderException Resolves a list of range names for a specific value. For numerical types it allows open upper-limit range. If the property is not multiValueIndexedProperty.isMultiValue()only first matching range will be returned- Parameters:
property- - the indexed propertyvalue- - the value for which the range names should be resolved- Returns:
- the list of range names
- Throws:
FieldValueProviderException- if it is not possible to resolve a range name for a specific value
-
getRangeNameList
List<String> getRangeNameList(IndexedProperty property, Object value, String qualifier) throws FieldValueProviderException Resolves a list of range names for a specific value. For numerical types it allows open upper-limit range. If the property is not multiValueIndexedProperty.isMultiValue()only first matching range will be returned- Parameters:
property- - the indexed propertyvalue- - the value for which the range names should be resolvedqualifier- - the qualifier used for matching- Returns:
- the list of range names
- Throws:
FieldValueProviderException- if it is not possible to resolve a range name for a specific value
-