com.exalead.search.v30

Class DateFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.DateFacet

All Implemented Interfaces:

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

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

Configuration for a facet.

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
boolean	afterEnd
boolean	beforeStart
boolean	dayDesc
static boolean	DEFAULT_AFTER_END
static boolean	DEFAULT_BEFORE_START
static boolean	DEFAULT_DAY_DESC
static java.lang.String	DEFAULT_END_EXPR
static boolean	DEFAULT_HOUR_DESC
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH
static int	DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT
static boolean	DEFAULT_MINUTE_DESC
static boolean	DEFAULT_MONTH_DESC
static boolean	DEFAULT_SECOND_DESC
static java.lang.String	DEFAULT_START_EXPR
static int	DEFAULT_USE_AS_FIRST_LEVEL
static boolean	DEFAULT_WEEK_DESC
static boolean	DEFAULT_WITH_DAY
static boolean	DEFAULT_WITH_HOUR
static boolean	DEFAULT_WITH_MINUTE
static boolean	DEFAULT_WITH_MONTH
static boolean	DEFAULT_WITH_SECOND
static boolean	DEFAULT_WITH_WEEK
static boolean	DEFAULT_WITH_YEAR
static boolean	DEFAULT_YEAR_DESC
java.lang.String	endExpr
java.lang.String	expr
boolean	hourDesc
int	maxCategoryTreeDepth
int	maxCategoryTreeDepthFromRoot
boolean	minuteDesc
boolean	monthDesc
boolean	secondDesc
java.lang.String	startExpr
int	useAsFirstLevel
boolean	weekDesc
boolean	withDay
boolean	withHour
boolean	withMinute
boolean	withMonth
boolean	withSecond
boolean	withWeek
boolean	withYear
boolean	yearDesc

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
DateFacet()
DateFacet(DateFacet o) Copy constructor
DateFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String expr)

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 DateFacet.
static DateFacet	fromString(java.lang.String s) String representation of this DateFacet.
java.lang.String	getEndExpr() A CONSTANT virtual expression that evaluates the time when the synthesis ends.
java.lang.String	getExpr() The date field or virtual expr on which the synthesis must be performed.
int	getMaxCategoryTreeDepth() Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).
int	getMaxCategoryTreeDepthFromRoot() Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level.
java.lang.String	getStartExpr() A CONSTANT virtual expression that evaluates the time when the synthesis starts (e.g.
int	getUseAsFirstLevel() Used internally by multidim refinements to tell which level is the first level below root.
boolean	isAfterEnd() Creates a virtual category for all dates after the end.
boolean	isBeforeStart() Creates a virtual category for all dates before the start.
boolean	isDayDesc()
boolean	isHourDesc()
boolean	isMinuteDesc()
boolean	isMonthDesc()
boolean	isSecondDesc()
boolean	isWeekDesc()
boolean	isWithDay() Creates a virtual category for each day.
boolean	isWithHour() Creates a virtual category for each hour.
boolean	isWithMinute() Creates a virtual category for each minute.
boolean	isWithMonth() Creates a virtual category for each month.
boolean	isWithSecond() Creates a virtual category for each second.
boolean	isWithWeek() Creates a virtual category for each week.
boolean	isWithYear() Creates a virtual category for each year.
boolean	isYearDesc()
DateFacet	makeCopy() Creates and returns a deep copy of this DateFacet.
static DateFacet	readFrom(java.io.InputStream is) Read this DateFacet from an XML fragment.
void	setAfterEnd(boolean afterEnd) Creates a virtual category for all dates after the end.
void	setBeforeStart(boolean beforeStart) Creates a virtual category for all dates before the start.
void	setDayDesc(boolean dayDesc)
void	setEndExpr(java.lang.String endExpr) A CONSTANT virtual expression that evaluates the time when the synthesis ends.
void	setExpr(java.lang.String expr) The date field or virtual expr on which the synthesis must be performed.
void	setHourDesc(boolean hourDesc)
void	setMaxCategoryTreeDepth(int maxCategoryTreeDepth) Maximum depth of the returned category tree. Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).
void	setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot) Maximum depth of the returned category tree, starting from the global root of the category. Setting this attribute to N means that no categories will be kept below this level.
void	setMinuteDesc(boolean minuteDesc)
void	setMonthDesc(boolean monthDesc)
void	setSecondDesc(boolean secondDesc)
void	setStartExpr(java.lang.String startExpr) A CONSTANT virtual expression that evaluates the time when the synthesis starts (e.g.
void	setUseAsFirstLevel(int useAsFirstLevel) Used internally by multidim refinements to tell which level is the first level below root.
void	setWeekDesc(boolean weekDesc)
void	setWithDay(boolean withDay) Creates a virtual category for each day.
void	setWithHour(boolean withHour) Creates a virtual category for each hour.
void	setWithMinute(boolean withMinute) Creates a virtual category for each minute.
void	setWithMonth(boolean withMonth) Creates a virtual category for each month.
void	setWithSecond(boolean withSecond) Creates a virtual category for each second.
void	setWithWeek(boolean withWeek) Creates a virtual category for each week.
void	setWithYear(boolean withYear) Creates a virtual category for each year.
void	setYearDesc(boolean yearDesc)
java.lang.String	toString() String representation of this DateFacet.
DateFacet	withAdditionalFacetView(AdditionalFacetView... __values)
DateFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
DateFacet	withAfterEnd(boolean afterEnd)
DateFacet	withAfterEnd(java.lang.Boolean afterEnd)
DateFacet	withAggregateScores(boolean aggregateScores) Deprecated.
DateFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
DateFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
DateFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
DateFacet	withBeforeStart(boolean beforeStart)
DateFacet	withBeforeStart(java.lang.Boolean beforeStart)
DateFacet	withDataModelClass(java.lang.String dataModelClass)
DateFacet	withDataModelProperty(java.lang.String dataModelProperty)
DateFacet	withDataModelState(java.lang.String dataModelState)
DateFacet	withDayDesc(boolean dayDesc)
DateFacet	withDayDesc(java.lang.Boolean dayDesc)
DateFacet	withEndExpr(java.lang.String endExpr)
DateFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
DateFacet	withExpr(java.lang.String expr)
DateFacet	withFromDataModel(Facet fromDataModel)
DateFacet	withHourDesc(boolean hourDesc)
DateFacet	withHourDesc(java.lang.Boolean hourDesc)
DateFacet	withId(java.lang.String id)
DateFacet	withImplementation(java.lang.String implementation)
DateFacet	withIndex(int index)
DateFacet	withIndex(java.lang.Integer index)
DateFacet	withInHits(boolean inHits)
DateFacet	withInHits(java.lang.Boolean inHits)
DateFacet	withInNavigation(boolean inNavigation)
DateFacet	withInNavigation(java.lang.Boolean inNavigation)
DateFacet	withMaxCategories(int maxCategories)
DateFacet	withMaxCategories(java.lang.Integer maxCategories)
DateFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
DateFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
DateFacet	withMaxCategoryTreeDepth(int maxCategoryTreeDepth)
DateFacet	withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)
DateFacet	withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)
DateFacet	withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)
DateFacet	withMaxSliceCategories(int maxSliceCategories)
DateFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
DateFacet	withMinDocsPerCategory(int minDocsPerCategory)
DateFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
DateFacet	withMinuteDesc(boolean minuteDesc)
DateFacet	withMinuteDesc(java.lang.Boolean minuteDesc)
DateFacet	withMonthDesc(boolean monthDesc)
DateFacet	withMonthDesc(java.lang.Boolean monthDesc)
DateFacet	withRefinementPolicy(java.lang.String refinementPolicy)
DateFacet	withReverse(boolean reverse)
DateFacet	withReverse(java.lang.Boolean reverse)
DateFacet	withSecondDesc(boolean secondDesc)
DateFacet	withSecondDesc(java.lang.Boolean secondDesc)
DateFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
DateFacet	withSortFunction(java.lang.String sortFunction)
DateFacet	withStartExpr(java.lang.String startExpr)
DateFacet	withType(java.lang.String type)
DateFacet	withUseAsFirstLevel(int useAsFirstLevel)
DateFacet	withUseAsFirstLevel(java.lang.Integer useAsFirstLevel)
DateFacet	withVirtualRoot(java.lang.String virtualRoot)
DateFacet	withWeekDesc(boolean weekDesc)
DateFacet	withWeekDesc(java.lang.Boolean weekDesc)
DateFacet	withWithDay(boolean withDay)
DateFacet	withWithDay(java.lang.Boolean withDay)
DateFacet	withWithHour(boolean withHour)
DateFacet	withWithHour(java.lang.Boolean withHour)
DateFacet	withWithMinute(boolean withMinute)
DateFacet	withWithMinute(java.lang.Boolean withMinute)
DateFacet	withWithMonth(boolean withMonth)
DateFacet	withWithMonth(java.lang.Boolean withMonth)
DateFacet	withWithSecond(boolean withSecond)
DateFacet	withWithSecond(java.lang.Boolean withSecond)
DateFacet	withWithWeek(boolean withWeek)
DateFacet	withWithWeek(java.lang.Boolean withWeek)
DateFacet	withWithYear(boolean withYear)
DateFacet	withWithYear(java.lang.Boolean withYear)
DateFacet	withYearDesc(boolean yearDesc)
DateFacet	withYearDesc(java.lang.Boolean yearDesc)
void	writeTo(java.io.OutputStream os) Write this DateFacet 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

