Class CombineStep<S,E>
- java.lang.Object
-
- org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,E>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<S,List<?>>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.map.CombineStep<S,E>
-
- All Implemented Interfaces:
Serializable
,AutoCloseable
,Cloneable
,Iterator<Traverser.Admin<List<?>>>
,Step<S,List<?>>
,TraversalParent
,ListFunction
public final class CombineStep<S,E> extends ScalarMapStep<S,List<?>> implements TraversalParent, ListFunction
A map step that returns the combination of the traverser and the provided arguments. This is also commonly known as concatenation or append.- See Also:
- Serialized Form
-
-
Field Summary
-
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 CombineStep(Traversal.Admin traversal, Object values)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CombineStep<S,E>
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.List<Traversal.Admin<S,E>>
getLocalChildren()
Set<TraverserRequirement>
getRequirements()
Provide the necessaryTraverserRequirement
that must be met by the traverser in order for the step to function properly.String
getStepName()
Template method used for retrieving the implementing Step's name.int
hashCode()
protected List<?>
map(Traverser.Admin<S> traverser)
void
setTraversal(Traversal.Admin<?,?> parentTraversal)
Set theTraversal
that this step is contained within.-
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep
processNextStart
-
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, toString
-
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.util.ListFunction
convertArgumentToCollection, convertArgumentToSet, convertTraversalToCollection, convertTraversalToSet, convertTraverserToCollection, convertTraverserToSet
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
-
-
-
-
Constructor Detail
-
CombineStep
public CombineStep(Traversal.Admin traversal, Object values)
-
-
Method Detail
-
getStepName
public String getStepName()
Description copied from interface:ListFunction
Template method used for retrieving the implementing Step's name.- Specified by:
getStepName
in interfaceListFunction
- Returns:
- this step's name.
-
map
protected List<?> map(Traverser.Admin<S> traverser)
- Specified by:
map
in classScalarMapStep<S,List<?>>
-
getLocalChildren
public List<Traversal.Admin<S,E>> getLocalChildren()
- Specified by:
getLocalChildren
in interfaceTraversalParent
-
getRequirements
public Set<TraverserRequirement> getRequirements()
Description copied from interface:Step
Provide the necessaryTraverserRequirement
that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.- Specified by:
getRequirements
in interfaceStep<S,E>
- Returns:
- the set of requirements
-
setTraversal
public void setTraversal(Traversal.Admin<?,?> parentTraversal)
Description copied from interface:Step
Set theTraversal
that this step is contained within.- Specified by:
setTraversal
in interfaceStep<S,E>
- Overrides:
setTraversal
in classAbstractStep<S,List<?>>
- Parameters:
parentTraversal
- the new traversal for this step
-
clone
public CombineStep<S,E> 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 whenStep.reset()
is called. Moreover, the previous and next steps should be set toEmptyStep
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStep<S,List<?>>
-
-