Package com.marklogic.client.datamovement

Class ProgressListener.SimpleProgressUpdate

java.lang.Object

com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate

All Implemented Interfaces:

ProgressListener.ProgressUpdate

Enclosing class:

ProgressListener

public static class ProgressListener.SimpleProgressUpdate
extends java.lang.Object
implements ProgressListener.ProgressUpdate

Simple implementation of ProgressUpdate; only real thing of interest in here is how it generates the progress as a string for display purposes.

Constructor Summary

Constructors

Constructor	Description
SimpleProgressUpdate(QueryBatch queryBatch, long startTime, long totalResults, double timeSoFarInSeconds)	Constructs a simple implementation of the ProgressUpdate interface

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProgressUpdate

public SimpleProgressUpdate(QueryBatch queryBatch,
                            long startTime,
                            long totalResults,
                            double timeSoFarInSeconds)

Constructs a simple implementation of the ProgressUpdate interface

Parameters:

queryBatch - the query batcher producing the results

startTime - the time when the processing started

totalResults - the number of results in this update

timeSoFarInSeconds - the time taken by processing up to this update

Method Detail

getProgressAsString

public java.lang.String getProgressAsString()

Description copied from interface: ProgressListener.ProgressUpdate

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

Specified by:

getProgressAsString in interface ProgressListener.ProgressUpdate

Returns:

the prograss update as a string

isComplete

public boolean isComplete()

Description copied from interface: ProgressListener.ProgressUpdate

Whether the update is complete.

Specified by:

isComplete in interface ProgressListener.ProgressUpdate

Returns:

true if the update is complete

getQueryBatch

public QueryBatch getQueryBatch()

Description copied from interface: ProgressListener.ProgressUpdate

Gets the query batcher producing the results.

Specified by:

getQueryBatch in interface ProgressListener.ProgressUpdate

Returns:

the query batcher

getStartTime

public long getStartTime()

Description copied from interface: ProgressListener.ProgressUpdate

Gets the time when the processing started.

Specified by:

getStartTime in interface ProgressListener.ProgressUpdate

Returns:

the start time

getTotalResults

public long getTotalResults()

Description copied from interface: ProgressListener.ProgressUpdate

Gets the total number of results in this update.

Specified by:

getTotalResults in interface ProgressListener.ProgressUpdate

Returns:

the number of results

getTimeSoFarInSeconds

public double getTimeSoFarInSeconds()

Description copied from interface: ProgressListener.ProgressUpdate

Gets the time taken by processing up to this update.

Specified by:

getTimeSoFarInSeconds in interface ProgressListener.ProgressUpdate

Returns:

the time thus far