XML Configuration Reference : Search : DynamicDateFacet
 
DynamicDateFacet
• com.exalead.search.v30.DynamicDateFacet
• A DynamicDateFacet will generate max 'maxCategories' categories, scaling the resolution to a day, week, month or year level.
• Parent elements:
◦ com.exalead.search.v30.FacetsConfig (as FacetsConfig)
• Attributes:
Name
Type
Default value
Description
virtualRoot
string
Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path. For example: Top/VirtualRoot/[0;5]
id
string
Unique identifier of this facet. Used in Mashup-Builder and client applications to identify the facet.
type
enum(category, h2d, num_explicit, num_fixed, num_dynamic, geo, autotile, value, multi, enum, date, dyndate, autotilev2, concatvalue)
Used for convenience in various introspection code
refinementPolicy
enum(exclusive, disjunctive, norefine)
exclusive
Defines the Refinements panel behavior.
• Disjunctive: Allows you to select multiple categories at once for refinement (it creates an OR operation). Continues to display all categories when one is selected.
• Exclusive: Only allows you to select one category for refinement. Hides other categories when one is selected.
• No refine: Allows you to display all categories without enabling refinements.
implementation
enum(autodetect, favor_cpu, favor_memory)
autodetect
Internal algorithm for implementation of this facet. Value can be null or one of
• autodetect
• favor_cpu
• favor_memory
.
• "favor_cpu" consumes less CPU, at the expense of additional RAM consumption (RAM is consumed for each facet value in the index).
• "favor_memory" reduces RAM consumption (RAM is only consumed for each facet value in the result set).
• "autodetect" automatically selects a suitable policy based on the result set and facet data.
inNavigation
boolean
True
Computes navigation on this facet.
inHits
boolean
True
Computes the value of this facet for each hit.
maxSliceCategories
int
Maximum number of categories returned by each slice for one facet. 0 means no limit. Warning: Results merged by the search server may be incorrect.
sortFunction
enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng)
count
Specifies a sorting function:
• Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending.
• Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending.
• Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet.
• Date: Sorts the categories by:
◦ Default with decreasing year, increasing month, increasing day
◦ Reverse with increasing year, decreasing month, decreasing day
• Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values.
• Latitude: Sorts the categories by latitude, using the average of points.
• Longitude: Sorts the categories by longitude, using the average of points.
• Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending.
• Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending.
• Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF.
aggregateScores
boolean
If selected, the category score will be the sum of the scores of all its hits.
expr
string
The date field or virtual expr to use.
yearOutputFormat
string
%Y
The output format used to generate year-based categories.
quarterOutputFormat
string
%Y %Q
The output format used to generate quarter-based categories (use %Q to specify the quarter number).
monthOutputFormat
string
%b %Y
The output format used to generate month-based categories.
weekOutputFormat
string
week %V %Y
The output format used to generate week-based categories.
dayOutputFormat
string
%Y/%m/%d
The output format used to generate day-based categories.
hourOutputFormat
string
%Y/%m/%d %H
The output format used to generate hour-based categories.
minuteOutputFormat
string
%Y/%m/%d %H:%M
The output format used to generate minute-based categories.
secondOutputFormat
string
%Y/%m/%d %H:%M:%S
The output format used to generate second-based categories.
enableYearLevel
boolean
True
Enables the year level
enableQuarterLevel
boolean
Enables the quarter level
enableMonthLevel
boolean
True
Enables the month level
enableWeekLevel
boolean
Enables the week level
enableDayLevel
boolean
True
Enables the day level
enableHourLevel
boolean
Enables the hour level
enableMinuteLevel
boolean
Enables the minute level
enableSecondLevel
boolean
Enables the second level
enableISO8601Compliance
boolean
True
Enables the ISO 8601 standard instead of the American standard. In ISO 8601, weeks start on Monday and a few rules determine the first and last weeks of each year. Use compatible Output formats. Typically, use %V for ISO 8601 instead of %U for American, otherwise week numbering will not be consistent with grouping.
generateMissingIntervals
boolean
True
Generates missing dates setting their count to 0 and aggregation values to NO_VALUE
minDocsPerCategory
int
1
Minimum number of docs in a category for it to be included in the Refinements panel.
maxCategories
int
Maximum number of categories to display in the facet. 0 means all categories will be displayed.
maxCategoriesPerLevel
int
100
Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level.
sortAggregationFunction
string
Aggregation function used to sort by aggregation values.
explicitSortOrderValues
string
Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma).
reverse
boolean
Reverse sorting order.
index
int
Internal.
dataModelState
string
dataModelClass
string
If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this facet.
dataModelProperty
string
If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this facet.
• Nested elements:
Name
Type
Description
fromDataModel
com.exalead.search.v30.Facet
AdditionalFacetView
com.exalead.search.v30.AdditionalFacetView*
AggregationFunction
com.exalead.search.v30.AggregationFunction*
A numerical computation to perform on hits matching each value of the facet.