Package uk.gov.gchq.gaffer.tinkerpop

Class GafferPopEdge

java.lang.Object

uk.gov.gchq.gaffer.tinkerpop.GafferPopElement

uk.gov.gchq.gaffer.tinkerpop.GafferPopEdge

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Edge, org.apache.tinkerpop.gremlin.structure.Element

public final class GafferPopEdge
extends GafferPopElement
implements org.apache.tinkerpop.gremlin.structure.Edge

A GafferPopEdge is an GafferPopElement and Edge.

inVertex() and outVertex() methods are not supported as it is possible for a edge to have multiple in vertices and multiple out vertices (due to the mapping to a TinkerPop vertex to Gaffer Entity. Use vertices(Direction) instead.

An ID is required to be a List which contains the source, group, and destination of an edge.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

org.apache.tinkerpop.gremlin.structure.Edge.Exceptions

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Element

org.apache.tinkerpop.gremlin.structure.Element.Exceptions

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor	Description
GafferPopEdge(String label, Object outVertex, Object inVertex, GafferPopGraph graph)

Method Summary

Modifier and Type	Method	Description
org.apache.tinkerpop.gremlin.structure.Vertex	inVertex()
Set<String>	keys()
org.apache.tinkerpop.gremlin.structure.Vertex	outVertex()
<V> Iterator<org.apache.tinkerpop.gremlin.structure.Property<V>>	properties(String... propertyKeys)
<V> org.apache.tinkerpop.gremlin.structure.Property<V>	property(String key)
<V> org.apache.tinkerpop.gremlin.structure.Property<V>	property(String key, V value)
<V> org.apache.tinkerpop.gremlin.structure.Property<V>	propertyWithoutUpdate(String key, V value)	Updates the properties attached to this Edge but without modifying the underlying graph.
void	remove()
String	toString()
Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction)

Methods inherited from class uk.gov.gchq.gaffer.tinkerpop.GafferPopElement

equals, graph, hashCode, id, isReadOnly, label, setReadOnly

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

bothVertices

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element

graph, id, label, value, values

Constructor Detail

GafferPopEdge

public GafferPopEdge(String label,
                     Object outVertex,
                     Object inVertex,
                     GafferPopGraph graph)

Method Detail

property

public <V> org.apache.tinkerpop.gremlin.structure.Property<V> property(String key,
                                                                       V value)

Specified by:

property in interface org.apache.tinkerpop.gremlin.structure.Element

property

public <V> org.apache.tinkerpop.gremlin.structure.Property<V> property(String key)

Specified by:

property in interface org.apache.tinkerpop.gremlin.structure.Element

properties

public <V> Iterator<org.apache.tinkerpop.gremlin.structure.Property<V>> properties(String... propertyKeys)

Specified by:

properties in interface org.apache.tinkerpop.gremlin.structure.Edge

Specified by:

properties in interface org.apache.tinkerpop.gremlin.structure.Element

propertyWithoutUpdate

public <V> org.apache.tinkerpop.gremlin.structure.Property<V> propertyWithoutUpdate(String key,
                                                                                    V value)

Updates the properties attached to this Edge but without modifying the underlying graph. This method is largely a helper for generating GafferPopEdge objects from Gaffer Edge returned from the graph. In this situation we want to be able to create a representative GafferPopEdge but without modifying the one stored in the graph.

Type Parameters:

V - Value type

Parameters:

key - The key

value - The value

Returns:

The property

vertices

public Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction)

Specified by:

vertices in interface org.apache.tinkerpop.gremlin.structure.Edge

keys

public Set<String> keys()

Specified by:

keys in interface org.apache.tinkerpop.gremlin.structure.Element

remove

public void remove()

Specified by:

remove in interface org.apache.tinkerpop.gremlin.structure.Element

Overrides:

remove in class GafferPopElement

toString

public String toString()

Overrides:

toString in class Object

outVertex

public org.apache.tinkerpop.gremlin.structure.Vertex outVertex()

Specified by:

outVertex in interface org.apache.tinkerpop.gremlin.structure.Edge

inVertex

public org.apache.tinkerpop.gremlin.structure.Vertex inVertex()

Specified by:

inVertex in interface org.apache.tinkerpop.gremlin.structure.Edge