src

Class EventClock

java.lang.Object

javax.swing.SwingWorker<java.lang.Integer,java.lang.String>

src.GenericClock

src.EventClock

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<java.lang.Integer>, java.util.concurrent.RunnableFuture<java.lang.Integer>

public class EventClock
extends GenericClock

GenericClock that controls the schedule and deploymend ot the Events. EventClock extends GenericClock class. It implementes a set of methods specially designed to handle the events, like pop-up creation and ignoring-forcing events execution.

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

javax.swing.SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	eventInProgress Flag to indicate if there are actually events in progress.
(package private) javax.swing.JLabel	eventLabel Second label attached to this clock, used to provide feedback about events status.
(package private) java.util.ArrayList<java.lang.Integer>	eventsToLaunch List of event IDs to be fired inmediately, of both types.
(package private) GenericPopUp	informationPopUp Pop-up to show information about events.
(package private) boolean	isPopUpVisible Pop-up behaviour control variables.
(package private) java.util.ArrayList<Event>	newAddedEvents List of events created in execution time (while app is 'working').
(package private) java.util.ArrayList<java.lang.Integer>	nextPXE List of 'periodicalExecutionEvents' with the smallest 'timeToLaunch'.
(package private) java.util.ArrayList<java.lang.Integer>	nextSXE List of 'singleExecutionEvents' with the smallest 'timeToLaunch'.
(package private) java.util.ArrayList<Event>	periodExecutionEventList List of events with periodical execution.
(package private) boolean	playSound Pop-up behaviour control variable.
(package private) boolean	popUpInFront Pop-up behaviour control variable.
(package private) java.util.ArrayList<Event>	singleExecutionEventList List of events with a single execution (fixed time of execution).
(package private) java.lang.String	singleExecutionInformation Summarized textual data about loaded SXE.
(package private) SoundLoader	soundLoader MIDI sound (file) handler.
(package private) int	timeToEventEnd Internal clock counters
(package private) int	timeToNextEvent Internal clock counters

Fields inherited from class src.GenericClock

clockToPrint, clockToPrintBlink, hour, label, minute, paused, second, stopped

Constructor Summary

Constructors

Constructor and Description
EventClock(javax.swing.JLabel timeLabel, javax.swing.JLabel eventLabel) Initializes EventClock.

Method Summary

Modifier and Type	Method and Description
private void	addNewEvents() Add events created during execution time to its proper list.
private void	calculateSingleExecutions() Calculate 'timeToLaunch' of each SXE.
private void	closePopUp() Hide the pop-up.
protected java.lang.Integer	doInBackground() Core functionality of EventClock.
private void	endEvent() Apply changes to clock in order to make the end of an event effective.
private void	eraseData() Clears internal data of the EventClock.
void	forceEvent() Forces the start of next events to be deployed.
private void	generateSingleExecutionInformation() Generates textual summary about the Single Execution Events loaded.
boolean	getEventInProgress()
java.util.ArrayList<Event>	getNewAddedEvents()
java.util.ArrayList<Event>	getPXE()
java.util.ArrayList<Event>	getSXE()
private java.lang.String	getSXEInfo() Obtain information about the SXE being executed.
void	ignoreEvent() Avoids the execution of an event, or forces it to end inmediately.
void	loadConfiguration(ConfigLoader configuration) Loads the configuration into the EventClock.
private void	searchNextEvent() Search the next events to be deployed.
private int	searchShortestEvent(java.util.ArrayList<Event> listOfEvents) Searchs in the specified list the event with shortest 'timeToLaunch'.
private void	setClock(int seconds) Establish clock time.
private void	setPXEInfo() Sends to pop-up information regards to the Periodical Execution Events.
void	showPopUp() Make the pop-up visible with the information about the events.
void	stopClock() Stops EventClock.
private void	triggerEvent(Flags.EventType eventType) Executes operations related to the start of an event or events.
protected void	updateClock() Updates EventClock time, decreasing its value.
private void	updateEvents(Flags.EventType eventType) Updates event 'timeToLaunch' value.
private void	updateLabels() Updates time label and event label to depict current situation.
private void	waitEventEnd() Decrease 'timeToEventEnd' value by one until it reaches 0.

Methods inherited from class src.GenericClock

pauseClock, printClock, startClock

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, done, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

periodExecutionEventList

java.util.ArrayList<Event> periodExecutionEventList

