org.janusgraph.graphdb.util

Class AllEdgesIterator

java.lang.Object

org.janusgraph.graphdb.util.AllEdgesIterator

All Implemented Interfaces:

Iterator<org.apache.tinkerpop.gremlin.structure.Edge>

public class AllEdgesIterator
extends Object
implements Iterator<org.apache.tinkerpop.gremlin.structure.Edge>

Defines an Iterator over all JanusGraphEdges connecting a provided set of vertices.

Given a set of vertices, one may be interested in all edges that are contained in the subgraph spanned by those vertices. This iterator will return these edges.

Author:

Matthias Bröcheler ([email protected]);

Constructor Summary

Constructors

Constructor and Description
AllEdgesIterator(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertexIterator) Returns an iterator over all edges incident on the vertices returned by the given Iterable over vertices.
AllEdgesIterator(Set<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertices) Returns an iterator over all edges contained in the subgraph spanned by the given vertices.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
org.apache.tinkerpop.gremlin.structure.Edge	next()
void	remove() Removing edges is not supported!

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

AllEdgesIterator

public AllEdgesIterator(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertexIterator)

Returns an iterator over all edges incident on the vertices returned by the given Iterable over vertices.

Note that this method assumes that the given Iterable will return all vertices in the connected component, otherwise the behavior of this method is undefined.

Parameters:

vertexIterator - Iterator over a set of vertices defining a connected component.

AllEdgesIterator

public AllEdgesIterator(Set<? extends org.apache.tinkerpop.gremlin.structure.Vertex> vertices)

Returns an iterator over all edges contained in the subgraph spanned by the given vertices.

This method will return all edges whose end points are contained in the given set of vertices.

Parameters:

vertices - Set of vertices

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<org.apache.tinkerpop.gremlin.structure.Edge>

next

public org.apache.tinkerpop.gremlin.structure.Edge next()

Specified by:

next in interface Iterator<org.apache.tinkerpop.gremlin.structure.Edge>

remove

public void remove()

Removing edges is not supported!

Specified by:

remove in interface Iterator<org.apache.tinkerpop.gremlin.structure.Edge>

Throws:

UnsupportedOperationException - if invoked