org.janusgraph.graphdb.olap.computer

Class VertexProgramScanJob.Executor

java.lang.Object

org.janusgraph.graphdb.olap.AbstractScanJob

org.janusgraph.graphdb.olap.VertexJobConverter

org.janusgraph.graphdb.olap.computer.VertexProgramScanJob.Executor

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, ScanJob

Enclosing class:

VertexProgramScanJob<M>

public static class VertexProgramScanJob.Executor
extends VertexJobConverter
implements Closeable

Field Summary

Fields inherited from class org.janusgraph.graphdb.olap.VertexJobConverter

GHOST_VERTEX_COUNT, job, TRUNCATED_ENTRY_LISTS, VERTEX_EXISTS_QUERY

Fields inherited from class org.janusgraph.graphdb.olap.AbstractScanJob

graph, tx

Method Summary

Modifier and Type	Method and Description
VertexProgramScanJob.Executor	clone() Returns a clone of this ScanJob.
void	close()
List<SliceQuery>	getQueries() Returns one or more SliceQuery instances belonging to this ScanJob.
void	workerIterationEnd(ScanMetrics metrics) Invoked after a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob.
void	workerIterationStart(Configuration jobConfig, Configuration graphConfig, ScanMetrics metrics) Invoked before a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob.

Methods inherited from class org.janusgraph.graphdb.olap.VertexJobConverter

convert, convert, getKeyFilter, process, startTransaction

Methods inherited from class org.janusgraph.graphdb.olap.AbstractScanJob

getVertexId, isGhostVertex, open

Methods inherited from class java.lang.Object

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

Method Detail

getQueries

public List<SliceQuery> getQueries()

Description copied from interface: ScanJob

Returns one or more SliceQuery instances belonging to this ScanJob.

Before calling ScanJob.process(org.janusgraph.diskstorage.StaticBuffer, java.util.Map, ScanMetrics), users of this interface must check that the key in question contains at least one entry matching the initial SliceQuery returned by this method. See the javadoc for the process method for more information.

If this method returns more than one query, then the initial query's lower bound must be all zero bits and the initial query's upper bound must be all one bits (per the preconditions in StandardScannerExecutor, the reference ScanJob executor).

Specified by:

getQueries in interface ScanJob

Overrides:

getQueries in class VertexJobConverter

Returns:

one or more queries

workerIterationStart

public void workerIterationStart(Configuration jobConfig,
                                 Configuration graphConfig,
                                 ScanMetrics metrics)

Description copied from interface: ScanJob

Invoked before a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob. Can be used to initialize the iteration. This method is called exactly once for each before a block of computation. This method is semantically aligned with VertexProgram.workerIterationStart(Memory) This method may not be called if there is no data to be processed. Correspondingly, the end method won't be called either. No-op default implementation.

Specified by:

workerIterationStart in interface ScanJob

Overrides:

workerIterationStart in class VertexJobConverter

Parameters:

jobConfig - configuration for this particular job

graphConfig - configuration options for the entire graph against which this job is executed

metrics - ScanMetrics for this job

workerIterationEnd

public void workerIterationEnd(ScanMetrics metrics)

Description copied from interface: ScanJob

Invoked after a block of computation (i.e. multiple process() calls) is handed to this particular ScanJob. Can be used to close any resources held by this job. This method is called exactly once for each after a block of computation. This method is semantically aligned with VertexProgram.workerIterationEnd(Memory) This method may not be called if there is no data to be processed. Correspondingly, the start method won't be called either. No-op default implementation.

Specified by:

workerIterationEnd in interface ScanJob

Overrides:

workerIterationEnd in class VertexJobConverter

Parameters:

metrics - ScanMetrics for this job

clone

public VertexProgramScanJob.Executor clone()

Description copied from interface: ScanJob

Returns a clone of this ScanJob. The clone will not yet be initialized for computation but all of its internal state (if any) must match that of the original copy.

Specified by:

clone in interface ScanJob

Overrides:

clone in class VertexJobConverter

Returns:

A clone of this ScanJob

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractScanJob