Package pamScrollSystem

Class LoadQueueProgressData

java.lang.Object

pamViewFX.pamTask.PamTaskUpdate

pamScrollSystem.LoadQueueProgressData

public class LoadQueueProgressData
extends PamTaskUpdate

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STATE_DONE
static final int	STATE_LINKINGSUBTABLE
static final int	STATE_LOADING

Fields inherited from class pamViewFX.pamTask.PamTaskUpdate

STATUS_ANALYSING_FILES, STATUS_COUNTING_FILES, STATUS_DESERIALIZING, STATUS_DONE, STATUS_DONE_ERROR, STATUS_IDLE, STATUS_SERIALIZING, STATUS_SORTING

Constructor Summary

Constructors

Constructor	Description
LoadQueueProgressData(int status)
LoadQueueProgressData(String storeType, String streamName, int totalStreams, int stream, int state, long loadStart, long loadEnd, long loadCurrent, int nLoaded)

Method Summary

Modifier and Type	Method	Description
int	getiStream()
int	getIStream()
long	getLoadCurrent()
long	getLoadEnd()
long	getLoadStart()
String	getName()	Get the name of the load thread.
int	getnLoaded()
double	getProgress()	Get the progress of the load thread.
double	getProgress2()	There may be a need for two progress bars for long task- one showing overall progress and the other showing more fine scale loading tasks.
String	getProgressString()	Returns a message indicating progress.
String	getProgressString2()	If two updates are available then this is used to return the fine progress update message.
int	getState()
String	getStoreType()
String	getStreamName()
int	getTotalStreams()

Methods inherited from class pamViewFX.pamTask.PamTaskUpdate

getStatus, isDualProgressUpdate, setDualProgressUpdate, setStatus

Methods inherited from class java.lang.Object

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

Field Details

STATE_LOADING

public static final int STATE_LOADING

See Also:

• Constant Field Values

STATE_LINKINGSUBTABLE

public static final int STATE_LINKINGSUBTABLE

See Also:

• Constant Field Values

STATE_DONE

public static final int STATE_DONE

See Also:

• Constant Field Values

Constructor Details

LoadQueueProgressData

public LoadQueueProgressData(String storeType,
 String streamName,
 int totalStreams,
 int stream,
 int state,
 long loadStart,
 long loadEnd,
 long loadCurrent,
 int nLoaded)

LoadQueueProgressData

public LoadQueueProgressData(int status)

Method Details

getTotalStreams

public int getTotalStreams()

Returns:

the totalStreams

getIStream

public int getIStream()

Returns:

the iStream

getStoreType

public String getStoreType()

Returns:

the storeType

getStreamName

public String getStreamName()

Returns:

the streamName

getiStream

public int getiStream()

Returns:

the iStream

getLoadStart

public long getLoadStart()

Returns:

the loadStart

getLoadEnd

public long getLoadEnd()

Returns:

the loadEnd

getLoadCurrent

public long getLoadCurrent()

Returns:

the loadCurrent

getnLoaded

public int getnLoaded()

Returns:

the nLoaded

getState

public int getState()

Returns:

the state

getName

public String getName()

Description copied from class: PamTaskUpdate

Get the name of the load thread. Note the name is also the unique identifier for the running thread so cannot be the same between two different threads.

Specified by:

getName in class PamTaskUpdate

Returns:

the name of the thread.

getProgress

public double getProgress()

Description copied from class: PamTaskUpdate

Get the progress of the load thread. This is a value between 0 and 1 were 1 is equivalent to 100% or the thread having finished.

Note that ProgressIndicator.INTERMEDIATE can be used as an update value to set progress to intermediate.

Specified by:

getProgress in class PamTaskUpdate

Returns:

the progress of the thread, between 0 and 1.

getProgressString

public String getProgressString()

Description copied from class: PamTaskUpdate

Returns a message indicating progress. Can be overriden to supply other messages.

Overrides:

getProgressString in class PamTaskUpdate

Returns:

getProgress2

public double getProgress2()

Description copied from class: PamTaskUpdate

There may be a need for two progress bars for long task- one showing overall progress and the other showing more fine scale loading tasks. If this is the case then

Note that ProgressIndicator.INTERMEDIATE can be used as an update value to set progress to intermediate.

Overrides:

getProgress2 in class PamTaskUpdate

Returns:

the progress of the thread, between 0 and 1.

getProgressString2

public String getProgressString2()

If two updates are available then this is used to return the fine progress update message.

Overrides:

getProgressString2 in class PamTaskUpdate

Returns: