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

Class InnerJoinEnumerator<T>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.map.match.InnerJoinEnumerator<T>

All Implemented Interfaces:

Enumerator<T>

public class InnerJoinEnumerator<T>
extends Object
implements Enumerator<T>

An Enumerator which joins the solutions of a base Enumerator according to repeated variables

Note: this Enumerator requires random access to its base Enumerator, as it maintains a list of indices at which valid solutions are found, and visits only those indices.

Author:

Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
InnerJoinEnumerator(Enumerator<T> baseEnumerator, Set<String> joinVariables)

Method Summary

Modifier and Type	Method and Description
int	size()
boolean	visitSolution(int i, BiConsumer<String,T> visitor) Provides access to a solution, allowing it to be printed, put into a map, etc.

Methods inherited from class java.lang.Object

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

Constructor Detail

InnerJoinEnumerator

public InnerJoinEnumerator(Enumerator<T> baseEnumerator,
                           Set<String> joinVariables)

Method Detail

size

public int size()

Specified by:

size in interface Enumerator<T>

Returns:

the number of solutions so far known; the enumerator has at least this many. This should be a relatively cheap operation.

visitSolution

public boolean visitSolution(int i,
                             BiConsumer<String,T> visitor)

Description copied from interface: Enumerator

Provides access to a solution, allowing it to be printed, put into a map, etc.

Specified by:

visitSolution in interface Enumerator<T>

Parameters:

i - the index of the solution

visitor - a consumer for each key/value pair in the solution

Returns:

whether a solution exists at the given index and was visited