src

Class Event

java.lang.Object

src.Event

public class Event
extends java.lang.Object

Activity to be scheduled and deployed during the application execution. An event is an action -like stand up or walk- that takes place in a certain time, with details attached to it like description, duration and period. Event objective is to reduce or avoid health issues related to long periods of computing use.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	description Detailed description of the event.
(package private) int	duration Duration -in seconds- of the event.
(package private) int	period Time -in seconds- it takes to repeat the event.
(package private) int	startingHour Decomposition of the 'startingTime' in hours, minutes and seconds.
(package private) int	startingMinute Decomposition of the 'startingTime' in hours, minutes and seconds.
(package private) int	startingSecond Decomposition of the 'startingTime' in hours, minutes and seconds.
(package private) boolean	startingTime Establishes if the event shall be executed only at a certain time.
(package private) int	timeToLaunch Remaining time -in seconds- until event starts.
(package private) java.lang.String	title Title of the event, short and accurate.

Constructor Summary

Constructors

Constructor and Description
Event(Event e) Creates event from an existing one.
Event(java.lang.String title, java.lang.String description, int period, int duration, boolean startingTime, int startingHour, int startingMinute, int startingSecond) Creates an Event.

Method Summary

Modifier and Type	Method and Description
void	decreaseTTL() Decreases TimeToLaunch (TTL) value in one unit.
java.lang.String	getDescription()
int	getDuration()
int	getPeriod()
int	getStartingHour()
int	getStartingMin()
int	getStartingSecond()
boolean	getStartingTime()
int	getTimeToLaunch()
java.lang.String	getTitle()
void	restartTimeToLaunch() Restarts 'timeToLaunch' to its initial value, equal to event's period.
void	setPeriod(int period) Modifies event's period value.
void	setTimeToLaunch(int currentTime) Modifies 'timeToLaunch' value.

Methods inherited from class java.lang.Object

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

Field Detail

title

java.lang.String title

Title of the event, short and accurate.

description

java.lang.String description

Detailed description of the event.

period

int period

Time -in seconds- it takes to repeat the event.

duration

int duration

Duration -in seconds- of the event.

timeToLaunch

int timeToLaunch

Remaining time -in seconds- until event starts. This variable is used to control the execution of the events (when it reaches 0, it means that the event has fulfilled another iteration of its period, and must be launched).

startingTime

boolean startingTime

Establishes if the event shall be executed only at a certain time. If 'true', event period is 24 hours, meaning that it only fires once each 24 hours.

startingHour

int startingHour

Decomposition of the 'startingTime' in hours, minutes and seconds. Decomposition in 24 hour digital format. Minimal value is 0:0:0 and maximun is 23:59:59.

startingMinute

int startingMinute

Decomposition of the 'startingTime' in hours, minutes and seconds. Decomposition in 24 hour digital format. Minimal value is 0:0:0 and maximun is 23:59:59.

startingSecond

int startingSecond

Decomposition of the 'startingTime' in hours, minutes and seconds. Decomposition in 24 hour digital format. Minimal value is 0:0:0 and maximun is 23:59:59.

Constructor Detail

Event

public Event(java.lang.String title,
             java.lang.String description,
             int period,
             int duration,
             boolean startingTime,
             int startingHour,
             int startingMinute,
             int startingSecond)

Creates an Event.

Parameters:

title - title of the event.

description - description of the event.

period - in seconds, period of the event (how often it occurs).

duration - in seconds, duration of the event.

startingTime - True if event shall start at a specific time.

startingHour - specific starting hour (0 to 23).

startingMinute - specific starting minute (0 to 59).

startingSecond - specific starting second (0 to 59).

Event

public Event(Event e)

Creates event from an existing one. The created event is a copy of the one passed as argument.

Parameters:

e - original event to be copied in the created one.

Method Detail

decreaseTTL

public void decreaseTTL()

Decreases TimeToLaunch (TTL) value in one unit. TimeToLaunch represents the number of seconds until the event shall be fired. This method decreases its value in one unit, simulating the pass of one second.

restartTimeToLaunch

public void restartTimeToLaunch()

Restarts 'timeToLaunch' to its initial value, equal to event's period. 'timeToLaunch' value get restarted each time it reachs 0 value (thats it, each time the event is fired, meaning another period iteration has been fullfiled).

getTitle

public java.lang.String getTitle()

Returns:

title of the event.

getPeriod

public int getPeriod()

Returns:

period of the event.

getDuration

public int getDuration()

Returns:

duration of the event.

getTimeToLaunch

public int getTimeToLaunch()

Returns:

'timeToLaunch' value.

getDescription

public java.lang.String getDescription()

Returns:

description of the event.

getStartingTime

public boolean getStartingTime()

Returns:

true if event has a starting time.

getStartingHour

public int getStartingHour()

Returns:

starting hour value.

getStartingMin

public int getStartingMin()

Returns:

starting minute value.

getStartingSecond

public int getStartingSecond()

Returns:

starting second value.

setTimeToLaunch

public void setTimeToLaunch(int currentTime)

Modifies 'timeToLaunch' value.

Parameters:

currentTime - value to be assigned to 'timeToLaunch'.

setPeriod

public void setPeriod(int period)

Modifies event's period value.

Parameters:

period - value to be assigned to the period.