com.epimorphics.tasks

Class SimpleProgressMonitor

java.lang.Object

com.epimorphics.tasks.SimpleProgressMonitor

All Implemented Interfaces:

JSONWritable, ProgressMonitor, ProgressMonitorReporter, ProgressReporter

Direct Known Subclasses:

LiveProgressMonitor

public class SimpleProgressMonitor
extends Object
implements ProgressMonitorReporter, JSONWritable

Simple implementation of progress monitor/reporter for in-process reporting.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id
static String	ID_FIELD
protected List<ProgressMessage>	messages
static String	MESSAGES_FIELD
protected int	progress
static String	PROGRESS_FIELD
protected TaskState	state
static String	STATE_FIELD
protected boolean	succeeded
static String	SUCEEDED_FIELD
protected long	timestamp
static String	TYPE_ERROR
static String	TYPE_MAIN

Constructor Summary

Constructors

Constructor and Description
SimpleProgressMonitor()
SimpleProgressMonitor(org.apache.jena.atlas.json.JsonObject stored)
SimpleProgressMonitor(String id)

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Return an ID string for this monitor/reporter.
List<ProgressMessage>	getMessages() Return all progress messages logged so far.
List<ProgressMessage>	getMessagesSince(int offset) Return all progress messages since the given message number.
int	getProgress() Get the progress of the task as a percentage.
TaskState	getState() Return the state of the task.
long	getTimestamp()
boolean	moreMessagesSince(int offset) Return true if there are more progress messages available since the given message number.
void	report(String message) Log a progress message, this may be timestamped by the reporter implementation.
void	report(String message, int lineNumber) Log a progress message with an associated line number, this may be timestamped by the reporter implementation.
void	report(String message, int lineNumber, String type) Log a progress message with an associated line number, this may be timestamped by the reporter implementation.
void	report(String message, String type) Log a progress message, this may be timestamped by the reporter implementation.
void	reportError(String message) Report an error as a progress message of type "error" and set the status to failed
void	reportError(String message, int lineNumber) Report an error as a progress message of type "error" and set the status to failed
protected void	reportNewMessage(ProgressMessage message)
protected void	reportStateChange()
void	setFailed() Record that a task has completed but with an error.
void	setProgress(int progress) Set the progress percentage.
void	setState(TaskState state) Change the state of the progress report.
void	setSucceeded() Record that a task has completed but successfully
void	setSuccess(boolean wasSuccessful) Record whether the task was successful or not.
boolean	succeeded() Return true if the task has Terminated and was successful.
String	toString()
SimpleProgressMonitor	truncate(int offset) Return a truncated version of the monitor only containing message since a given offset point
JSONWritable	viewUpdatesSince(int offset) Return a JSON view onto the status of the monitor including any messages since the given offset.
protected void	writeIncrement(JSFullWriter out, int offset)
void	writeTo(JSFullWriter out)

Methods inherited from class java.lang.Object

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

Field Detail

ID_FIELD

public static final String ID_FIELD

See Also:

Constant Field Values

PROGRESS_FIELD

public static final String PROGRESS_FIELD

See Also:

Constant Field Values

STATE_FIELD

public static final String STATE_FIELD

See Also:

Constant Field Values

SUCEEDED_FIELD

public static final String SUCEEDED_FIELD

See Also:

Constant Field Values

MESSAGES_FIELD

public static final String MESSAGES_FIELD

See Also:

Constant Field Values

TYPE_ERROR

public static final String TYPE_ERROR

See Also:

Constant Field Values

TYPE_MAIN

public static final String TYPE_MAIN

See Also:

Constant Field Values

id

protected String id

state

protected TaskState state

progress

protected int progress

succeeded

protected boolean succeeded

messages

protected List<ProgressMessage> messages

timestamp

protected long timestamp

Constructor Detail

SimpleProgressMonitor

public SimpleProgressMonitor()

SimpleProgressMonitor

public SimpleProgressMonitor(String id)

SimpleProgressMonitor

public SimpleProgressMonitor(org.apache.jena.atlas.json.JsonObject stored)

Method Detail

getTimestamp

public long getTimestamp()

setState

public void setState(TaskState state)

Description copied from interface: ProgressReporter

Change the state of the progress report.

Specified by:

setState in interface ProgressReporter

getId

public String getId()

Description copied from interface: ProgressReporter