startExpr

public java.lang.String startExpr

DEFAULT_START_EXPR

public static final java.lang.String DEFAULT_START_EXPR

See Also:

Constant Field Values

endExpr

public java.lang.String endExpr

DEFAULT_END_EXPR

public static final java.lang.String DEFAULT_END_EXPR

See Also:

Constant Field Values

beforeStart

public boolean beforeStart

DEFAULT_BEFORE_START

public static final boolean DEFAULT_BEFORE_START

See Also:

Constant Field Values

afterEnd

public boolean afterEnd

DEFAULT_AFTER_END

public static final boolean DEFAULT_AFTER_END

See Also:

Constant Field Values

withYear

public boolean withYear

DEFAULT_WITH_YEAR

public static final boolean DEFAULT_WITH_YEAR

See Also:

Constant Field Values

yearDesc

public boolean yearDesc

DEFAULT_YEAR_DESC

public static final boolean DEFAULT_YEAR_DESC

See Also:

Constant Field Values

withMonth

public boolean withMonth

DEFAULT_WITH_MONTH

public static final boolean DEFAULT_WITH_MONTH

See Also:

Constant Field Values

monthDesc

public boolean monthDesc

DEFAULT_MONTH_DESC

public static final boolean DEFAULT_MONTH_DESC

See Also:

