Class TaskProgressTracker
- java.lang.Object
-
- org.neo4j.gds.core.utils.progress.tasks.TaskProgressTracker
-
- All Implemented Interfaces:
ProgressTracker
public class TaskProgressTracker extends java.lang.Object implements ProgressTracker
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.neo4j.gds.core.utils.progress.tasks.ProgressTracker
ProgressTracker.EmptyProgressTracker
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Optional<Task>
currentTask
-
Fields inherited from interface org.neo4j.gds.core.utils.progress.tasks.ProgressTracker
NULL_TRACKER
-
-
Constructor Summary
Constructors Constructor Description TaskProgressTracker(Task baseTask, org.neo4j.logging.Log log, int concurrency, JobId jobId, TaskRegistryFactory taskRegistryFactory, UserLogRegistryFactory userLogRegistryFactory)
TaskProgressTracker(Task baseTask, org.neo4j.logging.Log log, int concurrency, TaskRegistryFactory taskRegistryFactory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginSubTask()
void
beginSubTask(long taskVolume)
void
beginSubTask(java.lang.String expectedTaskDescription)
void
beginSubTask(java.lang.String expectedTaskDescription, long taskVolume)
Task
currentSubTask()
long
currentVolume()
Returns the task volume of the currently running task orTask.UNKNOWN_VOLUME
if no task volume is set.void
endSubTask()
void
endSubTask(java.lang.String expectedTaskDescription)
void
endSubTaskWithFailure()
void
endSubTaskWithFailure(java.lang.String expectedTaskDescription)
void
logMessage(LogLevel level, java.lang.String message)
void
logProgress(long value)
void
logProgress(long value, java.lang.String messageTemplate)
void
logSteps(long steps)
void
release()
void
setEstimatedResourceFootprint(org.neo4j.gds.core.utils.mem.MemoryRange memoryRangeInBytes, int maxConcurrency)
void
setSteps(long steps)
void
setVolume(long volume)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.neo4j.gds.core.utils.progress.tasks.ProgressTracker
logDebug, logInfo, logProgress, logWarning
-
-
-
-
Field Detail
-
currentTask
protected java.util.Optional<Task> currentTask
-
-
Constructor Detail
-
TaskProgressTracker
public TaskProgressTracker(Task baseTask, org.neo4j.logging.Log log, int concurrency, TaskRegistryFactory taskRegistryFactory)
-
TaskProgressTracker
public TaskProgressTracker(Task baseTask, org.neo4j.logging.Log log, int concurrency, JobId jobId, TaskRegistryFactory taskRegistryFactory, UserLogRegistryFactory userLogRegistryFactory)
-
-
Method Detail
-
setEstimatedResourceFootprint
public void setEstimatedResourceFootprint(org.neo4j.gds.core.utils.mem.MemoryRange memoryRangeInBytes, int maxConcurrency)
- Specified by:
setEstimatedResourceFootprint
in interfaceProgressTracker
-
beginSubTask
public void beginSubTask()
- Specified by:
beginSubTask
in interfaceProgressTracker
-
beginSubTask
public void beginSubTask(java.lang.String expectedTaskDescription)
- Specified by:
beginSubTask
in interfaceProgressTracker
-
beginSubTask
public void beginSubTask(long taskVolume)
- Specified by:
beginSubTask
in interfaceProgressTracker
-
setSteps
public void setSteps(long steps)
- Specified by:
setSteps
in interfaceProgressTracker
-
logSteps
public void logSteps(long steps)
- Specified by:
logSteps
in interfaceProgressTracker
-
beginSubTask
public void beginSubTask(java.lang.String expectedTaskDescription, long taskVolume)
- Specified by:
beginSubTask
in interfaceProgressTracker
-
endSubTask
public void endSubTask()
- Specified by:
endSubTask
in interfaceProgressTracker
-
endSubTask
public void endSubTask(java.lang.String expectedTaskDescription)
- Specified by:
endSubTask
in interfaceProgressTracker
-
logProgress
public void logProgress(long value)
- Specified by:
logProgress
in interfaceProgressTracker
-
logProgress
public void logProgress(long value, java.lang.String messageTemplate)
- Specified by:
logProgress
in interfaceProgressTracker
-
setVolume
public void setVolume(long volume)
- Specified by:
setVolume
in interfaceProgressTracker
-
currentVolume
public long currentVolume()
Description copied from interface:ProgressTracker
Returns the task volume of the currently running task orTask.UNKNOWN_VOLUME
if no task volume is set.- Specified by:
currentVolume
in interfaceProgressTracker
-
logMessage
public void logMessage(LogLevel level, java.lang.String message)
- Specified by:
logMessage
in interfaceProgressTracker
-
release
public void release()
- Specified by:
release
in interfaceProgressTracker
-
endSubTaskWithFailure
public void endSubTaskWithFailure()
- Specified by:
endSubTaskWithFailure
in interfaceProgressTracker
-
endSubTaskWithFailure
public void endSubTaskWithFailure(java.lang.String expectedTaskDescription)
- Specified by:
endSubTaskWithFailure
in interfaceProgressTracker
-
currentSubTask
@TestOnly public Task currentSubTask()
-
-