org.javades.jqueues.r5.util.predictor.workload

Class DefaultWorkloadSchedule

java.lang.Object

org.javades.jqueues.r5.event.map.DefaultSimEntityEventMap

org.javades.jqueues.r5.util.predictor.workload.DefaultWorkloadSchedule

All Implemented Interfaces:

SimEntityEventMap, WorkloadSchedule, WorkloadScheduleHandler

Direct Known Subclasses:

DefaultWorkloadSchedule_SQ_SV

public class DefaultWorkloadSchedule
extends DefaultSimEntityEventMap
implements WorkloadSchedule, WorkloadScheduleHandler

A default implementation of WorkloadSchedule.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Constructor Summary

Constructors

Constructor and Description
DefaultWorkloadSchedule(Map<Double,Set<E>> queueEvents) Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a map of SimJQEvents.
DefaultWorkloadSchedule(Set<? extends SimQueue> queues, Map<Double,Set<E>> queueEvents) Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a map of SimJQEvents.
DefaultWorkloadSchedule(Set<? extends SimQueue> queues, Set<E> queueEvents) Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a set of SimJQEvents.
DefaultWorkloadSchedule(Set<E> queueEvents) Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a set of SimJQEvents.

Method Summary

Modifier and Type	Method and Description
Map<SimJob,List<Double>>	getArrivalTimesMap(SimQueue queue) Gets the arrival times indexed by job at given queue.
Map<Class<? extends SimJQEvent>,SimEntitySimpleEventType.Member>	getEventMap() Returns a appropriate event map for this handler for queue-access vacations, arrivals, revocations and server-access credits.
WorkloadScheduleHandler	getHandler(String name) Gets a handler by name.
String	getHandlerName() Returns the name of the handler.
NavigableMap<Double,List<SimJob>>	getJobArrivalsMap(SimQueue queue) Gets the job arrivals indexed by time at given queue.
NavigableMap<Double,List<Map<SimJob,Boolean>>>	getJobRevocationsMap(SimQueue queue) Gets the job revocations indexed by time at given queue.
Set<SimJob>	getJobs() Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at any of the queues.
Set<SimJob>	getJobs(SimQueue queue) Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at given queue.
double	getNextEventTimeBeyond(SimQueue queue, double time, Set<SimEntitySimpleEventType.Member> eventTypes) Returns the time of the next event(s), and optionally their types, scheduled strictly beyond a given time at a specific queue.
Set<SimJQEvent>	getProcessedQueueEvents() Gets the underlying queue events that were processed for this workload representation.
NavigableMap<Double,List<Boolean>>	getQueueAccessVacationMap(SimQueue queue) Returns the queue-access vacation settings in time for a specific queue.
Set<SimJQEvent>	getQueueEvents() Gets the underlying queue events (all) of this workload representation.
Set<SimQueue>	getQueues() Gets the queues (in no particular order) to which this workload representation applies.
Map<SimJob,List<Map<Double,Boolean>>>	getRevocationTimesMap(SimQueue queue) Gets the revocation times indexed by job at given queue.
NavigableMap<Double,List<Integer>>	getServerAccessCreditsMap(SimQueue queue) Returns the server-access-credits settings in time for a specific queue.
boolean	needsScan() Returns true.
void	registerHandler(WorkloadScheduleHandler handler) Registers a handler for SimJQEvents, and, upon request of the handler, passes control to it for scanning.
Set<SimJQEvent>	scan(DefaultWorkloadSchedule workloadSchedule) Scans the host DefaultWorkloadSchedule and builds internal data structures.

Methods inherited from class org.javades.jqueues.r5.event.map.DefaultSimEntityEventMap

getEntityEvents, getSimJobTimeSimEntityEventMap, getSimQueueTimeSimEntityEventMap, getTimeSimJobSimEntityEventMap, getTimeSimQueueSimEntityEventMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javades.jqueues.r5.util.predictor.workload.WorkloadSchedule

hasEventsBeyond, isSingleQueue, isSingleVisit, isSingleVisit, isUnambiguous_ROEL

Methods inherited from interface org.javades.jqueues.r5.event.map.SimEntityEventMap

getEntityEvents, getSimJobTimeSimEntityEventMap, getSimQueueTimeSimEntityEventMap, getTimeSimJobSimEntityEventMap, getTimeSimQueueSimEntityEventMap

Constructor Detail

DefaultWorkloadSchedule

public DefaultWorkloadSchedule(Set<? extends SimQueue> queues,
                               Set<E> queueEvents)
                        throws WorkloadScheduleException

Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a set of SimJQEvents.

Type Parameters:

E - The event type.

Parameters:

queues - The queues to consider; events related to other queues are ignored; if null, consider all queues found in the queueEvents set.

queueEvents - The set of events to parse (parsing is actually done in this constructor).

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

