Package org.apache.ofbiz.service.calendar

Class TemporalExpressions.Frequency

java.lang.Object

org.apache.ofbiz.service.calendar.TemporalExpression

org.apache.ofbiz.service.calendar.TemporalExpressions.Frequency

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TemporalExpression>

Enclosing class:

TemporalExpressions

public static class TemporalExpressions.Frequency
extends TemporalExpression

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

TemporalExpression.ExpressionContext

Field Summary

Fields

Modifier and Type	Field	Description
protected int	freqCount
protected int	freqType
static java.lang.String	module
protected java.util.Date	start

Fields inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

id, sequence

Constructor Summary

Constructors

Constructor	Description
Frequency(java.util.Date start, int freqType, int freqCount)

Method Summary

Modifier and Type	Method	Description
void	accept(TemporalExpressionVisitor visitor)	Handles a TemporalExpressionVisitor visit.
boolean	equals(java.lang.Object obj)
com.ibm.icu.util.Calendar	first(com.ibm.icu.util.Calendar cal)	Returns a date representing the first occurrence of this expression on or after a specified date.
int	getFreqCount()	Returns the frequency count of this expression.
int	getFreqType()	Returns the frequency type of this expression.
java.util.Date	getStartDate()	Returns the start date of this expression.
int	hashCode()
boolean	includesDate(com.ibm.icu.util.Calendar cal)	Returns true if this expression includes the specified date.
boolean	isSubstitutionCandidate(com.ibm.icu.util.Calendar cal, TemporalExpression expressionToTest)	Returns true if this expression is a candidate for substitution using the expression expressionToTest for the date cal.
com.ibm.icu.util.Calendar	next(com.ibm.icu.util.Calendar cal, TemporalExpression.ExpressionContext context)
protected com.ibm.icu.util.Calendar	prepareCal(com.ibm.icu.util.Calendar cal)
java.lang.String	toString()

Methods inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

compareTo, containsExpression, getId, getRange, next, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

module

public static final java.lang.String module

freqCount

protected final int freqCount

freqType

protected final int freqType

start

protected final java.util.Date start

Constructor Detail

Frequency

public Frequency(java.util.Date start,
                 int freqType,
                 int freqCount)

Parameters:

start - Starting date, defaults to current system time

freqType - One of the following integer values: Calendar.SECOND Calendar.MINUTE Calendar.HOUR Calendar.DAY_OF_MONTH Calendar.MONTH Calendar.YEAR

freqCount - A positive integer

Method Detail

accept

public void accept(TemporalExpressionVisitor visitor)

Description copied from class: TemporalExpression

Handles a TemporalExpressionVisitor visit.

Specified by:

accept in class TemporalExpression

hashCode

public int hashCode()

Overrides:

hashCode in class TemporalExpression

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class TemporalExpression

first

public com.ibm.icu.util.Calendar first(com.ibm.icu.util.Calendar cal)

Description copied from class: TemporalExpression

Returns a date representing the first occurrence of this expression on or after a specified date. Returns null if there is no matching date.

Specified by:

first in class TemporalExpression

Parameters:

cal - A date to evaluate

Returns:

A Calendar instance representing the first matching date, or null if no matching date is found

getFreqCount

public int getFreqCount()

Returns the frequency count of this expression.

Returns:

The frequency count of this expression

getFreqType

public int getFreqType()

Returns the frequency type of this expression.

Returns:

The frequency type of this expression

getStartDate

public java.util.Date getStartDate()

Returns the start date of this expression.

Returns:

The start date of this expression

includesDate

public boolean includesDate(com.ibm.icu.util.Calendar cal)

Description copied from class: TemporalExpression

Returns true if this expression includes the specified date.

Specified by:

includesDate in class TemporalExpression

Parameters:

cal - A date to evaluate

Returns:

true if this expression includes the date represented by cal

isSubstitutionCandidate

public boolean isSubstitutionCandidate(com.ibm.icu.util.Calendar cal,
                                       TemporalExpression expressionToTest)

Description copied from class: TemporalExpression

Returns true if this expression is a candidate for substitution using the expression expressionToTest for the date cal. A Substitution object will call this method when it needs to know if this expression could have produced the date cal based on the expression expressionToTest.

Specified by:

isSubstitutionCandidate in class TemporalExpression

Parameters:

cal - A date to evaluate

expressionToTest - An expression to evaluate

Returns:

true if this expression could have produced the date cal using the expression expressionToTest

next

public com.ibm.icu.util.Calendar next(com.ibm.icu.util.Calendar cal,
                                      TemporalExpression.ExpressionContext context)

Specified by:

next in class TemporalExpression

prepareCal

protected com.ibm.icu.util.Calendar prepareCal(com.ibm.icu.util.Calendar cal)

toString

public java.lang.String toString()

Overrides:

toString in class TemporalExpression