org.processmining.stream.core.abstracts

Class AbstractXSRunnableXSWritable<T_DPCK extends XSDataPacket<?,?>>

java.lang.Object

java.lang.Thread

org.processmining.stream.core.abstracts.AbstractXSRunnable

org.processmining.stream.core.abstracts.AbstractXSRunnableXSWritable<T_DPCK>

All Implemented Interfaces:

java.lang.Runnable, XSRunnable, XSWritable<T_DPCK>

Direct Known Subclasses:

AbstractXSHub, AbstractXSReader

public abstract class AbstractXSRunnableXSWritable<T_DPCK extends XSDataPacket<?,?>>
extends AbstractXSRunnable
implements XSWritable<T_DPCK>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractXSRunnableXSWritable(java.lang.String name, CommunicationType communicationType)
AbstractXSRunnableXSWritable(java.lang.String name, CommunicationType communicationType, boolean trackPerformance)

Method Summary

Modifier and Type	Method and Description
void	deliver(T_DPCK packet) delivers a packet at this writable.
CommunicationType	getCommunicationType()
XSDeliveryLock	getDeliveryLock()
protected long[]	getHandlingTimes()
XSRunnable	getLatestWritingThread()
protected long[]	getMemoryUsage()
protected int	getNextHandlingTimeIndex()
protected int	getNextMemoryUsageIndex()
protected T_DPCK	getNextPacket()
long	getNumberOfPacketsReceived()
long[]	getPacketHandlingTimes()
int	getPerformanceTrackerStepSize()
long[]	getUsedMemory()
protected abstract void	handleNextPacket(T_DPCK packet)
boolean	isTrackingPerformance()
protected boolean	isTrackPerformance()
protected long	measureUsedMemory() measures actual memory currently used by the algorithm.
protected void	setHandlingTimes(long[] handlingTimes)
void	setLatestWritingThread(XSRunnable latestWritingThread)
protected void	setMemoryUsage(long[] memoryUsage)
protected void	setNextHandlingTimeIndex(int nextHandlingTimeIndex)
protected void	setNextMemoryUsageIndex(int nextMemoryUsageIndex)
void	setPerformanceTrackerStepSize(int performanceTrackerStepSize)
void	setTrackPerformance(boolean track)
protected void	storeNewPacket(T_DPCK packet)
void	triggerPacketHandle(T_DPCK dataPacket) access method of the deliver procedure, i.e.
protected void	workPackage() Conceptually the (thread executing) the work package does the following: 1.

Methods inherited from class org.processmining.stream.core.abstracts.AbstractXSRunnable

interrupt, isPaused, isRunning, isStarted, isStopped, pause, pauseXSRunnable, run, start, startXSRunnable, stopXSRunnable

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.processmining.stream.core.interfaces.XSRunnable

getName, stop

Constructor Detail

AbstractXSRunnableXSWritable

public AbstractXSRunnableXSWritable(java.lang.String name,
                                    CommunicationType communicationType)

AbstractXSRunnableXSWritable

public AbstractXSRunnableXSWritable(java.lang.String name,
                                    CommunicationType communicationType,
                                    boolean trackPerformance)

Method Detail

deliver

public final void deliver(T_DPCK packet)

delivers a packet at this writable. This method is typically performed by some writable thread.

Specified by:

deliver in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

getCommunicationType

public CommunicationType getCommunicationType()

Specified by:

getCommunicationType in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

getDeliveryLock

public XSDeliveryLock getDeliveryLock()

Specified by:

getDeliveryLock in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

getHandlingTimes

protected long[] getHandlingTimes()

getLatestWritingThread

public XSRunnable getLatestWritingThread()

getMemoryUsage

protected long[] getMemoryUsage()

getNextHandlingTimeIndex

protected int getNextHandlingTimeIndex()

getNextMemoryUsageIndex

protected int getNextMemoryUsageIndex()

getNextPacket

protected T_DPCK getNextPacket()

getNumberOfPacketsReceived

public long getNumberOfPacketsReceived()

Specified by:

getNumberOfPacketsReceived in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

getPacketHandlingTimes

public long[] getPacketHandlingTimes()

Specified by:

getPacketHandlingTimes in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

getPerformanceTrackerStepSize

public int getPerformanceTrackerStepSize()

getUsedMemory

public long[] getUsedMemory()

Specified by:

getUsedMemory in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

handleNextPacket

protected abstract void handleNextPacket(T_DPCK packet)

isTrackingPerformance

public boolean isTrackingPerformance()

Specified by:

isTrackingPerformance in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

isTrackPerformance

protected boolean isTrackPerformance()

setHandlingTimes

protected void setHandlingTimes(long[] handlingTimes)

setLatestWritingThread

public void setLatestWritingThread(XSRunnable latestWritingThread)

setMemoryUsage

protected void setMemoryUsage(long[] memoryUsage)

setNextHandlingTimeIndex

protected void setNextHandlingTimeIndex(int nextHandlingTimeIndex)

setNextMemoryUsageIndex

protected void setNextMemoryUsageIndex(int nextMemoryUsageIndex)

setPerformanceTrackerStepSize

public void setPerformanceTrackerStepSize(int performanceTrackerStepSize)

Specified by:

setPerformanceTrackerStepSize in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

setTrackPerformance

public void setTrackPerformance(boolean track)

Specified by:

setTrackPerformance in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>

storeNewPacket

protected void storeNewPacket(T_DPCK packet)

measureUsedMemory

protected long measureUsedMemory()

measures actual memory currently used by the algorithm. may be changed by child classes to define a more specific measurement. For example, by only measuring the size of certain data structures within the child class.

Returns:

workPackage

protected final void workPackage()

Conceptually the (thread executing) the work package does the following: 1. Acquire read/write lock and check if a new message arrived 2. if no message arrived sleep 3. if interrupted && stopped, then exit 4. if woken up then verify that we are still running and that there is a packet. If so, handle the packet.

Specified by:

workPackage in class AbstractXSRunnable

triggerPacketHandle

public void triggerPacketHandle(T_DPCK dataPacket)

Description copied from interface: XSWritable

access method of the deliver procedure, i.e. without interaction with the stream framework, use in case the writable should be used as a delegate / internally.

Specified by:

triggerPacketHandle in interface XSWritable<T_DPCK extends XSDataPacket<?,?>>