ai.grakn.engine.loader

Class MutatorTask

java.lang.Object

ai.grakn.engine.loader.MutatorTask

All Implemented Interfaces:

BackgroundTask

public class MutatorTask
extends Object
implements BackgroundTask

Task that will mutate data in a graph. It uses the engine running on the engine executing the task. The task will then submit all modified concepts for post processing.

Author:

Alexandra Orth

Constructor Summary

Constructors

Constructor and Description
MutatorTask()

Method Summary

Modifier and Type	Method and Description
void	pause() Called to suspend the execution of a currently running task.
boolean	resume(java.util.function.Consumer<TaskCheckpoint> saveCheckpoint, TaskCheckpoint lastCheckpoint) This method may be called when resuming from a paused state or recovering from a crash or failure of any kind.
boolean	start(java.util.function.Consumer<TaskCheckpoint> saveCheckpoint, TaskConfiguration configuration, TaskSubmitter taskSubmitter) Called to start execution of the task, may be called on a newly scheduled or previously stopped task.
boolean	stop() Called to stop execution of the task, may be called on a running or paused task.

Methods inherited from class java.lang.Object

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

Constructor Detail

MutatorTask

public MutatorTask()

Method Detail

start

public boolean start(java.util.function.Consumer<TaskCheckpoint> saveCheckpoint,
                     TaskConfiguration configuration,
                     TaskSubmitter taskSubmitter)

Description copied from interface: BackgroundTask

Called to start execution of the task, may be called on a newly scheduled or previously stopped task.

Specified by:

start in interface BackgroundTask

Parameters:

saveCheckpoint - Consumer which can be called at any time to save a state checkpoint that would allow the task to resume from this point should it crash.

configuration - The configuration needed to execute the task

taskSubmitter - Allows followup tasks to be submitted for processing

Returns:

true if the task successfully completed, or false if it was stopped.

stop

public boolean stop()

Description copied from interface: BackgroundTask

Called to stop execution of the task, may be called on a running or paused task. Task should stop gracefully.

Specified by:

stop in interface BackgroundTask

Returns:

true if the task was successfully stopped, or false if it could not be stopped. TODO: Should we allow start() to be called after stop()?

pause

public void pause()

Description copied from interface: BackgroundTask

Called to suspend the execution of a currently running task. The object may be destroyed after this call. TODO: stop running

Specified by:

pause in interface BackgroundTask

resume

public boolean resume(java.util.function.Consumer<TaskCheckpoint> saveCheckpoint,
                      TaskCheckpoint lastCheckpoint)

Description copied from interface: BackgroundTask

This method may be called when resuming from a paused state or recovering from a crash or failure of any kind.

Specified by:

resume in interface BackgroundTask

Parameters:

saveCheckpoint - Consumer which can be called at any time to save a state checkpoint that would allow the task to resume from this point should it crash.

lastCheckpoint - The last checkpoint as sent to saveCheckpoint.