Package gda.commandqueue

Class FindableProcessorQueue

java.lang.Object

gda.factory.FindableBase

gda.commandqueue.FindableProcessorQueue

All Implemented Interfaces:

CurrentCommandListener, IFindableQueueProcessor, Processor, Queue, Findable, gda.observable.IObservable, gda.observable.IObserver, Runnable, org.springframework.beans.factory.InitializingBean

@ServiceInterface(IFindableQueueProcessor.class)
public class FindableProcessorQueue
extends FindableBase
implements IFindableQueueProcessor, Runnable, gda.observable.IObserver, org.springframework.beans.factory.InitializingBean

FindableProcessorQueue implements Processor and Queue The implementation of Queue is done using delegation to the Queue object set using the setQueue method

Nested Class Summary

Nested classes/interfaces inherited from interface gda.commandqueue.Processor

Processor.STATE

Constructor Summary

Constructors

Constructor	Description
FindableProcessorQueue()

Method Summary

Modifier and Type	Method	Description
void	addIObserver(gda.observable.IObserver anIObserver)
CommandId	addToTail(Command command)
CommandId	addToTail(CommandProvider provider)
void	afterPropertiesSet()
void	deleteIObserver(gda.observable.IObserver anIObserver)
void	deleteIObservers()
CommandDetails	getCommandDetails(CommandId id)
CommandSummary	getCommandSummary(CommandId id)
ProcessorCurrentItem	getCurrentItem()
CommandId	getRemovedHeadID()
Processor.STATE	getState()
List<QueuedCommandSummary>	getSummaryList()
boolean	isPauseWhenQueueEmpty()
void	moveToBefore(CommandId id, Collection<CommandId> cmdIds)
void	moveToHead(Collection<CommandId> cmdIds)
void	moveToTail(Collection<CommandId> cmdIds)
void	passBaton(String receiverUsername, int receiverIndex)
void	pause(long timeout_ms)
Command	remove(CommandId id)
void	remove(Collection<CommandId> cmdIds)
Collection<Command>	removeAll()
Command	removeHead()
void	replace(CommandId id, Command cmd)
void	run()
void	setCommandDetails(CommandId id, String details)
void	setLogFilePath(String logFilePath)	Deprecated, for removal: This API element is subject to removal in a future version. obsolete property - remove from Spring.
void	setPauseWhenQueueEmpty(boolean pauseWhenQueueEmpty)	Auto pause the queue when it empties
void	setQueue(Queue queue)
void	setStartImmediately(boolean startImmediately)
void	skip(long timeout_ms)
void	start(long timeout_ms)
void	stop(long timeout_ms)
void	stopAfterCurrent()
String	toString()
void	update(Object source, Object arg)

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Findable

getName, setName

Constructor Details

FindableProcessorQueue

public FindableProcessorQueue()

Method Details

setQueue

public void setQueue(Queue queue)

pause

public void pause(long timeout_ms)
           throws Exception

Specified by:

pause in interface Processor

Throws:

Exception

skip

public void skip(long timeout_ms)
          throws Exception

Specified by:

skip in interface Processor

Throws:

Exception

start

public void start(long timeout_ms)
           throws Exception

Specified by:

start in interface Processor

Throws:

Exception

stop

public void stop(long timeout_ms)
          throws Exception

Specified by:

stop in interface Processor

Throws:

Exception

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

run

public void run()

Specified by:

run in interface Runnable

getState

public Processor.STATE getState()

Specified by:

getState in interface Processor

addToTail

public CommandId addToTail(Command command)
                    throws Exception

Specified by:

addToTail in interface Queue

Throws:

Exception

getSummaryList

public List<QueuedCommandSummary> getSummaryList()
                                          throws Exception

Specified by:

getSummaryList in interface Queue

Throws:

Exception

moveToBefore

public void moveToBefore(CommandId id,
 Collection<CommandId> cmdIds)
                  throws Exception

Specified by:

moveToBefore in interface Queue

Throws:

Exception

moveToHead

public void moveToHead(Collection<CommandId> cmdIds)
                throws Exception

Specified by:

moveToHead in interface Queue

Throws:

Exception

moveToTail

public void moveToTail(Collection<CommandId> cmdIds)
                throws Exception

Specified by:

moveToTail in interface Queue

Throws:

Exception

remove

public Command remove(CommandId id)
               throws Exception

Specified by:

remove in interface Queue

Throws:

Exception

removeAll

public Collection<Command> removeAll()
                              throws Exception

Specified by:

removeAll in interface Queue

Throws:

Exception

removeHead

public Command removeHead()
                   throws Exception

Specified by:

removeHead in interface Queue

Throws:

Exception

replace

public void replace(CommandId id,
 Command cmd)
             throws Exception

Specified by:

replace in interface Queue

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

getCurrentItem

public ProcessorCurrentItem getCurrentItem()

Specified by:

getCurrentItem in interface Processor

addIObserver

public void addIObserver(gda.observable.IObserver anIObserver)

Specified by:

addIObserver in interface gda.observable.IObservable

deleteIObserver

public void deleteIObserver(gda.observable.IObserver anIObserver)

Specified by:

deleteIObserver in interface gda.observable.IObservable

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

remove

public void remove(Collection<CommandId> cmdIds)
            throws Exception

Specified by:

remove in interface Queue

Throws:

Exception

getCommandDetails

public CommandDetails getCommandDetails(CommandId id)
                                 throws Exception

Specified by:

getCommandDetails in interface Queue

Throws:

Exception

setCommandDetails

public void setCommandDetails(CommandId id,
 String details)
                       throws Exception

Specified by:

setCommandDetails in interface Queue

Throws:

Exception

getCommandSummary

public CommandSummary getCommandSummary(CommandId id)
                                 throws Exception

Specified by:

getCommandSummary in interface Queue

Throws:

Exception

addToTail

public CommandId addToTail(CommandProvider provider)
                    throws Exception

Specified by:

addToTail in interface Queue

Throws:

Exception

setLogFilePath

@Deprecated(forRemoval=true,
            since="GDA 8.54")
public void setLogFilePath(String logFilePath)

Deprecated, for removal: This API element is subject to removal in a future version.

obsolete property - remove from Spring. This method will be removed in GDA 9.31

Parameters:

logFilePath - The logFilePath to set.

isPauseWhenQueueEmpty

public boolean isPauseWhenQueueEmpty()

setPauseWhenQueueEmpty

public void setPauseWhenQueueEmpty(boolean pauseWhenQueueEmpty)

Auto pause the queue when it empties

Parameters:

pauseWhenQueueEmpty -

setStartImmediately

public void setStartImmediately(boolean startImmediately)

Parameters:

startImmediately - The startImmediately to set.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

stopAfterCurrent

public void stopAfterCurrent()
                      throws Exception

Specified by:

stopAfterCurrent in interface Processor

Throws:

Exception

getRemovedHeadID

public CommandId getRemovedHeadID()

Specified by:

getRemovedHeadID in interface Queue

passBaton

public void passBaton(String receiverUsername,
 int receiverIndex)
               throws Exception

Specified by:

passBaton in interface Processor

Throws:

Exception