com.tinkerpop.gremlin.process.graph.step.map.match

Class SerialEnumerator<T>

java.lang.Object

com.tinkerpop.gremlin.process.graph.step.map.match.SerialEnumerator<T>

All Implemented Interfaces:

Enumerator<T>

public class SerialEnumerator<T>
extends java.lang.Object
implements Enumerator<T>

An enumerator which consumes values from an iterator and maps each value to a secondary enumerator (for example, a join) Enumerated indices cover all solutions in the secondary enumerators, in ascending order according to the value iterator and the enumerators' own indices.

Author:

Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
SerialEnumerator(java.lang.String name, java.util.Iterator<T> iterator, java.util.function.Function<T,Enumerator<T>> constructor)

Method Summary

Modifier and Type	Method and Description
int	size()
boolean	visitSolution(int index, java.util.function.BiConsumer<java.lang.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

SerialEnumerator

public SerialEnumerator(java.lang.String name,
                        java.util.Iterator<T> iterator,
                        java.util.function.Function<T,Enumerator<T>> constructor)

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 index,
                             java.util.function.BiConsumer<java.lang.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:

index - 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