Constant Field Values

withWeek

public boolean withWeek

DEFAULT_WITH_WEEK

public static final boolean DEFAULT_WITH_WEEK

See Also:

Constant Field Values

weekDesc

public boolean weekDesc

DEFAULT_WEEK_DESC

public static final boolean DEFAULT_WEEK_DESC

See Also:

Constant Field Values

withDay

public boolean withDay

DEFAULT_WITH_DAY

public static final boolean DEFAULT_WITH_DAY

See Also:

Constant Field Values

dayDesc

public boolean dayDesc

DEFAULT_DAY_DESC

public static final boolean DEFAULT_DAY_DESC

See Also:

Constant Field Values

withHour

public boolean withHour

DEFAULT_WITH_HOUR

public static final boolean DEFAULT_WITH_HOUR

See Also:

Constant Field Values

hourDesc

public boolean hourDesc

DEFAULT_HOUR_DESC

public static final boolean DEFAULT_HOUR_DESC

See Also:

Constant Field Values

withMinute

public boolean withMinute

DEFAULT_WITH_MINUTE

public static final boolean DEFAULT_WITH_MINUTE

See Also:

Constant Field Values

minuteDesc

public boolean minuteDesc

DEFAULT_MINUTE_DESC

public static final boolean DEFAULT_MINUTE_DESC

See Also:

Constant Field Values

withSecond

public boolean withSecond

DEFAULT_WITH_SECOND

public static final boolean DEFAULT_WITH_SECOND

See Also:

Constant Field Values

secondDesc

public boolean secondDesc

DEFAULT_SECOND_DESC

public static final boolean DEFAULT_SECOND_DESC

See Also:

Constant Field Values

useAsFirstLevel

public int useAsFirstLevel

DEFAULT_USE_AS_FIRST_LEVEL

public static final int DEFAULT_USE_AS_FIRST_LEVEL

See Also:

Constant Field Values

maxCategoryTreeDepth

public int maxCategoryTreeDepth

DEFAULT_MAX_CATEGORY_TREE_DEPTH

public static final int DEFAULT_MAX_CATEGORY_TREE_DEPTH

See Also:

Constant Field Values

maxCategoryTreeDepthFromRoot

public int maxCategoryTreeDepthFromRoot

DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT

public static final int DEFAULT_MAX_CATEGORY_TREE_DEPTH_FROM_ROOT

See Also:

Constant Field Values

Constructor Detail

DateFacet

public DateFacet()

DateFacet