Return an ID string for this monitor/reporter. Useful when managing a pool of persistent status reports.

Specified by:

getId in interface ProgressReporter

setProgress

public void setProgress(int progress)

Description copied from interface: ProgressReporter

Set the progress percentage.

Specified by:

setProgress in interface ProgressReporter

setSuccess

public void setSuccess(boolean wasSuccessful)

Description copied from interface: ProgressReporter

Record whether the task was successful or not.

Specified by:

setSuccess in interface ProgressReporter

setFailed

public void setFailed()

Description copied from interface: ProgressReporter

Record that a task has completed but with an error.

Specified by:

setFailed in interface ProgressReporter

report

public void report(String message)

Description copied from interface: ProgressReporter

Log a progress message, this may be timestamped by the reporter implementation.

Specified by:

report in interface ProgressReporter

report

public void report(String message,
          int lineNumber)

Description copied from interface: ProgressReporter

Log a progress message with an associated line number, this may be timestamped by the reporter implementation.

Specified by:

report in interface ProgressReporter

Parameters:

message - the message text

lineNumber - the number in some input file corresponding the the message

report

public void report(String message,
          String type)

Description copied from interface: ProgressReporter

Log a progress message, this may be timestamped by the reporter implementation.

Specified by:

report in interface ProgressReporter

Parameters:

message - the message text

type - the nature of the message e.g. "error", application dependent what types are supported

report

public void report(String message,
          int lineNumber,
          String type)

Description copied from interface: ProgressReporter

Log a progress message with an associated line number, this may be timestamped by the reporter implementation.

Specified by:

report in interface ProgressReporter

Parameters:

message - the message text

lineNumber - the number in some input file corresponding the the message

type - the nature of the message e.g. "error", application dependent what types are supported

reportError

public void reportError(String message)

Description copied from interface: ProgressReporter

Report an error as a progress message of type "error" and set the status to failed

Specified by:

reportError in interface ProgressReporter

reportError

public void reportError(String message,
               int lineNumber)

Description copied from interface: ProgressReporter

Report an error as a progress message of type "error" and set the status to failed

Specified by:

reportError in interface ProgressReporter

reportStateChange

protected void reportStateChange()

reportNewMessage

protected void reportNewMessage(ProgressMessage message)

getState

public TaskState getState()

Description copied from interface: ProgressMonitor

Return the state of the task. It may be Waiting to start, Running or Terminated.

Specified by:

getState in interface ProgressMonitor

Specified by:

getState in interface ProgressReporter

getProgress

public int getProgress()

Description copied from interface: ProgressMonitor

Get the progress of the task as a percentage. Not all monitors will offer fine grained progress but the progress will always be 0 for Waiting tasks, >= 1 for running tasks and 100 for Terminated tasks (even for unsuccessful termination).

Specified by:

getProgress in interface ProgressMonitor

succeeded

public boolean succeeded()

Description copied from interface: ProgressMonitor

Return true if the task has Terminated and was successful.

Specified by:

succeeded in interface ProgressMonitor

getMessages

public List<ProgressMessage> getMessages()

Description copied from interface: ProgressMonitor

Return all progress messages logged so far.

Specified by:

getMessages in interface ProgressMonitor

getMessagesSince

public List<ProgressMessage> getMessagesSince(int offset)

Description copied from interface: ProgressMonitor

Return all progress messages since the given message number.

Specified by:

getMessagesSince in interface ProgressMonitor

moreMessagesSince

public boolean moreMessagesSince(int offset)

Description copied from interface: ProgressMonitor

Return true if there are more progress messages available since the given message number.

Specified by:

moreMessagesSince in interface ProgressMonitor

toString

public String toString()

Overrides:

toString in class Object

truncate

public SimpleProgressMonitor truncate(int offset)

Return a truncated version of the monitor only containing message since a given offset point

writeTo

public void writeTo(JSFullWriter out)

Specified by:

writeTo in interface JSONWritable

writeIncrement

protected void writeIncrement(JSFullWriter out,
                  int offset)

viewUpdatesSince

public JSONWritable viewUpdatesSince(int offset)

Return a JSON view onto the status of the monitor including any messages since the given offset.

Specified by:

viewUpdatesSince in interface ProgressMonitor

setSucceeded

public void setSucceeded()

Description copied from interface: ProgressReporter

Record that a task has completed but successfully

Specified by:

setSucceeded in interface ProgressReporter