org.janusgraph.graphdb.relations

Class AbstractEdge

java.lang.Object

org.janusgraph.graphdb.internal.AbstractElement

org.janusgraph.graphdb.relations.AbstractTypedRelation

org.janusgraph.graphdb.relations.AbstractEdge

All Implemented Interfaces:

Comparable<JanusGraphElement>, org.apache.tinkerpop.gremlin.structure.Edge, org.apache.tinkerpop.gremlin.structure.Element, Idfiable, JanusGraphEdge, JanusGraphElement, JanusGraphRelation, InternalElement, InternalRelation, Removable

Direct Known Subclasses:

CacheEdge, StandardEdge

public abstract class AbstractEdge
extends AbstractTypedRelation
implements JanusGraphEdge

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class org.janusgraph.graphdb.relations.AbstractTypedRelation

type

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
AbstractEdge(long id, EdgeLabel label, InternalVertex start, InternalVertex end)

Method Summary

Modifier and Type	Method and Description
int	getArity() Number of vertices on this relation.
int	getLen() Number of vertices on this relation that are aware of its existence.
InternalVertex	getVertex(int pos) Returns the vertex at the given position (0=OUT, 1=IN) of this relation
boolean	isEdge() Checks whether this relation is an edge.
boolean	isProperty() Checks whether this relation is a property.
String	label()
JanusGraphVertex	otherVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Returns the vertex at the opposite end of the edge.
void	setVertexAt(int pos, InternalVertex vertex)
String	toString()
JanusGraphVertex	vertex(org.apache.tinkerpop.gremlin.structure.Direction dir) Returns the vertex for the specified direction.

Methods inherited from class org.janusgraph.graphdb.relations.AbstractTypedRelation

direction, getCompareId, getType, id, isIncidentOn, isInvisible, isLoop, it, longId, properties, property, tx, value, valueOrNull, verifyAccess

Methods inherited from class org.janusgraph.graphdb.internal.AbstractElement

clone, compare, compareTo, equals, hashCode, hasId, isLoaded, isNew, isRemoved, isTemporaryId, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.janusgraph.core.JanusGraphEdge

edgeLabel, inVertex, outVertex, vertices

Methods inherited from interface org.janusgraph.core.JanusGraphRelation

direction, getType, isIncidentOn, isLoop, longId, value

Methods inherited from interface org.janusgraph.core.JanusGraphElement

graph, hasId, id, isLoaded, isNew, isRemoved, property, remove, valueOrNull

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

keys, properties, property, values

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

bothVertices, properties

Methods inherited from interface org.janusgraph.graphdb.internal.InternalRelation

getPropertyKeysDirect, getValueDirect, removePropertyDirect, setPropertyDirect

Methods inherited from interface org.janusgraph.graphdb.internal.InternalElement

getLifeCycle, graph, setId

Constructor Detail

AbstractEdge

public AbstractEdge(long id,
                    EdgeLabel label,
                    InternalVertex start,
                    InternalVertex end)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

label

public String label()

Specified by:

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

setVertexAt

public void setVertexAt(int pos,
                        InternalVertex vertex)

getVertex

public InternalVertex getVertex(int pos)

Description copied from interface: InternalRelation

Returns the vertex at the given position (0=OUT, 1=IN) of this relation

Specified by:

getVertex in interface InternalRelation

Returns:

getArity

public int getArity()

Description copied from interface: InternalRelation

Number of vertices on this relation.

Specified by:

getArity in interface InternalRelation

Returns:

getLen

public int getLen()

Description copied from interface: InternalRelation

Number of vertices on this relation that are aware of its existence. This number will differ from InternalRelation.getArity()

Specified by:

getLen in interface InternalRelation

vertex

public JanusGraphVertex vertex(org.apache.tinkerpop.gremlin.structure.Direction dir)

Description copied from interface: JanusGraphEdge

Returns the vertex for the specified direction. The direction cannot be Direction.BOTH.

Specified by:

vertex in interface JanusGraphEdge

Parameters:

dir - Direction of IN or OUT

Returns:

the vertex for the specified direction

otherVertex

public JanusGraphVertex otherVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: JanusGraphEdge

Returns the vertex at the opposite end of the edge.

Specified by:

otherVertex in interface JanusGraphEdge

Parameters:

vertex - vertex on which this edge is incident

Returns:

The vertex at the opposite end of the edge.

isProperty

public boolean isProperty()

Description copied from interface: JanusGraphRelation

Checks whether this relation is a property.

Specified by:

isProperty in interface JanusGraphRelation

Returns:

true, if this relation is a property, else false.

See Also:

JanusGraphVertexProperty

isEdge

public boolean isEdge()

Description copied from interface: JanusGraphRelation

Checks whether this relation is an edge.

Specified by:

isEdge in interface JanusGraphRelation

Returns:

true, if this relation is an edge, else false.

See Also:

JanusGraphEdge