org.cesilko.rachota.core
Class Plan

java.lang.Object
  extended by org.cesilko.rachota.core.Plan

public class Plan
extends java.lang.Object

Plan containing all days that have some tasks planned. Plan also contains all regular tasks.


Method Summary
 void addDay(Day day)
          Adds new day to plan.
 void addRegularTask(RegularTask regularTask)
          Adds new regular task to plan.
 void addRegularTasks(Day day)
          Adds regular tasks to given day.
 void copyUnfinishedTasks()
          Copies all unfinished tasks from previous working day to today.
static void createBackup()
          Creates a backup copy of current diary.
 java.util.Vector getCategories()
          Returns all categories that were used to date.
 Day getDay(java.util.Date date)
          Returns day identified by given date.
 Day getDayAfter(Day day)
          Returns one day after given day.
 Day getDayBefore(Day day)
          Returns one day before given day.
 java.lang.String getDayID(java.util.Calendar calendar)
          Returns identification of day set in given calendar.
 java.util.Iterator getDays(int scale)
          Returns iterator of days according to given period scale.
static Plan getDefault()
          Returns the only available instance of plan.
 java.util.Vector getRegularTasks()
          Returns vector of all regular tasks.
 boolean isFuture(Day day)
          Checks if given day will be after today.
 boolean isToday(Day day)
          Checks if given day represents today.
static void loadPlan()
          Loads all planned days and history.
static void loadRegularTasks()
          Loads plan of regular tasks.
 void removeRegularTask(RegularTask regularTask)
          Removes existing regular task from plan.
static boolean savePlan()
          Saves all days to XML files.
static void saveRegularTasks()
          Saves all regular tasks.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDefault

public static Plan getDefault()
Returns the only available instance of plan.

Returns:
The only instance of Plan object in system.

addDay

public void addDay(Day day)
Adds new day to plan.

Parameters:
day - New day to be added to plan.

getDay

public Day getDay(java.util.Date date)
Returns day identified by given date.

Parameters:
date - Date that will be used to find the day.
Returns:
Day with given date.

getDayBefore

public Day getDayBefore(Day day)
Returns one day before given day.

Parameters:
day - Day whose predecessor should be found.
Returns:
Day before given day.

getDayAfter

public Day getDayAfter(Day day)
Returns one day after given day.

Parameters:
day - Day whose ancessor should be found.
Returns:
Day after given day.

getDays

public java.util.Iterator getDays(int scale)
Returns iterator of days according to given period scale.

Parameters:
scale - Period whose days to return. Either week or all time.
Returns:
Iterator of days from previous week or all days.

getDayID

public java.lang.String getDayID(java.util.Calendar calendar)
Returns identification of day set in given calendar.

Parameters:
calendar - Calendar preset to some day.
Returns:
Identification of day e.g. "2005_2_17"

isToday

public boolean isToday(Day day)
Checks if given day represents today.

Parameters:
day - Day that should be checked.
Returns:
True if given day represents today otherwise false.

isFuture

public boolean isFuture(Day day)
Checks if given day will be after today.

Parameters:
day - Day that should be checked.
Returns:
True if given day represents some day after today otherwise false.

addRegularTask

public void addRegularTask(RegularTask regularTask)
Adds new regular task to plan.

Parameters:
regularTask - New regular task to be added to plan.

removeRegularTask

public void removeRegularTask(RegularTask regularTask)
Removes existing regular task from plan.

Parameters:
regularTask - Regular task to be removed from plan.

getRegularTasks

public java.util.Vector getRegularTasks()
Returns vector of all regular tasks.

Returns:
Vector of all regular tasks.

createBackup

public static void createBackup()
Creates a backup copy of current diary.


savePlan

public static boolean savePlan()
Saves all days to XML files.

Returns:
True if plan was saved successfully, false otherwise

loadPlan

public static void loadPlan()
                     throws java.lang.Exception
Loads all planned days and history.

Throws:
java.lang.Exception - Exception thrown whenever any problem while loading plan occurs.

saveRegularTasks

public static void saveRegularTasks()
Saves all regular tasks.


loadRegularTasks

public static void loadRegularTasks()
                             throws java.lang.Exception
Loads plan of regular tasks.

Throws:
java.lang.Exception - Exception thrown whenever any problem while loading regular tasks occurs.

copyUnfinishedTasks

public void copyUnfinishedTasks()
Copies all unfinished tasks from previous working day to today.


addRegularTasks

public void addRegularTasks(Day day)
Adds regular tasks to given day.

Parameters:
day - Day to be extended for regular tasks.

getCategories

public java.util.Vector getCategories()
Returns all categories that were used to date.

Returns:
Vector of categories that were used to date.