DefaultWorkloadSchedule

public DefaultWorkloadSchedule(Set<E> queueEvents)
                        throws WorkloadScheduleException

Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a set of SimJQEvents.

With this constructor, all queues found in the queueEvents are considered.

Implemented as this (null, queueEvents).

Type Parameters:

E - The event type.

Parameters:

queueEvents - The set of events to parse (parsing is actually done in this constructor).

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

DefaultWorkloadSchedule

public DefaultWorkloadSchedule(Set<? extends SimQueue> queues,
                               Map<Double,Set<E>> queueEvents)
                        throws WorkloadScheduleException

Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a map of SimJQEvents.

Type Parameters:

E - The event type.

Parameters:

queues - The queues to consider; events related to other queues are ignored; if null, consider all queues found in the queueEvents set.

queueEvents - The set of events (as a map) to parse (parsing is actually done in this constructor).

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

DefaultWorkloadSchedule

public DefaultWorkloadSchedule(Map<Double,Set<E>> queueEvents)
                        throws WorkloadScheduleException

Creates a new DefaultWorkloadSchedule, filling out all the internal sets and maps from scanning a map of SimJQEvents.

With this constructor, all queues found in the queueEvents are considered.

Implemented as this (null, queueEvents).

Type Parameters:

E - The event type.

Parameters:

queueEvents - The set of events (as a map) to parse (parsing is actually done in this constructor).

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

Method Detail

getNextEventTimeBeyond

public double getNextEventTimeBeyond(SimQueue queue,
                                     double time,
                                     Set<SimEntitySimpleEventType.Member> eventTypes)
                              throws WorkloadScheduleException

Description copied from interface: WorkloadSchedule

Returns the time of the next event(s), and optionally their types, scheduled strictly beyond a given time at a specific queue.

Specified by:

getNextEventTimeBeyond in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case Double.NaN is returned.

time - The time from which to search, use Double.NaN to retrieve the first-event time (which may be Double.NEGATIVE_INFINITY).

eventTypes - An optional set to store the (possible multiple) event types; a non-null set is cleared upon entry.

Returns:

The time of the next event, or Double.NaN if no such event exists.

Throws:

WorkloadScheduleException - If the workload is invalid, or this schedule is incapable of parsing it (completely).

See Also:

WorkloadSchedule.hasEventsBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double)

registerHandler

public final void registerHandler(WorkloadScheduleHandler handler)
                           throws WorkloadScheduleException

Registers a handler for SimJQEvents, and, upon request of the handler, passes control to it for scanning.

Parameters:

handler - The handler.

Throws:

IllegalArgumentException - If the handler or its name are null, if a handler with the same name has been registered already, if the handler's event map has a null key, or if it tries to register SimJQEvents that are already registered by other handlers.

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

See Also:

WorkloadScheduleHandler

getHandler

public final WorkloadScheduleHandler getHandler(String name)

Gets a handler by name.

Parameters:

name - The name to look for.

Returns:

The handler, or null if not found.

getQueueEvents

public final Set<SimJQEvent> getQueueEvents()

Description copied from interface: WorkloadSchedule

Gets the underlying queue events (all) of this workload representation.

A unmodifiable view must be returned.

Specified by:

getQueueEvents in interface WorkloadSchedule

Returns:

The underlying queue events (all) of this workload representation, ordered as found in the source upon construction.

getProcessedQueueEvents

public final Set<SimJQEvent> getProcessedQueueEvents()

Description copied from interface: WorkloadSchedule

Gets the underlying queue events that were processed for this workload representation.

The set returned must always be a subset of WorkloadSchedule.getQueueEvents().

A unmodifiable view must be returned.

Specified by:

getProcessedQueueEvents in interface WorkloadSchedule

Returns:

The underlying queue events that were processed for this workload representation, in no particular specified order.

getQueues

public final Set<SimQueue> getQueues()

Description copied from interface: WorkloadSchedule

Gets the queues (in no particular order) to which this workload representation applies.

The set must be fixed upon construction.

A unmodifiable view must be returned.

Specified by:

getQueues in interface WorkloadSchedule

Returns:

The queue (in no particular order) to which this workload representation applies.

getQueueAccessVacationMap

public final NavigableMap<Double,List<Boolean>> getQueueAccessVacationMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Returns the queue-access vacation settings in time for a specific queue.

A unmodifiable view must be returned.

Specified by:

getQueueAccessVacationMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The queue-access vacation settings in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

getJobs

public final Set<SimJob> getJobs()

Description copied from interface: WorkloadSchedule

Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at any of the queues.

Note that this set may include jobs that did not arrive at any queue.

A unmodifiable view must be returned.

Specified by:

getJobs in interface WorkloadSchedule

Returns:

The jobs (in no particular order) in a non-null set operating (arriving, revoking, ...) at least once at any of the queues.

