ch.agent.t2.applied

Class Week

java.lang.Object

ch.agent.t2.time.Time2

ch.agent.t2.applied.Week

All Implemented Interfaces:

TimeIndex, Comparable<TimeIndex>

public class Week
extends Time2

A Week is a Time2 with day resolution and a cycle of 6 days OFF and 1 day ON. The ON day is Thursday. This means that when creating a Week using a date other than a Thursday, the Adjustment is important. An UP adjustment will advance to the next Thursday and a DOWN adjustment will backtrack to the previous one.

Using Thursday to identify weeks has advantages. This is a quote from a Wikipedia article on ISO 8601, the international date standard:

The week number can be described by counting the Thursdays: week 12 contains the 12th Thursday of the year.

The domain label is weekly.

Author:

Jean-Paul Vetterli

Field Summary

Fields

Modifier and Type	Field and Description
static TimeDomain	DOMAIN A constant holding the domain.
static String	LABEL A constant holding the domain label.

Constructor Summary

Constructors

Constructor and Description
Week(long year, int month, int day, Adjustment adjust) Construct a weekly time from the given time components.
Week(String date, Adjustment adjust) Construct a weekly time from a string.
Week(TimeIndex time) Construct a weekly time from another time object.

Method Summary

Methods inherited from class ch.agent.t2.time.Time2

add, asLong, asOffset, compareTo, convert, convert, equals, getDay, getDayByRank, getDayOfWeek, getFractionalSecond, getHour, getMinute, getMonth, getSecond, getTimeDomain, getYear, hashCode, sub, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

LABEL

public static final String LABEL

A constant holding the domain label.

See Also:

Constant Field Values

DOMAIN

public static final TimeDomain DOMAIN

A constant holding the domain.

Constructor Detail

Week

public Week(TimeIndex time)
     throws T2Exception

Construct a weekly time from another time object.

Parameters:

time - a non-null time in the domain weekly

Throws:

T2Exception

Week

public Week(String date,
            Adjustment adjust)
     throws T2Exception

Construct a weekly time from a string.

Parameters:

date - a non-null string

adjust - a non-null adjustment mode

Throws:

T2Exception

Week

public Week(long year,
            int month,
            int day,
            Adjustment adjust)
     throws T2Exception

Construct a weekly time from the given time components.

Parameters:

year - a non-negative number

month - a number in [1-12]

day - a number between 1 and the last day of the month

adjust - a non-null adjustment mode

Throws:

T2Exception