List of events with periodical execution. Events in this list are executed several times in a day. Its periods are usually very small (avg. 15 min).

singleExecutionEventList

java.util.ArrayList<Event> singleExecutionEventList

List of events with a single execution (fixed time of execution). Events in this list has 'startingTimes' of execution, meaning they only executes at a certain time. Their periods are equal to 24 hours.

newAddedEvents

java.util.ArrayList<Event> newAddedEvents

List of events created in execution time (while app is 'working'). By 'working' shall be understand the state of the application between the first Play button pressing and the Stop button pressing. This allows user to add events to be deployed and scheduled without stopping the application and loading a different set of events.

eventsToLaunch

java.util.ArrayList<java.lang.Integer> eventsToLaunch

List of event IDs to be fired inmediately, of both types. When updating the event timers, a situation when several Events shall start at the same time its possible (when timeToLaunch' reaches 0). The list stores both types of events (single and periodical execution). IDs are stored instead of Events to use less resources (integers are handled in a easier way).

nextPXE

java.util.ArrayList<java.lang.Integer> nextPXE

List of 'periodicalExecutionEvents' with the smallest 'timeToLaunch'. These events contains the smallest time to launch, and thus, will be the next ones to be fired (as soon as their time to launch reachs 0).

nextSXE

java.util.ArrayList<java.lang.Integer> nextSXE

List of 'singleExecutionEvents' with the smallest 'timeToLaunch'. These events contains the smallest time to launch, and thus, will be the next ones to be fired (as soon as their time to launch reachs 0).

eventLabel

javax.swing.JLabel eventLabel

Second label attached to this clock, used to provide feedback about events status. It is modified by the clock operations.

informationPopUp

GenericPopUp informationPopUp

Pop-up to show information about events. Permanent pop-Up, hidden or shown, with the information about: - Next PXE to be deployed OR current PXE in progress. - Single execution events.

timeToNextEvent

int timeToNextEvent

Internal clock counters. - 'timeToNextEvent' controls remain seconds to the start of next event. - 'timeToEventEnd' controls remain seconds to the end of current active events (its value concur with the biggest duration of the active events).

timeToEventEnd

int timeToEventEnd

Internal clock counters. - 'timeToNextEvent' controls remain seconds to the start of next event. - 'timeToEventEnd' controls remain seconds to the end of current active events (its value concur with the biggest duration of the active events).

singleExecutionInformation

java.lang.String singleExecutionInformation

Summarized textual data about loaded SXE. This information will be shown always in the 'eventPopUp' (it is permanent information that can be checked when pressing 'see' button in MainWindow).

eventInProgress

boolean eventInProgress

Flag to indicate if there are actually events in progress.

soundLoader

SoundLoader soundLoader

MIDI sound (file) handler.

isPopUpVisible

boolean isPopUpVisible

Pop-up behaviour control variables. Controls the visibility of the current active pop-up.

playSound

boolean playSound

Pop-up behaviour control variable. Controls if sound shall be played when pop-ups appear.

popUpInFront

boolean popUpInFront

Pop-up behaviour control variable. Controls if pop-up shall apear in front or in background.

Constructor Detail

EventClock

public EventClock(javax.swing.JLabel timeLabel,
                  javax.swing.JLabel eventLabel)

Initializes EventClock. EventClock needs two labels: one to print time values, and the other to print information about the events (next events or current events).

Parameters:

timeLabel - label to print time values (hour, minutes and seconds).

eventLabel - label to print information about the event or events.

Method Detail

loadConfiguration

public void loadConfiguration(ConfigLoader configuration)

Loads the configuration into the EventClock. Configuration is composed by: - Set of events to schedule an deploy. - Environment behaviour control options (paying sounds, position of the pop-ups and behaviour of the Working Time Clock).

Parameters:

configuration - configuration to be loaded of ConfigLoader type.

generateSingleExecutionInformation

private void generateSingleExecutionInformation()

Generates textual summary about the Single Execution Events loaded. Summary text is composed by events starting hours and titles.

updateEvents

private void updateEvents(Flags.EventType eventType)

Updates event 'timeToLaunch' value. Events to be updated are specified by input parameter. Update operation consist in decrease 'timeToLaunch' value by one -one less second to the start of the event-. If an event reachs value zero, it is added to 'eventsToLaunch' list.

Parameters:

eventType - type of events to be updated (specifides the list of events to be iterated).

triggerEvent

private void triggerEvent(Flags.EventType eventType)

Executes operations related to the start of an event or events. Method triggers both visual operations (showing the pop-up) and logical operations, as status changes.

Parameters:

eventType - type of event being started.

setPXEInfo

private void setPXEInfo()

Sends to pop-up information regards to the Periodical Execution Events. Text format depends on the status of the events: - If there are events currently in progress, these are shown. - If there are no events in progress, next ones to be executed are shown.

getSXEInfo

private java.lang.String getSXEInfo()

Obtain information about the SXE being executed.

Returns:

textual information about the SXE being executed.

showPopUp

public void showPopUp()

Make the pop-up visible with the information about the events. Pop-up shall appear in frontground or background depends on the user selected configuration.

closePopUp

private void closePopUp()

Hide the pop-up.

searchNextEvent

private void searchNextEvent()

Search the next events to be deployed. Events with shortest 'timeToLaunch' are the next ones in the 'queue' to be deployed.

updateLabels

private void updateLabels()

Updates time label and event label to depict current situation. Text of both labels is updated, showing summarized information about: - Events to be deployed (time and number). - Current events in progress (time and number).

searchShortestEvent

private int searchShortestEvent(java.util.ArrayList<Event> listOfEvents)

Searchs in the specified list the event with shortest 'timeToLaunch'.

Parameters:

listOfEvents - list of events to iterate over.

Returns:

event with the shortest 'timeToLaunch'.

setClock

private void setClock(int seconds)

Establish clock time. Clock is set to a certain hour, minute and second. This time is represented by the equivalent amount of seconds.

Parameters:

seconds - number of seconds that represents the clock time.

waitEventEnd

private void waitEventEnd()

Decrease 'timeToEventEnd' value by one until it reaches 0. When 'timeToEventEnd' reachs 0 value, the method 'endEvent' is executed.

endEvent

private void endEvent()

Apply changes to clock in order to make the end of an event effective. This method restart several variables and give visual feedback about the completion of the events in progress.

updateClock

protected void updateClock()

Updates EventClock time, decreasing its value. Update operation decreases time value by one second. EventClock time represents remaining seconds to the starting of an event, so it shall be decreased over time. This method overrides the functionality of 'updateClock()' method from GenericClock class.

Overrides:

updateClock in class GenericClock

See Also:

GenericClock, GenericClock.updateClock()

ignoreEvent

public void ignoreEvent()

Avoids the execution of an event, or forces it to end inmediately. This method ignores current event in progress, ending them, or next events to be scheduled, cancelling its execution (event is 'jumped')

forceEvent

public void forceEvent()

Forces the start of next events to be deployed. Next events to be deployed start inmediately, no matter how many seconds remains until its activation.

eraseData

private void eraseData()

Clears internal data of the EventClock. This method returns the clock to its initial state (variables are restored to default values, same as constructor does).

calculateSingleExecutions

private void calculateSingleExecutions()

Calculate 'timeToLaunch' of each SXE. 'timeToLaunch' of SXE depends on the current system time. This value is calculated and then assigned.

addNewEvents

private void addNewEvents()

Add events created during execution time to its proper list. Events created while clocks are running are added to the proper list, being scheduled and deployed normally.

stopClock

public void stopClock()

Stops EventClock. EventClock internal data is erased and its behaviour is modified in order to finish all of its internal operations. This methods overrides the functionality of 'stopClock()' method of GenericClock class.

Overrides:

stopClock in class GenericClock

See Also:

GenericClock, GenericClock.stopClock()

doInBackground

protected java.lang.Integer doInBackground()
                                    throws java.lang.Exception

Core functionality of EventClock. It implements the loop operations executed by the EventClock. The method overrides the functionality of 'doInBackground()' method of SwingWorker class.

Overrides:

doInBackground in class GenericClock

Returns:

time value.

Throws:

java.lang.Exception - SwingWorker inherited exception.

See Also:

SwingWorker, SwingWorker.doInBackground()

getEventInProgress

public boolean getEventInProgress()

Returns:

True if there are events in progress.

getNewAddedEvents

public java.util.ArrayList<Event> getNewAddedEvents()

Returns:

ArrayList of new events to be added in execution time.

getPXE

public java.util.ArrayList<Event> getPXE()

Returns:

ArrayList of Periodical Execution Events loaded in the app.

getSXE

public java.util.ArrayList<Event> getSXE()

Returns:

ArrayList of Single Execution Events loaded in the app.