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

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

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>

org.javades.jqueues.r5.entity.jq.queue.composite.collector.Col<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

public class Col<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends Col>
extends AbstractCollectorSimQueue<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 queue uses 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
Col(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, and flags indicating which exit methods to collect.

Method Summary

Modifier and Type	Method and Description
Col<DJ,DQ,J,Q>	getCopySimQueue() Returns a new Col object on the same SimEventList with copies of the main and collector queues, exit-collection settings and the same delegate-job factory.
String	toStringDefault() Returns "Col(conditions)[mainQueue->collectorQueue]".

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

getCollectorQueue, getMainQueue, isCollectAutoRevocations, isCollectDepartures, isCollectDrops, processSubQueueNotifications, resetEntitySubClass

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, 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, 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, unregisterSimEntityListener, update

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

notifyEventListReset

Constructor Detail

Col

public Col(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, and flags indicating which exit methods to collect.

Note that the mainQueue and the collectorQueue 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

getCopySimQueue

public Col<DJ,DQ,J,Q> getCopySimQueue()

Returns a new Col object on the same SimEventList with copies of the main and collector queues, exit-collection settings and the same delegate-job factory.

Returns:

A new Col object on the same SimEventList with copies of the main and collector queues, exit-collection settings and the same delegate-job factory.

Throws:

UnsupportedOperationException - If the main or collection queues could not be copied through SimQueue.getCopySimQueue().

See Also:

AbstractSimEntity.getEventList(), AbstractCollectorSimQueue.getMainQueue(), AbstractCollectorSimQueue.getCollectorQueue(), AbstractCollectorSimQueue.isCollectDrops(), AbstractCollectorSimQueue.isCollectAutoRevocations(), AbstractCollectorSimQueue.isCollectDepartures(), AbstractSimQueueComposite.getDelegateSimJobFactory()

toStringDefault

public String toStringDefault()

Returns "Col(conditions)[mainQueue->collectorQueue]".

The conditions string reflects the the combined values of AbstractCollectorSimQueue.isCollectDrops(), AbstractCollectorSimQueue.isCollectAutoRevocations() and AbstractCollectorSimQueue.isCollectDepartures() properties.

If the collector queue is the same as the main queue, the collector queue's name is replaced with "self".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimQueue<J extends SimJob,Q extends Col>

Returns:

"Col(conditions)[mainQueue->collectorQueue]".

See Also:

SimEntity.setName(java.lang.String), Object.toString()