Package org.mycore.iview2.services

Class MCRTilingQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<MCRTileJob>

org.mycore.iview2.services.MCRTilingQueue

All Implemented Interfaces:

Comparable<MCRShutdownHandler.Closeable>, Iterable<MCRTileJob>, Collection<MCRTileJob>, Queue<MCRTileJob>, MCRShutdownHandler.Closeable

public class MCRTilingQueue
extends AbstractQueue<MCRTileJob>
implements MCRShutdownHandler.Closeable

Field Summary

Fields inherited from interface org.mycore.common.events.MCRShutdownHandler.Closeable

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method	Description
void	clear()	Deletes all tile jobs no matter what the current state is.
void	close()	does nothing
MCRTileJob	element()	removes next job.
MCRTileJob	getElementOutOfOrder(String derivate, String path)	get the specific job and alters it status to MCRJobState.PROCESSING
static MCRTilingQueue	getInstance()
int	getPriority()	Returns the priority.
Iterator<MCRTileJob>	iterator()	iterates of jobs of status MCRJobState.NEW does not change the status.
void	notifyListener()	every attached listener is informed that something happened to the state of the queue.
boolean	offer(MCRTileJob job)	adds job to queue.
MCRTileJob	peek()	get next job without modifying it state to MCRJobState.PROCESSING
MCRTileJob	poll()
void	prepareClose()	Shuts down MCRStalledJobResetter and does not alter any job anymore.
MCRTileJob	remove()	removes next job.
int	remove(String derivate)	removes all jobs from queue for that derivate its current status is.
int	remove(String derivate, String path)	removes specific job from queue no matter what its current status is.
int	size()	returns the current size of this queue
String	toString()

Methods inherited from class java.util.AbstractQueue

add, addAll

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.mycore.common.events.MCRShutdownHandler.Closeable

compareTo

Method Details

getInstance

public static MCRTilingQueue getInstance()

Returns:

singleton instance of this class

poll

public MCRTileJob poll()

Specified by:

poll in interface Queue<MCRTileJob>

Returns:

next available tile job instance

remove

public MCRTileJob remove()
                  throws NoSuchElementException

removes next job. same as poll() but never returns null

Specified by:

remove in interface Queue<MCRTileJob>

Overrides:

remove in class AbstractQueue<MCRTileJob>

Throws:

NoSuchElementException - if poll() would return null

peek

public MCRTileJob peek()

get next job without modifying it state to MCRJobState.PROCESSING

Specified by:

peek in interface Queue<MCRTileJob>

element

public MCRTileJob element()
                   throws NoSuchElementException

removes next job. same as peek() but never returns null

Specified by:

element in interface Queue<MCRTileJob>

Overrides:

element in class AbstractQueue<MCRTileJob>

Throws:

NoSuchElementException - if peek() would return null

offer

public boolean offer(MCRTileJob job)

adds job to queue. alters date added to current time and status of job to MCRJobState.NEW

Specified by:

offer in interface Queue<MCRTileJob>

clear

public void clear()

Deletes all tile jobs no matter what the current state is.

Specified by:

clear in interface Collection<MCRTileJob>

Overrides:

clear in class AbstractQueue<MCRTileJob>

iterator

public Iterator<MCRTileJob> iterator()

iterates of jobs of status MCRJobState.NEW does not change the status.

Specified by:

iterator in interface Collection<MCRTileJob>

Specified by:

iterator in interface Iterable<MCRTileJob>

Specified by:

iterator in class AbstractCollection<MCRTileJob>

size

public int size()

returns the current size of this queue

Specified by:

size in interface Collection<MCRTileJob>

Specified by:

size in class AbstractCollection<MCRTileJob>

getElementOutOfOrder

public MCRTileJob getElementOutOfOrder(String derivate,
 String path)
                                throws NoSuchElementException

get the specific job and alters it status to MCRJobState.PROCESSING

Throws:

NoSuchElementException

notifyListener

public void notifyListener()

every attached listener is informed that something happened to the state of the queue.

remove

public int remove(String derivate,
 String path)

removes specific job from queue no matter what its current status is.

Parameters:

derivate - ID of derivate

path - absolute image path

Returns:

the number of jobs deleted

remove

public int remove(String derivate)

removes all jobs from queue for that derivate its current status is.

Parameters:

derivate - ID of derivate

Returns:

the number of jobs deleted

prepareClose

public void prepareClose()

Shuts down MCRStalledJobResetter and does not alter any job anymore.

Specified by:

prepareClose in interface MCRShutdownHandler.Closeable

close

public void close()

does nothing

Specified by:

close in interface MCRShutdownHandler.Closeable

toString

public String toString()

Overrides:

toString in class AbstractCollection<MCRTileJob>

Returns:

"MCRTilingQueue"

getPriority

public int getPriority()

Description copied from interface: MCRShutdownHandler.Closeable

Returns the priority. A Closeable with a higher priority will be closed before a Closeable with a lower priority. Default priority is 5.

Specified by:

getPriority in interface MCRShutdownHandler.Closeable