org.javades.jqueues.r5.entity.jq.queue.composite.collector

Class AbstractCollectorSimQueue<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractCollectorSimQueue>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

org.javades.jqueues.r5.entity.jq.AbstractSimJQ<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.collector.AbstractCollectorSimQueue<DJ,DQ,J,Q>

Type Parameters:

DJ - The delegate-job type.

DQ - The queue-type for delegate jobs.

J - The job type.

Q - The queue type for jobs.

All Implemented Interfaces:

SimQueueComposite<DJ,DQ,J,Q>, SimQueueSelector<J,DQ>, SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimEntityListener, org.javades.jsimulation.r5.SimEventListResetListener

Direct Known Subclasses:

ARevCol, Col, DepCol, DropCol

public abstract class AbstractCollectorSimQueue<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractCollectorSimQueue>
extends AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

A composite queue with two queues, a main one and one collecting, upon request, all dropped, auto-revoked and/or departed jobs from the main queue.

The main and collector arguments may be equal.

This and derived queues use the LocalStart model as explained with AbstractSimQueueComposite_LocalStart.

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.

Nested Class Summary

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

AbstractSimQueueComposite.RealDelegateJobMapper<J extends SimJob,DJ extends SimJob>

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

AbstractSimEntity.Notifier, AbstractSimEntity.PreNotificationHook

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

SimQueue.AutoRevocationPolicy

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntity

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Field Summary

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

realDelegateJobMapper

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

eventsScheduled, SANITY

Fields inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
AbstractCollectorSimQueue(org.javades.jsimulation.r5.SimEventList eventList, SimQueue<DJ,DQ> mainQueue, SimQueue<DJ,DQ> collectorQueue, boolean collectDrops, boolean collectAutoRevocations, boolean collectDepartures, DelegateSimJobFactory delegateSimJobFactory) Creates a collector queue given an event list, a main queue and a collector queue.

Method Summary

Modifier and Type	Method and Description
protected DQ	getCollectorQueue() Returns the collector (second, last) queue.
protected DQ	getMainQueue() Returns the main (first) queue.
boolean	isCollectAutoRevocations() Return whether to collect auto-revocations.
boolean	isCollectDepartures() Return whether to collect departures.
boolean	isCollectDrops() Return whether to collect drops.
protected void	processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications) Removes applicable exit notifications from the main queue, and let the jobs arrive at the collector queue; invoke super method for all other notifications.
protected void	resetEntitySubClass() Calls super method (in order to make implementation final).

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart

getQoS, getQoSClass, getServiceTimeForJob, insertJobInQueueUponArrival, insertJobInQueueUponStart, isStartArmed, queueAccessVacationDropSubClass, removeJobFromQueueUponDeparture, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterArrival, rescheduleAfterDeparture, rescheduleAfterDrop, rescheduleAfterRevokation, rescheduleAfterStart, rescheduleForNewServerAccessCredits, setServerAccessCreditsSubClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

addRealJobLocal, getCopySimQueues, getCopySubSimQueues, getDelegateJob, getDelegateJobMild, getDelegateSimJobFactory, getIndex, getIndex, getQueue, getQueue, getQueues, getRealJob, getRealJob, getSimQueueSelector, isDelegateJob, isRealJob, notifyResetEntity, notifyStateChanged, notifyUpdate, removeJobsFromQueueLocal, resetSimQueueSelector, selectFirstQueue, selectNextQueue, setDelegateSimJobFactory

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

arrive, autoRevoke, cancelDepartureEvent, cancelDepartureEvent, depart, departureFromEventList, drop, getAutoRevocationPolicy, getDepartureEvents, getDepartureEvents, getFirstJob, getFirstJobInServiceArea, getFirstJobInWaitingArea, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, hasJobs, hasJobsInServiceArea, hasJobsInWaitingArea, hasServerAcccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, start, takeServerAccessCredit, toStringDefault, triggerPotentialNewStartArmed, unregisterStdOutSimQueueListener

Methods inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

addPendingNotification, addPendingNotification, clearAndUnlockPendingNotificationsIfLocked, delegateOperation, doAfterNotifications, doOperation, fireAndLockPendingNotifications, getEventList, getLastUpdateTime, getRegisteredDelegatedOperations, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, notifyEventListReset, registerDelegatedOperation, registerNotificationType, registerOperation, registerPreEventHook, registerPreNotificationHook, registerPreUpdateHook, registerSimEntityListener, registerStdOutSimEntityListener, removeDelegationForOperation, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toString, unregisterSimEntityListener, unregisterStdOutSimEntityListener, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

arrive, getAutoRevocationPolicy, getCopySimQueue, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, revoke, revoke, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntity

doAfterNotifications, doOperation, getEventList, getLastUpdateTime, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, registerSimEntityListener, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toStringDefault, unregisterSimEntityListener, update

Methods inherited from interface org.javades.jsimulation.r5.SimEventListResetListener

notifyEventListReset

Constructor Detail

AbstractCollectorSimQueue

public AbstractCollectorSimQueue(org.javades.jsimulation.r5.SimEventList eventList,
                                 SimQueue<DJ,DQ> mainQueue,
                                 SimQueue<DJ,DQ> collectorQueue,
                                 boolean collectDrops,
                                 boolean collectAutoRevocations,
                                 boolean collectDepartures,
                                 DelegateSimJobFactory delegateSimJobFactory)

Creates a collector queue given an event list, a main queue and a collector queue.

Note that the mainQueue and the dropQueue arguments may be equal!

Parameters:

eventList - The event list to use.

mainQueue - The main queue.

collectorQueue - The collector queue.

collectDrops - Whether to collect drops from the main queue.

collectAutoRevocations - Whether to collect auto-revocations from the main queue.

collectDepartures - Whether to collect departures from the main queue.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

Throws:

IllegalArgumentException - If the event list is null, one of or both queues are null.

See Also:

CollectorSimQueueSelector, DelegateSimJobFactory, DefaultDelegateSimJobFactory

Method Detail

getMainQueue

protected final DQ getMainQueue()

Returns the main (first) queue.

Returns:

The main (first) queue.

getCollectorQueue

protected final DQ getCollectorQueue()

Returns the collector (second, last) queue.

Returns:

The collector (second, last) queue.

isCollectDrops

public final boolean isCollectDrops()

Return whether to collect drops.

Returns:

Whether to collect drops.

isCollectAutoRevocations

public final boolean isCollectAutoRevocations()

Return whether to collect auto-revocations.

Returns:

Whether to collect auto-revocations.

isCollectDepartures

public final boolean isCollectDepartures()

Return whether to collect departures.

Returns:

Whether to collect departures.

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method (in order to make implementation final).

Overrides:

resetEntitySubClass in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractCollectorSimQueue>

See Also:

AbstractSimQueueComposite_LocalStart.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueueComposite_LocalStart.rescheduleAfterRevokation(J, double, boolean), SimEntity.resetEntity()

processSubQueueNotifications

protected final void processSubQueueNotifications(List<MultiSimQueueNotificationProcessor.Notification<DJ,DQ>> notifications)

Removes applicable exit notifications from the main queue, and let the jobs arrive at the collector queue; invoke super method for all other notifications.

Overrides:

processSubQueueNotifications in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends AbstractCollectorSimQueue>

Parameters:

notifications - The sub-queue notifications, will be modified; empty upon return.

See Also:

collectDrops, collectAutoRevocations, collectDepartures, SimQueue.arrive(double, J)