com.hazelcast.mapreduce.impl.task

Class TrackableJobFuture<V>

java.lang.Object

com.hazelcast.spi.impl.AbstractCompletableFuture<V>

com.hazelcast.mapreduce.impl.task.TrackableJobFuture<V>

Type Parameters:

V - type of the resulting value

All Implemented Interfaces:

ICompletableFuture<V>, JobCompletableFuture<V>, TrackableJob<V>, Future<V>

public class TrackableJobFuture<V>
extends AbstractCompletableFuture<V>
implements TrackableJob<V>, JobCompletableFuture<V>

This is the node based implementation of the job's reactive ICompletableFuture and is returned to the users codebase. It hides the exposed JobPartitionState array from JobProcessInformationImpl by wrapping it into an adapter that creates a full copy prior to returning it to the end user.

Constructor Summary

Constructors

Constructor and Description
TrackableJobFuture(String name, String jobId, JobTracker jobTracker, NodeEngine nodeEngine, Collator collator)

Method Summary

Modifier and Type	Method and Description
ICompletableFuture<V>	getCompletableFuture() Returns the ICompletableFuture to add callbacks or wait for the resulting value of the tracked job.
String	getJobId() Returns the unique job ID of the tracked job
JobProcessInformation	getJobProcessInformation() Returns an instance of JobProcessInformation to find out the state and statistics of a running task, or returns null if the underlying job ID is not available because the job is already finished or has not yet been submitted. It returns null if not requested on the job issuing cluster member or client, since those values are not distributed to all clusters for traffic reasons.
JobTracker	getJobTracker() Returns the assigned JobTracker
String	getName() Returns the name of the underlying JobTracker
boolean	setResult(Object result) Sets the result.
protected boolean	shouldCancel(boolean mayInterruptIfRunning) Protected method invoked on cancel().

Methods inherited from class com.hazelcast.spi.impl.AbstractCompletableFuture

andThen, andThen, cancel, cancelled, done, get, get, getResult, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.core.ICompletableFuture

andThen, andThen

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Constructor Detail

TrackableJobFuture

public TrackableJobFuture(String name,
                          String jobId,
                          JobTracker jobTracker,
                          NodeEngine nodeEngine,
                          Collator collator)

Method Detail

setResult

public boolean setResult(Object result)

Description copied from class: AbstractCompletableFuture

Sets the result. If result is an instance of Throwable, this future will be completed exceptionally. That is, AbstractCompletableFuture.get() will throw the exception rather than return it.

Overrides:

setResult in class AbstractCompletableFuture<V>

Returns:

true, if this call made this future to complete

shouldCancel

protected boolean shouldCancel(boolean mayInterruptIfRunning)

Description copied from class: AbstractCompletableFuture

Protected method invoked on cancel(). Enables aborting the cancellation. Useful for futures' encompassing logic that can forbid the cancellation. By default always returns true.

Overrides:

shouldCancel in class AbstractCompletableFuture<V>

Parameters:

mayInterruptIfRunning - passed through from cancel call

Returns:

true should the cancellation proceed; false otherwise

getJobTracker

public JobTracker getJobTracker()

Description copied from interface: TrackableJob

Returns the assigned JobTracker

Specified by:

getJobTracker in interface TrackableJob<V>

Returns:

assigned JobTracker

getName

public String getName()

Description copied from interface: TrackableJob

Returns the name of the underlying JobTracker

Specified by:

getName in interface TrackableJob<V>

Returns:

name of the JobTracker

getJobId

public String getJobId()

Description copied from interface: TrackableJob

Returns the unique job ID of the tracked job

Specified by:

getJobId in interface JobCompletableFuture<V>

Specified by:

getJobId in interface TrackableJob<V>

Returns:

job ID of the tracked job

getCompletableFuture

public ICompletableFuture<V> getCompletableFuture()

Description copied from interface: TrackableJob

Returns the ICompletableFuture to add callbacks or wait for the resulting value of the tracked job.

Specified by:

getCompletableFuture in interface TrackableJob<V>

Returns:

ICompletableFuture of the tracked job

getJobProcessInformation

public JobProcessInformation getJobProcessInformation()

Description copied from interface: TrackableJob

Returns an instance of JobProcessInformation to find out the state and statistics of a running task, or returns null if the underlying job ID is not available because the job is already finished or has not yet been submitted.
It returns null if not requested on the job issuing cluster member or client, since those values are not distributed to all clusters for traffic reasons.

Specified by:

getJobProcessInformation in interface TrackableJob<V>

Returns:

instance of the job process information, or null if job ID is not available