ProgramVertexProgramStep (Apache TinkerPop 3.7.1 API)

java.lang.Object
- org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<ComputerResult,ComputerResult>
- - org.apache.tinkerpop.gremlin.process.computer.traversal.step.map.VertexProgramStep
  - - org.apache.tinkerpop.gremlin.process.computer.traversal.step.map.ProgramVertexProgramStep

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<ComputerResult>>, VertexComputing, Step<ComputerResult,ComputerResult>
```
public final class ProgramVertexProgramStep
extends VertexProgramStep
```
Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.apache.tinkerpop.gremlin.process.computer.traversal.step.map.VertexProgramStep
  computer, first, ROOT_TRAVERSAL, STEP_ID
- Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
  id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors
Constructor Description

ProgramVertexProgramStep(Traversal.Admin traversal, VertexProgram vertexProgram)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`VertexProgram`	`generateProgram(Graph graph, Memory memory)`	Generate the `VertexProgram`.
`Set<TraverserRequirement>`	`getRequirements()`	Provide the necessary `TraverserRequirement` that must be met by the traverser in order for the step to function properly.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class org.apache.tinkerpop.gremlin.process.computer.traversal.step.map.VertexProgramStep
getComputer, isEndStep, previousTraversalVertexProgram, processNextStart, setComputer

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step
equals

- Constructor Detail
  - ProgramVertexProgramStep
```
public ProgramVertexProgramStep(Traversal.Admin traversal,
                                VertexProgram vertexProgram)
```
- Method Detail
  - generateProgram
```
public VertexProgram generateProgram(Graph graph,
                                     Memory memory)
```
    Description copied from interface: VertexComputing
    
    Generate the VertexProgram.
    
    Parameters:
    
    graph - the Graph that the program will be executed over.
    
    memory - the Memory from the previous OLAP job if it exists, else its an empty memory structure.
    
    Returns:
    
    the generated vertex program instance.
  - getRequirements
```
public Set<TraverserRequirement> getRequirements()
```
    Description copied from interface: Step
    
    Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.
    
    Returns:
    
    the set of requirements
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractStep<ComputerResult,ComputerResult>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractStep<ComputerResult,ComputerResult>