com.exalead.search.v30

Class DynamicDateFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.DynamicDateFacet

All Implemented Interfaces:

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

public class DynamicDateFacet
extends VirtualFacet
implements com.exalead.util.Checkable, java.io.Serializable

A DynamicDateFacet will generate max 'maxCategories' categories, scaling the resolution to a day, week, month or year level.

See Also:

Serialized Form

Nested Class Summary

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

VirtualFacet.Transformer<T>, VirtualFacet.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.lang.String	dayOutputFormat
static java.lang.String	DEFAULT_DAY_OUTPUT_FORMAT
static boolean	DEFAULT_ENABLE_DAY_LEVEL
static boolean	DEFAULT_ENABLE_HOUR_LEVEL
static boolean	DEFAULT_ENABLE_I_S_O8601_COMPLIANCE
static boolean	DEFAULT_ENABLE_MINUTE_LEVEL
static boolean	DEFAULT_ENABLE_MONTH_LEVEL
static boolean	DEFAULT_ENABLE_QUARTER_LEVEL
static boolean	DEFAULT_ENABLE_SECOND_LEVEL
static boolean	DEFAULT_ENABLE_WEEK_LEVEL
static boolean	DEFAULT_ENABLE_YEAR_LEVEL
static boolean	DEFAULT_GENERATE_MISSING_INTERVALS
static java.lang.String	DEFAULT_HOUR_OUTPUT_FORMAT
static java.lang.String	DEFAULT_MINUTE_OUTPUT_FORMAT
static java.lang.String	DEFAULT_MONTH_OUTPUT_FORMAT
static java.lang.String	DEFAULT_QUARTER_OUTPUT_FORMAT
static java.lang.String	DEFAULT_SECOND_OUTPUT_FORMAT
static java.lang.String	DEFAULT_WEEK_OUTPUT_FORMAT
static java.lang.String	DEFAULT_YEAR_OUTPUT_FORMAT
boolean	enableDayLevel
boolean	enableHourLevel
boolean	enableISO8601Compliance
boolean	enableMinuteLevel
boolean	enableMonthLevel
boolean	enableQuarterLevel
boolean	enableSecondLevel
boolean	enableWeekLevel
boolean	enableYearLevel
java.lang.String	expr
boolean	generateMissingIntervals
java.lang.String	hourOutputFormat
java.lang.String	minuteOutputFormat
java.lang.String	monthOutputFormat
java.lang.String	quarterOutputFormat
java.lang.String	secondOutputFormat
java.lang.String	weekOutputFormat
java.lang.String	yearOutputFormat

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
DynamicDateFacet()
DynamicDateFacet(DynamicDateFacet o) Copy constructor

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(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this DynamicDateFacet.
static DynamicDateFacet	fromString(java.lang.String s) String representation of this DynamicDateFacet.
java.lang.String	getDayOutputFormat() The output format used to generate day-based categories.
java.lang.String	getExpr() The date field or virtual expr to use.
java.lang.String	getHourOutputFormat() The output format used to generate hour-based categories.
java.lang.String	getMinuteOutputFormat() The output format used to generate minute-based categories.
java.lang.String	getMonthOutputFormat() The output format used to generate month-based categories.
java.lang.String	getQuarterOutputFormat() The output format used to generate quarter-based categories (use %Q to specify the quarter number).
java.lang.String	getSecondOutputFormat() The output format used to generate second-based categories.
java.lang.String	getWeekOutputFormat() The output format used to generate week-based categories.
java.lang.String	getYearOutputFormat() The output format used to generate year-based categories.
boolean	isEnableDayLevel() Enables the day level
boolean	isEnableHourLevel() Enables the hour level
boolean	isEnableISO8601Compliance() 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.
boolean	isEnableMinuteLevel() Enables the minute level
boolean	isEnableMonthLevel() Enables the month level
boolean	isEnableQuarterLevel() Enables the quarter level
boolean	isEnableSecondLevel() Enables the second level
boolean	isEnableWeekLevel() Enables the week level
boolean	isEnableYearLevel() Enables the year level
boolean	isGenerateMissingIntervals() Generates missing dates setting their count to 0 and aggregation values to NO_VALUE
DynamicDateFacet	makeCopy() Creates and returns a deep copy of this DynamicDateFacet.
static DynamicDateFacet	readFrom(java.io.InputStream is) Read this DynamicDateFacet from an XML fragment.
void	setDayOutputFormat(java.lang.String dayOutputFormat) The output format used to generate day-based categories.
void	setEnableDayLevel(boolean enableDayLevel) Enables the day level
void	setEnableHourLevel(boolean enableHourLevel) Enables the hour level
void	setEnableISO8601Compliance(boolean enableISO8601Compliance) 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.
void	setEnableMinuteLevel(boolean enableMinuteLevel) Enables the minute level
void	setEnableMonthLevel(boolean enableMonthLevel) Enables the month level
void	setEnableQuarterLevel(boolean enableQuarterLevel) Enables the quarter level
void	setEnableSecondLevel(boolean enableSecondLevel) Enables the second level
void	setEnableWeekLevel(boolean enableWeekLevel) Enables the week level
void	setEnableYearLevel(boolean enableYearLevel) Enables the year level
void	setExpr(java.lang.String expr) The date field or virtual expr to use.
void	setGenerateMissingIntervals(boolean generateMissingIntervals) Generates missing dates setting their count to 0 and aggregation values to NO_VALUE
void	setHourOutputFormat(java.lang.String hourOutputFormat) The output format used to generate hour-based categories.
void	setMinuteOutputFormat(java.lang.String minuteOutputFormat) The output format used to generate minute-based categories.
void	setMonthOutputFormat(java.lang.String monthOutputFormat) The output format used to generate month-based categories.
void	setQuarterOutputFormat(java.lang.String quarterOutputFormat) The output format used to generate quarter-based categories (use %Q to specify the quarter number).
void	setSecondOutputFormat(java.lang.String secondOutputFormat) The output format used to generate second-based categories.
void	setWeekOutputFormat(java.lang.String weekOutputFormat) The output format used to generate week-based categories.
void	setYearOutputFormat(java.lang.String yearOutputFormat) The output format used to generate year-based categories.
java.lang.String	toString() String representation of this DynamicDateFacet.
DynamicDateFacet	withAdditionalFacetView(AdditionalFacetView... __values)
DynamicDateFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
DynamicDateFacet	withAggregateScores(boolean aggregateScores) Deprecated.
DynamicDateFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
DynamicDateFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
DynamicDateFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
DynamicDateFacet	withDataModelClass(java.lang.String dataModelClass)
DynamicDateFacet	withDataModelProperty(java.lang.String dataModelProperty)
DynamicDateFacet	withDataModelState(java.lang.String dataModelState)
DynamicDateFacet	withDayOutputFormat(java.lang.String dayOutputFormat)
DynamicDateFacet	withEnableDayLevel(boolean enableDayLevel)
DynamicDateFacet	withEnableDayLevel(java.lang.Boolean enableDayLevel)
DynamicDateFacet	withEnableHourLevel(boolean enableHourLevel)
DynamicDateFacet	withEnableHourLevel(java.lang.Boolean enableHourLevel)
DynamicDateFacet	withEnableISO8601Compliance(boolean enableISO8601Compliance)
DynamicDateFacet	withEnableISO8601Compliance(java.lang.Boolean enableISO8601Compliance)
DynamicDateFacet	withEnableMinuteLevel(boolean enableMinuteLevel)
DynamicDateFacet	withEnableMinuteLevel(java.lang.Boolean enableMinuteLevel)
DynamicDateFacet	withEnableMonthLevel(boolean enableMonthLevel)
DynamicDateFacet	withEnableMonthLevel(java.lang.Boolean enableMonthLevel)
DynamicDateFacet	withEnableQuarterLevel(boolean enableQuarterLevel)
DynamicDateFacet	withEnableQuarterLevel(java.lang.Boolean enableQuarterLevel)
DynamicDateFacet	withEnableSecondLevel(boolean enableSecondLevel)
DynamicDateFacet	withEnableSecondLevel(java.lang.Boolean enableSecondLevel)
DynamicDateFacet	withEnableWeekLevel(boolean enableWeekLevel)
DynamicDateFacet	withEnableWeekLevel(java.lang.Boolean enableWeekLevel)
DynamicDateFacet	withEnableYearLevel(boolean enableYearLevel)
DynamicDateFacet	withEnableYearLevel(java.lang.Boolean enableYearLevel)
DynamicDateFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
DynamicDateFacet	withExpr(java.lang.String expr)
DynamicDateFacet	withFromDataModel(Facet fromDataModel)
DynamicDateFacet	withGenerateMissingIntervals(boolean generateMissingIntervals)
DynamicDateFacet	withGenerateMissingIntervals(java.lang.Boolean generateMissingIntervals)
DynamicDateFacet	withHourOutputFormat(java.lang.String hourOutputFormat)
DynamicDateFacet	withId(java.lang.String id)
DynamicDateFacet	withImplementation(java.lang.String implementation)
DynamicDateFacet	withIndex(int index)
DynamicDateFacet	withIndex(java.lang.Integer index)
DynamicDateFacet	withInHits(boolean inHits)
DynamicDateFacet	withInHits(java.lang.Boolean inHits)
DynamicDateFacet	withInNavigation(boolean inNavigation)
DynamicDateFacet	withInNavigation(java.lang.Boolean inNavigation)
DynamicDateFacet	withMaxCategories(int maxCategories)
DynamicDateFacet	withMaxCategories(java.lang.Integer maxCategories)
DynamicDateFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
DynamicDateFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
DynamicDateFacet	withMaxSliceCategories(int maxSliceCategories)
DynamicDateFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
DynamicDateFacet	withMinDocsPerCategory(int minDocsPerCategory)
DynamicDateFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
DynamicDateFacet	withMinuteOutputFormat(java.lang.String minuteOutputFormat)
DynamicDateFacet	withMonthOutputFormat(java.lang.String monthOutputFormat)
DynamicDateFacet	withQuarterOutputFormat(java.lang.String quarterOutputFormat)
DynamicDateFacet	withRefinementPolicy(java.lang.String refinementPolicy)
DynamicDateFacet	withReverse(boolean reverse)
DynamicDateFacet	withReverse(java.lang.Boolean reverse)
DynamicDateFacet	withSecondOutputFormat(java.lang.String secondOutputFormat)
DynamicDateFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
DynamicDateFacet	withSortFunction(java.lang.String sortFunction)
DynamicDateFacet	withType(java.lang.String type)
DynamicDateFacet	withVirtualRoot(java.lang.String virtualRoot)
DynamicDateFacet	withWeekOutputFormat(java.lang.String weekOutputFormat)
DynamicDateFacet	withYearOutputFormat(java.lang.String yearOutputFormat)
void	writeTo(java.io.OutputStream os) Write this DynamicDateFacet as an XML fragment

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

expr

public java.lang.String expr

yearOutputFormat

public java.lang.String yearOutputFormat

DEFAULT_YEAR_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_YEAR_OUTPUT_FORMAT

See Also:

Constant Field Values

quarterOutputFormat

public java.lang.String quarterOutputFormat

DEFAULT_QUARTER_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_QUARTER_OUTPUT_FORMAT

See Also:

Constant Field Values

monthOutputFormat

public java.lang.String monthOutputFormat

DEFAULT_MONTH_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_MONTH_OUTPUT_FORMAT

See Also:

Constant Field Values

weekOutputFormat

public java.lang.String weekOutputFormat

DEFAULT_WEEK_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_WEEK_OUTPUT_FORMAT

See Also:

Constant Field Values

dayOutputFormat

public java.lang.String dayOutputFormat

DEFAULT_DAY_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_DAY_OUTPUT_FORMAT

See Also:

Constant Field Values

hourOutputFormat

public java.lang.String hourOutputFormat

DEFAULT_HOUR_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_HOUR_OUTPUT_FORMAT

See Also:

Constant Field Values

minuteOutputFormat

public java.lang.String minuteOutputFormat

DEFAULT_MINUTE_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_MINUTE_OUTPUT_FORMAT

See Also:

Constant Field Values

secondOutputFormat

public java.lang.String secondOutputFormat

DEFAULT_SECOND_OUTPUT_FORMAT

public static final java.lang.String DEFAULT_SECOND_OUTPUT_FORMAT

See Also:

Constant Field Values

enableYearLevel

public boolean enableYearLevel

DEFAULT_ENABLE_YEAR_LEVEL

public static final boolean DEFAULT_ENABLE_YEAR_LEVEL

See Also:

Constant Field Values

enableQuarterLevel

public boolean enableQuarterLevel

DEFAULT_ENABLE_QUARTER_LEVEL

public static final boolean DEFAULT_ENABLE_QUARTER_LEVEL

See Also:

Constant Field Values

enableMonthLevel

public boolean enableMonthLevel

DEFAULT_ENABLE_MONTH_LEVEL

public static final boolean DEFAULT_ENABLE_MONTH_LEVEL

See Also:

Constant Field Values

enableWeekLevel

public boolean enableWeekLevel

DEFAULT_ENABLE_WEEK_LEVEL

public static final boolean DEFAULT_ENABLE_WEEK_LEVEL

See Also:

Constant Field Values

enableDayLevel

public boolean enableDayLevel

DEFAULT_ENABLE_DAY_LEVEL

public static final boolean DEFAULT_ENABLE_DAY_LEVEL

See Also:

Constant Field Values

enableHourLevel

public boolean enableHourLevel

DEFAULT_ENABLE_HOUR_LEVEL

public static final boolean DEFAULT_ENABLE_HOUR_LEVEL

See Also:

Constant Field Values

enableMinuteLevel

public boolean enableMinuteLevel

DEFAULT_ENABLE_MINUTE_LEVEL

public static final boolean DEFAULT_ENABLE_MINUTE_LEVEL

See Also:

Constant Field Values

enableSecondLevel

public boolean enableSecondLevel

DEFAULT_ENABLE_SECOND_LEVEL

public static final boolean DEFAULT_ENABLE_SECOND_LEVEL

See Also:

Constant Field Values

enableISO8601Compliance

public boolean enableISO8601Compliance

DEFAULT_ENABLE_I_S_O8601_COMPLIANCE

public static final boolean DEFAULT_ENABLE_I_S_O8601_COMPLIANCE

See Also:

Constant Field Values

generateMissingIntervals

public boolean generateMissingIntervals

DEFAULT_GENERATE_MISSING_INTERVALS

public static final boolean DEFAULT_GENERATE_MISSING_INTERVALS

See Also:

Constant Field Values

Constructor Detail

DynamicDateFacet

public DynamicDateFacet()

DynamicDateFacet

public DynamicDateFacet(DynamicDateFacet o)

Copy constructor

Method Detail

withVirtualRoot

public DynamicDateFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public DynamicDateFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public DynamicDateFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public DynamicDateFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public DynamicDateFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public DynamicDateFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public DynamicDateFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public DynamicDateFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public DynamicDateFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public DynamicDateFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public DynamicDateFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public DynamicDateFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public DynamicDateFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public DynamicDateFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public DynamicDateFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public DynamicDateFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public DynamicDateFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public DynamicDateFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public DynamicDateFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public DynamicDateFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public DynamicDateFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public DynamicDateFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public DynamicDateFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public DynamicDateFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public DynamicDateFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public DynamicDateFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public DynamicDateFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public DynamicDateFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public DynamicDateFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public DynamicDateFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public DynamicDateFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setExpr

public void setExpr(java.lang.String expr)

The date field or virtual expr to use.

getExpr

public java.lang.String getExpr()

The date field or virtual expr to use.

withExpr

public DynamicDateFacet withExpr(java.lang.String expr)

setYearOutputFormat

public void setYearOutputFormat(java.lang.String yearOutputFormat)

The output format used to generate year-based categories.

getYearOutputFormat

public java.lang.String getYearOutputFormat()

The output format used to generate year-based categories.

withYearOutputFormat

public DynamicDateFacet withYearOutputFormat(java.lang.String yearOutputFormat)

setQuarterOutputFormat

public void setQuarterOutputFormat(java.lang.String quarterOutputFormat)

The output format used to generate quarter-based categories (use %Q to specify the quarter number).

getQuarterOutputFormat

public java.lang.String getQuarterOutputFormat()

The output format used to generate quarter-based categories (use %Q to specify the quarter number).

withQuarterOutputFormat

public DynamicDateFacet withQuarterOutputFormat(java.lang.String quarterOutputFormat)

setMonthOutputFormat

public void setMonthOutputFormat(java.lang.String monthOutputFormat)

The output format used to generate month-based categories.

getMonthOutputFormat

public java.lang.String getMonthOutputFormat()

The output format used to generate month-based categories.

withMonthOutputFormat

public DynamicDateFacet withMonthOutputFormat(java.lang.String monthOutputFormat)

setWeekOutputFormat

public void setWeekOutputFormat(java.lang.String weekOutputFormat)

The output format used to generate week-based categories.

getWeekOutputFormat

public java.lang.String getWeekOutputFormat()

The output format used to generate week-based categories.

withWeekOutputFormat

public DynamicDateFacet withWeekOutputFormat(java.lang.String weekOutputFormat)

setDayOutputFormat

public void setDayOutputFormat(java.lang.String dayOutputFormat)

The output format used to generate day-based categories.

getDayOutputFormat

public java.lang.String getDayOutputFormat()

The output format used to generate day-based categories.

withDayOutputFormat

public DynamicDateFacet withDayOutputFormat(java.lang.String dayOutputFormat)

setHourOutputFormat

public void setHourOutputFormat(java.lang.String hourOutputFormat)

The output format used to generate hour-based categories.

getHourOutputFormat

public java.lang.String getHourOutputFormat()

The output format used to generate hour-based categories.

withHourOutputFormat

public DynamicDateFacet withHourOutputFormat(java.lang.String hourOutputFormat)

setMinuteOutputFormat

public void setMinuteOutputFormat(java.lang.String minuteOutputFormat)

The output format used to generate minute-based categories.

getMinuteOutputFormat

public java.lang.String getMinuteOutputFormat()

The output format used to generate minute-based categories.

withMinuteOutputFormat

public DynamicDateFacet withMinuteOutputFormat(java.lang.String minuteOutputFormat)

setSecondOutputFormat

public void setSecondOutputFormat(java.lang.String secondOutputFormat)

The output format used to generate second-based categories.

getSecondOutputFormat

public java.lang.String getSecondOutputFormat()

The output format used to generate second-based categories.

withSecondOutputFormat

public DynamicDateFacet withSecondOutputFormat(java.lang.String secondOutputFormat)

setEnableYearLevel

public void setEnableYearLevel(boolean enableYearLevel)

Enables the year level

isEnableYearLevel

public boolean isEnableYearLevel()

Enables the year level

withEnableYearLevel

public DynamicDateFacet withEnableYearLevel(boolean enableYearLevel)

withEnableYearLevel

public DynamicDateFacet withEnableYearLevel(java.lang.Boolean enableYearLevel)

setEnableQuarterLevel

public void setEnableQuarterLevel(boolean enableQuarterLevel)

Enables the quarter level

isEnableQuarterLevel

public boolean isEnableQuarterLevel()

Enables the quarter level

withEnableQuarterLevel

public DynamicDateFacet withEnableQuarterLevel(boolean enableQuarterLevel)

withEnableQuarterLevel

public DynamicDateFacet withEnableQuarterLevel(java.lang.Boolean enableQuarterLevel)

setEnableMonthLevel

public void setEnableMonthLevel(boolean enableMonthLevel)

Enables the month level

isEnableMonthLevel

public boolean isEnableMonthLevel()

Enables the month level

withEnableMonthLevel

public DynamicDateFacet withEnableMonthLevel(boolean enableMonthLevel)

withEnableMonthLevel

public DynamicDateFacet withEnableMonthLevel(java.lang.Boolean enableMonthLevel)

setEnableWeekLevel

public void setEnableWeekLevel(boolean enableWeekLevel)

Enables the week level

isEnableWeekLevel

public boolean isEnableWeekLevel()

Enables the week level

withEnableWeekLevel

public DynamicDateFacet withEnableWeekLevel(boolean enableWeekLevel)

withEnableWeekLevel

public DynamicDateFacet withEnableWeekLevel(java.lang.Boolean enableWeekLevel)

setEnableDayLevel

public void setEnableDayLevel(boolean enableDayLevel)

Enables the day level

isEnableDayLevel

public boolean isEnableDayLevel()

Enables the day level

withEnableDayLevel

public DynamicDateFacet withEnableDayLevel(boolean enableDayLevel)

withEnableDayLevel

public DynamicDateFacet withEnableDayLevel(java.lang.Boolean enableDayLevel)

setEnableHourLevel

public void setEnableHourLevel(boolean enableHourLevel)

Enables the hour level

isEnableHourLevel

public boolean isEnableHourLevel()

Enables the hour level

withEnableHourLevel

public DynamicDateFacet withEnableHourLevel(boolean enableHourLevel)

withEnableHourLevel

public DynamicDateFacet withEnableHourLevel(java.lang.Boolean enableHourLevel)

setEnableMinuteLevel

public void setEnableMinuteLevel(boolean enableMinuteLevel)

Enables the minute level

isEnableMinuteLevel

public boolean isEnableMinuteLevel()

Enables the minute level

withEnableMinuteLevel

public DynamicDateFacet withEnableMinuteLevel(boolean enableMinuteLevel)

withEnableMinuteLevel

public DynamicDateFacet withEnableMinuteLevel(java.lang.Boolean enableMinuteLevel)

setEnableSecondLevel

public void setEnableSecondLevel(boolean enableSecondLevel)

Enables the second level

isEnableSecondLevel

public boolean isEnableSecondLevel()

Enables the second level

withEnableSecondLevel

public DynamicDateFacet withEnableSecondLevel(boolean enableSecondLevel)

withEnableSecondLevel

public DynamicDateFacet withEnableSecondLevel(java.lang.Boolean enableSecondLevel)

setEnableISO8601Compliance

public void setEnableISO8601Compliance(boolean enableISO8601Compliance)

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.

isEnableISO8601Compliance

public boolean isEnableISO8601Compliance()

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.

withEnableISO8601Compliance

public DynamicDateFacet withEnableISO8601Compliance(boolean enableISO8601Compliance)

withEnableISO8601Compliance

public DynamicDateFacet withEnableISO8601Compliance(java.lang.Boolean enableISO8601Compliance)

setGenerateMissingIntervals

public void setGenerateMissingIntervals(boolean generateMissingIntervals)

Generates missing dates setting their count to 0 and aggregation values to NO_VALUE

isGenerateMissingIntervals

public boolean isGenerateMissingIntervals()

Generates missing dates setting their count to 0 and aggregation values to NO_VALUE

withGenerateMissingIntervals

public DynamicDateFacet withGenerateMissingIntervals(boolean generateMissingIntervals)

withGenerateMissingIntervals

public DynamicDateFacet withGenerateMissingIntervals(java.lang.Boolean generateMissingIntervals)

makeCopy

public DynamicDateFacet makeCopy()

Creates and returns a deep copy of this DynamicDateFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

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

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

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DynamicDateFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicDateFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this DynamicDateFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

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(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