getJobs

public final Set<SimJob> getJobs(SimQueue queue)

Description copied from interface: WorkloadSchedule

Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at given queue.

The set returned must always be a subset of WorkloadSchedule.getJobs(SimQueue).

Note that this set may include jobs that did not arrive at the queue.

A unmodifiable view must be returned.

Specified by:

getJobs in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty set is returned.

Returns:

The jobs (in no particular order) in a non-null set operating (arriving, revoking, ...) at least once at given queue.

getArrivalTimesMap

public final Map<SimJob,List<Double>> getArrivalTimesMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Gets the arrival times indexed by job at given queue.

A unmodifiable view must be returned.

Specified by:

getArrivalTimesMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The job arrival times indexed by job and subsequently ordered according to appearance in the source event list upon construction.

getJobArrivalsMap

public final NavigableMap<Double,List<SimJob>> getJobArrivalsMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Gets the job arrivals indexed by time at given queue.

A unmodifiable view must be returned.

Specified by:

getJobArrivalsMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The job arrivals in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

getRevocationTimesMap

public final Map<SimJob,List<Map<Double,Boolean>>> getRevocationTimesMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Gets the revocation times indexed by job at given queue.

A unmodifiable view must be returned.

The inner map yields the 'interruptService' argument for the event time. It has only one entry.

Specified by:

getRevocationTimesMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The job revocation times indexed by job and subsequently ordered according to appearance in the source event list upon construction.

getJobRevocationsMap

public final NavigableMap<Double,List<Map<SimJob,Boolean>>> getJobRevocationsMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Gets the job revocations indexed by time at given queue.

A unmodifiable view must be returned.

The inner map yields the 'interruptService' argument for the job. It has only one entry.

Specified by:

getJobRevocationsMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The job revocations in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

getServerAccessCreditsMap

public final NavigableMap<Double,List<Integer>> getServerAccessCreditsMap(SimQueue queue)

Description copied from interface: WorkloadSchedule

Returns the server-access-credits settings in time for a specific queue.

A unmodifiable view must be returned.

Specified by:

getServerAccessCreditsMap in interface WorkloadSchedule

Parameters:

queue - The queue, may be null or not in WorkloadSchedule.getQueues(), in which case an empty map is returned.

Returns:

The server-access-credits settings in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

getHandlerName

public final String getHandlerName()

Description copied from interface: WorkloadScheduleHandler

Returns the name of the handler.

The handler name must be unique within the realm of the DefaultWorkloadSchedule at which this handler registers. For SimQueue state extensions, the convention is to use the interface name appended with "Handler", like, "SimQueueHandler" and "SimQueueWithGateHandler".

Specified by:

getHandlerName in interface WorkloadScheduleHandler

Returns:

"SimQueueHandler".

getEventMap

public final Map<Class<? extends SimJQEvent>,SimEntitySimpleEventType.Member> getEventMap()

Returns a appropriate event map for this handler for queue-access vacations, arrivals, revocations and server-access credits.

Specified by:

getEventMap in interface WorkloadScheduleHandler

Returns:

An event map for queue-access vacations, arrivals, revocations and server-access credits.

See Also:

SimQueueEvent.QueueAccessVacation, SimJQEvent.Arrival, SimJQEvent.Revocation, SimQueueEvent.ServerAccessCredits, SimQueueSimpleEventType.QUEUE_ACCESS_VACATION, SimJQSimpleEventType.ARRIVAL, SimJQSimpleEventType.REVOCATION, SimQueueSimpleEventType.SERVER_ACCESS_CREDITS

needsScan

public final boolean needsScan()

Returns true.

Specified by:

needsScan in interface WorkloadScheduleHandler

Returns:

True.

See Also:

registerHandler(org.javades.jqueues.r5.util.predictor.workload.WorkloadScheduleHandler), WorkloadScheduleHandler.scan(org.javades.jqueues.r5.util.predictor.workload.DefaultWorkloadSchedule)

scan

public final Set<SimJQEvent> scan(DefaultWorkloadSchedule workloadSchedule)

Description copied from interface: WorkloadScheduleHandler

Scans the host DefaultWorkloadSchedule and builds internal data structures.

Called by our host DefaultWorkloadSchedule only upon registration, and if we ask for it WorkloadScheduleHandler.needsScan().

Specified by:

scan in interface WorkloadScheduleHandler

Parameters:

workloadSchedule - The host at which we registered.

Returns:

The SimJQEvents processed by this handler, in a set with no particular member ordering; may be null or empty.

See Also:

registerHandler(org.javades.jqueues.r5.util.predictor.workload.WorkloadScheduleHandler), WorkloadScheduleHandler.scan(org.javades.jqueues.r5.util.predictor.workload.DefaultWorkloadSchedule)