Class DefaultTraversal<S, E>

A traversal represents a directed walk over a graph.

Inheritance
System.Object
DefaultTraversal<S, E>
GraphTraversal<S, E>
Implements
System.Collections.Generic.IEnumerator
System.Collections.Generic.IEnumerator<E>
System.IDisposable
System.Collections.IEnumerator
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Gremlin.Net.Process.Traversal
Assembly: cs.temp.dll.dll
Syntax
public abstract class DefaultTraversal<S, E> : ITraversal<S, E>, ITraversal, IEnumerator, IEnumerator<E>, IDisposable, IEnumerator
Type Parameters
Name Description
S
E

Properties

Bytecode

Gets the Bytecode representation of this traversal.

Declaration
public Bytecode Bytecode { get; protected set; }
Property Value
Type Description
Bytecode

Current

Declaration
public E Current { get; }
Property Value
Type Description
E

IsAnonymous

Determines if this traversal was spawned anonymously or not.

Declaration
public bool IsAnonymous { get; protected set; }
Property Value
Type Description
System.Boolean

TraversalStrategies

Gets or sets the ITraversalStrategy strategies of this traversal.

Declaration
protected ICollection<ITraversalStrategy> TraversalStrategies { get; set; }
Property Value
Type Description
System.Collections.Generic.ICollection<ITraversalStrategy>

Traversers

Gets or sets the Traverser's of this traversal that hold the results of the traversal.

Declaration
public IEnumerable<Traverser> Traversers { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Traverser>

Methods

Dispose()

Declaration
public void Dispose()

HasNext()

Declaration
public bool HasNext()
Returns
Type Description
System.Boolean

Iterate()

Iterates all Traverser instances in the traversal.

Declaration
public ITraversal<S, E> Iterate()
Returns
Type Description
ITraversal<S, E>

The fully drained traversal.

MoveNext()

Declaration
public bool MoveNext()
Returns
Type Description
System.Boolean

Next()

Gets the next result from the traversal.

Declaration
public E Next()
Returns
Type Description
E

The result.

Next(Int32)

Gets the next n-number of results from the traversal.

Declaration
public IEnumerable<E> Next(int amount)
Parameters
Type Name Description
System.Int32 amount

The number of results to get.
Returns
Type Description
System.Collections.Generic.IEnumerable<E>

The n-results.

NextTraverser()

Gets the next Traverser.

Declaration
public Traverser NextTraverser()
Returns
Type Description
Traverser

The next Traverser.

Promise<TReturn>(Func<ITraversal<S, E>, TReturn>, CancellationToken)

Starts a promise to execute a function on the current traversal that will be completed in the future.

Declaration
public async Task<TReturn> Promise<TReturn>(Func<ITraversal<S, E>, TReturn> callback, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Func<ITraversal<S, E>, TReturn> callback

The function to execute on the current traversal.
CancellationToken cancellationToken

The token to cancel the operation. The default value is None.
Returns
Type Description
System.Threading.Tasks.Task<TReturn>

The result of the executed callback.
Type Parameters
Name Description
TReturn

The return type of the callback.

Reset()

Reset is not supported.

Declaration
public void Reset()
Exceptions
Type Condition
System.NotSupportedException

Thrown always as this operation is not supported.

ToList()

Puts all the results into a System.Collections.Generic.List<T>.

Declaration
public IList<E> ToList()
Returns
Type Description
System.Collections.Generic.IList<E>

The results in a list.

ToSet()

Puts all the results into a .

Declaration
public ISet<E> ToSet()
Returns
Type Description
System.Collections.Generic.ISet<E>

The results in a set.

Explicit Interface Implementations

ITraversal.Iterate()

Declaration
ITraversal ITraversal.Iterate()
Returns
Type Description
ITraversal

Implements

System.Collections.Generic.IEnumerator
System.Collections.Generic.IEnumerator<T>
System.IDisposable
System.Collections.IEnumerator