com.marklogic.client.datamovement

Interface ProgressListener.ProgressUpdate

All Known Implementing Classes:

ProgressListener.SimpleProgressUpdate

Enclosing class:

ProgressListener

public static interface ProgressListener.ProgressUpdate

Captures data of interest for a progress update.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProgressAsString() Gets a loggable string with the information for the progress update.
QueryBatch	getQueryBatch() Gets the query batcher producing the results.
long	getStartTime() Gets the time when the processing started.
double	getTimeSoFarInSeconds() Gets the time taken by processing up to this update.
long	getTotalResults() Gets the total number of results in this update.
boolean	isComplete() Whether the update is complete.

Method Detail

getProgressAsString

java.lang.String getProgressAsString()

Gets a loggable string with the information for the progress update.

Returns:

the prograss update as a string

isComplete

boolean isComplete()

Whether the update is complete.

Returns:

true if the update is complete

getQueryBatch

QueryBatch getQueryBatch()

Gets the query batcher producing the results.

Returns:

the query batcher

getStartTime

long getStartTime()

Gets the time when the processing started.

Returns:

the start time

getTotalResults

long getTotalResults()

Gets the total number of results in this update.

Returns:

the number of results

getTimeSoFarInSeconds

double getTimeSoFarInSeconds()

Gets the time taken by processing up to this update.

Returns:

the time thus far