com.gotjava.model.calendar
Class CalendarSpan

java.lang.Object
  |
  +--com.gotjava.model.calendar.CalendarSpan

public class CalendarSpan

extends java.lang.Object

A collection of CalendarEvents with the same span.

Field Summary

static int	DAY
protected java.util.Date	m_endDate
protected java.util.Vector	m_events
protected int	m_span
protected java.util.Date	m_startDate
static int	MONTH
static int	WEEK
static int	YEAR

Constructor Summary

CalendarSpan(int span, java.util.Date date)
Creates a CalendarSpan of type 'span' for the given date.

Method Summary

void	addEvent(CalendarEvent event) Add an event to the span
java.util.Date	getEndDate() get the span end date
CalendarEvent[]	getEvents() get all events within the span
int	getSpanType()
java.util.Date	getStartDate() get the span start date
java.util.Iterator	getSubSpan(int span)
boolean	inSpan(java.util.Date date) Determine if the given date is within the span

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

YEAR

public static final int YEAR

See Also:

Constant Field Values

MONTH

public static final int MONTH

See Also:

Constant Field Values

WEEK

public static final int WEEK

See Also:

Constant Field Values

DAY

public static final int DAY

See Also:

Constant Field Values

m_startDate

protected java.util.Date m_startDate

m_endDate

protected java.util.Date m_endDate

m_span

protected int m_span

m_events

protected java.util.Vector m_events

Constructor Detail

CalendarSpan

public CalendarSpan(int span,
                    java.util.Date date)

Creates a CalendarSpan of type 'span' for the given date. The start date of the span is INCLUSIVE and then end date is EXCLUSIVE. Therefore the span for the year 2003 would be 01/01/2003 00:00:00 - 01/01/2004 00:00:00. Week spans start on Sunday.

Parameters:

span - a valid span: YEAR, MONTH, WEEK, DAY

date - a date within the span

Method Detail

getStartDate

public java.util.Date getStartDate()

get the span start date

getEndDate

public java.util.Date getEndDate()

get the span end date

getEvents

public CalendarEvent[] getEvents()

get all events within the span

addEvent

public void addEvent(CalendarEvent event)

Add an event to the span

inSpan

public boolean inSpan(java.util.Date date)

Determine if the given date is within the span

getSpanType

public int getSpanType()

getSubSpan

public java.util.Iterator getSubSpan(int span)