public DateFacet(java.lang.String id,
                 java.lang.String virtualRoot,
                 java.lang.String expr)

DateFacet

public DateFacet(DateFacet o)

Copy constructor

Method Detail

withVirtualRoot

public DateFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public DateFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public DateFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public DateFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public DateFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public DateFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public DateFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public DateFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public DateFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public DateFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public DateFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public DateFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public DateFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public DateFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public DateFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public DateFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public DateFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public DateFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public DateFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public DateFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public DateFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public DateFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public DateFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public DateFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public DateFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public DateFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public DateFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public DateFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public DateFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public DateFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public DateFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

@Deprecated
public DateFacet 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 on which the synthesis must be performed.

getExpr

public java.lang.String getExpr()

The date field or virtual expr on which the synthesis must be performed.

withExpr

public DateFacet withExpr(java.lang.String expr)

setStartExpr

public void setStartExpr(java.lang.String startExpr)

A CONSTANT virtual expression that evaluates the time when the synthesis starts (e.g. #now(), #fromunixts(1304865423) or #datetime(1983,2,28)).

getStartExpr

public java.lang.String getStartExpr()

A CONSTANT virtual expression that evaluates the time when the synthesis starts (e.g. #now(), #fromunixts(1304865423) or #datetime(1983,2,28)).

withStartExpr

public DateFacet withStartExpr(java.lang.String startExpr)

setEndExpr

public void setEndExpr(java.lang.String endExpr)

A CONSTANT virtual expression that evaluates the time when the synthesis ends.

getEndExpr

public java.lang.String getEndExpr()

A CONSTANT virtual expression that evaluates the time when the synthesis ends.

withEndExpr

public DateFacet withEndExpr(java.lang.String endExpr)

setBeforeStart

public void setBeforeStart(boolean beforeStart)

Creates a virtual category for all dates before the start.

isBeforeStart

public boolean isBeforeStart()

Creates a virtual category for all dates before the start.

withBeforeStart

public DateFacet withBeforeStart(boolean beforeStart)

withBeforeStart

public DateFacet withBeforeStart(java.lang.Boolean beforeStart)

setAfterEnd

public void setAfterEnd(boolean afterEnd)

Creates a virtual category for all dates after the end.

isAfterEnd

public boolean isAfterEnd()

Creates a virtual category for all dates after the end.

withAfterEnd

public DateFacet withAfterEnd(boolean afterEnd)

withAfterEnd

public DateFacet withAfterEnd(java.lang.Boolean afterEnd)

setWithYear

public void setWithYear(boolean withYear)

Creates a virtual category for each year.

isWithYear

public boolean isWithYear()

Creates a virtual category for each year.

withWithYear

public DateFacet withWithYear(boolean withYear)

withWithYear

public DateFacet withWithYear(java.lang.Boolean withYear)

setYearDesc

public void setYearDesc(boolean yearDesc)

isYearDesc

public boolean isYearDesc()

withYearDesc

public DateFacet withYearDesc(boolean yearDesc)

withYearDesc

public DateFacet withYearDesc(java.lang.Boolean yearDesc)

setWithMonth

public void setWithMonth(boolean withMonth)

Creates a virtual category for each month.

isWithMonth

public boolean isWithMonth()

Creates a virtual category for each month.

withWithMonth

public DateFacet withWithMonth(boolean withMonth)

withWithMonth

public DateFacet withWithMonth(java.lang.Boolean withMonth)

setMonthDesc

public void setMonthDesc(boolean monthDesc)

isMonthDesc

public boolean isMonthDesc()

withMonthDesc

public DateFacet withMonthDesc(boolean monthDesc)

withMonthDesc

public DateFacet withMonthDesc(java.lang.Boolean monthDesc)

setWithWeek

public void setWithWeek(boolean withWeek)

Creates a virtual category for each week.

isWithWeek

public boolean isWithWeek()

Creates a virtual category for each week.

withWithWeek

public DateFacet withWithWeek(boolean withWeek)

withWithWeek

public DateFacet withWithWeek(java.lang.Boolean withWeek)

setWeekDesc

public void setWeekDesc(boolean weekDesc)

isWeekDesc

public boolean isWeekDesc()

withWeekDesc

public DateFacet withWeekDesc(boolean weekDesc)

withWeekDesc

public DateFacet withWeekDesc(java.lang.Boolean weekDesc)

setWithDay

public void setWithDay(boolean withDay)

Creates a virtual category for each day.

isWithDay

public boolean isWithDay()

Creates a virtual category for each day.

withWithDay

public DateFacet withWithDay(boolean withDay)

withWithDay

public DateFacet withWithDay(java.lang.Boolean withDay)

setDayDesc

public void setDayDesc(boolean dayDesc)

isDayDesc

public boolean isDayDesc()

withDayDesc

public DateFacet withDayDesc(boolean dayDesc)

withDayDesc

public DateFacet withDayDesc(java.lang.Boolean dayDesc)

setWithHour

public void setWithHour(boolean withHour)

Creates a virtual category for each hour.

isWithHour

public boolean isWithHour()

Creates a virtual category for each hour.

withWithHour

public DateFacet withWithHour(boolean withHour)

withWithHour

public DateFacet withWithHour(java.lang.Boolean withHour)

setHourDesc

public void setHourDesc(boolean hourDesc)

isHourDesc

public boolean isHourDesc()

withHourDesc

public DateFacet withHourDesc(boolean hourDesc)

withHourDesc

public DateFacet withHourDesc(java.lang.Boolean hourDesc)

setWithMinute

public void setWithMinute(boolean withMinute)

Creates a virtual category for each minute.

isWithMinute

public boolean isWithMinute()

Creates a virtual category for each minute.

withWithMinute

public DateFacet withWithMinute(boolean withMinute)

withWithMinute

public DateFacet withWithMinute(java.lang.Boolean withMinute)

setMinuteDesc

public void setMinuteDesc(boolean minuteDesc)

isMinuteDesc

public boolean isMinuteDesc()

withMinuteDesc

public DateFacet withMinuteDesc(boolean minuteDesc)

withMinuteDesc

public DateFacet withMinuteDesc(java.lang.Boolean minuteDesc)

setWithSecond

public void setWithSecond(boolean withSecond)

Creates a virtual category for each second.

isWithSecond

public boolean isWithSecond()

Creates a virtual category for each second.

withWithSecond

public DateFacet withWithSecond(boolean withSecond)

withWithSecond

public DateFacet withWithSecond(java.lang.Boolean withSecond)

setSecondDesc

public void setSecondDesc(boolean secondDesc)

isSecondDesc

public boolean isSecondDesc()

withSecondDesc

public DateFacet withSecondDesc(boolean secondDesc)

withSecondDesc

public DateFacet withSecondDesc(java.lang.Boolean secondDesc)

setUseAsFirstLevel

public void setUseAsFirstLevel(int useAsFirstLevel)

Used internally by multidim refinements to tell which level is the first level below root.

getUseAsFirstLevel

public int getUseAsFirstLevel()

Used internally by multidim refinements to tell which level is the first level below root.

withUseAsFirstLevel

public DateFacet withUseAsFirstLevel(int useAsFirstLevel)

withUseAsFirstLevel

public DateFacet withUseAsFirstLevel(java.lang.Integer useAsFirstLevel)

setMaxCategoryTreeDepth

public void setMaxCategoryTreeDepth(int maxCategoryTreeDepth)

Maximum depth of the returned category tree.
Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).

getMaxCategoryTreeDepth

public int getMaxCategoryTreeDepth()

Maximum depth of the returned category tree.
Whatever the level of refinement, there will never be more levels retrieved (this ensures we are not overtaking the maxCategoryTreeDepthFromRoot).

withMaxCategoryTreeDepth

public DateFacet withMaxCategoryTreeDepth(int maxCategoryTreeDepth)

withMaxCategoryTreeDepth

public DateFacet withMaxCategoryTreeDepth(java.lang.Integer maxCategoryTreeDepth)

setMaxCategoryTreeDepthFromRoot

public void setMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

Maximum depth of the returned category tree, starting from the global root of the category.
Setting this attribute to N means that no categories will be kept below this level.

getMaxCategoryTreeDepthFromRoot

public int getMaxCategoryTreeDepthFromRoot()

Maximum depth of the returned category tree, starting from the global root of the category.
Setting this attribute to N means that no categories will be kept below this level.

withMaxCategoryTreeDepthFromRoot

public DateFacet withMaxCategoryTreeDepthFromRoot(int maxCategoryTreeDepthFromRoot)

withMaxCategoryTreeDepthFromRoot

public DateFacet withMaxCategoryTreeDepthFromRoot(java.lang.Integer maxCategoryTreeDepthFromRoot)

makeCopy

public DateFacet makeCopy()

Creates and returns a deep copy of this DateFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

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

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

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DateFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DateFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this DateFacet.

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