org.apache.tinkerpop.gremlin.process.computer.traversal.step.map

Class ConnectedComponentVertexProgramStep

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.ConnectedComponentVertexProgramStep

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<ComputerResult>>, VertexComputing, Step<ComputerResult,ComputerResult>, Configuring, Parameterizing, TraversalParent

public final class ConnectedComponentVertexProgramStep
extends VertexProgramStep
implements TraversalParent, Configuring

Author:

Stephen Mallette (http://stephen.genoprime.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 and Description
ConnectedComponentVertexProgramStep(Traversal.Admin traversal)

Method Summary

Modifier and Type	Method and Description
ConnectedComponentVertexProgramStep	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
void	configure(Object... keyValues) Accept a configuration to the Step.
ConnectedComponentVertexProgram	generateProgram(Graph graph, Memory memory) Generate the VertexProgram.
Parameters	getParameters() Gets the parameters on the step.
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, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasNext, next, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getLocalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild

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

equals, getRequirements

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

ConnectedComponentVertexProgramStep

public ConnectedComponentVertexProgramStep(Traversal.Admin traversal)

Method Detail

configure

public void configure(Object... keyValues)

Description copied from interface: Configuring

Accept a configuration to the Step. Note that this interface extends Parameterizing and so there is an expectation that the Step implementation will have a Parameters instance that will house any values passed to this method. Storing these configurations in Parameters is not a requirement however, IF the configuration is an expected option for the step and can be stored on a member field that can be accessed on the step by more direct means (i.e. like a getter method).

Specified by:

configure in interface Configuring

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<ComputerResult,ComputerResult>

toString

public String toString()

Overrides:

toString in class AbstractStep<ComputerResult,ComputerResult>

generateProgram

public ConnectedComponentVertexProgram generateProgram(Graph graph,
                                                       Memory memory)

Description copied from interface: VertexComputing

Generate the VertexProgram.

Specified by:

generateProgram in interface VertexComputing

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.

clone

public ConnectedComponentVertexProgramStep clone()

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when Step.reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<ComputerResult,ComputerResult>

Overrides:

clone in class AbstractStep<ComputerResult,ComputerResult>

Returns:

The cloned step