org.janusgraph.graphdb.relations

Class AbstractTypedRelation

java.lang.Object

org.janusgraph.graphdb.internal.AbstractElement

org.janusgraph.graphdb.relations.AbstractTypedRelation

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEdge, AbstractVertexProperty

public abstract class AbstractTypedRelation
extends AbstractElement
implements InternalRelation

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected InternalRelationType	type

Constructor Summary

Constructors

Constructor and Description
AbstractTypedRelation(long id, RelationType type)

Method Summary

Modifier and Type	Method and Description
org.apache.tinkerpop.gremlin.structure.Direction	direction(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Returns the direction of this relation from the perspective of the specified vertex.
protected Object	getCompareId() Long identifier used to compare elements.
RelationType	getType() Returns the type of this relation.
RelationIdentifier	id() Returns a unique identifier for this entity.
boolean	isIncidentOn(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Checks whether this relation is incident on the specified vertex.
boolean	isInvisible() Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.
boolean	isLoop() Checks whether this relation is a loop.
InternalRelation	it() Returns this relation in the current transactional context
long	longId() Returns the long-type representation of ID
<V> Iterator<org.apache.tinkerpop.gremlin.structure.Property<V>>	properties(String... keyNames)
<V> org.apache.tinkerpop.gremlin.structure.Property<V>	property(String key, V value) Sets the value for the given key on this element.
StandardJanusGraphTx	tx() Returns the transaction to which the element is currently bound or should be refreshed into
<O> O	value(String key) Retrieves the value associated with the given key on this vertex and casts it to the specified type.
<O> O	valueOrNull(PropertyKey key) Retrieves the value associated with the given key on this element and casts it to the specified type.
protected void	verifyAccess() Cannot currently throw exception when removed since internal logic relies on access to the edge beyond its removal.

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, toString, wait, wait, wait

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

getArity, getLen, getPropertyKeysDirect, getValueDirect, getVertex, removePropertyDirect, setPropertyDirect

Methods inherited from interface org.janusgraph.core.JanusGraphRelation

isEdge, isProperty

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

getLifeCycle, graph, setId

Methods inherited from interface org.janusgraph.core.JanusGraphElement

hasId, isLoaded, isNew, isRemoved, remove

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

keys, label, property, values

Field Detail

type

protected final InternalRelationType type

Constructor Detail

AbstractTypedRelation

public AbstractTypedRelation(long id,
                             RelationType type)

Method Detail

it

public InternalRelation it()

Description copied from interface: InternalRelation

Returns this relation in the current transactional context

Specified by:

it in interface InternalElement

Specified by:

it in interface InternalRelation

Returns:

tx

public final StandardJanusGraphTx tx()

Description copied from interface: InternalElement

Returns the transaction to which the element is currently bound or should be refreshed into

Specified by:

tx in interface InternalElement

Returns:

verifyAccess

protected final void verifyAccess()

Cannot currently throw exception when removed since internal logic relies on access to the edge beyond its removal. TODO: reconcile with access validation logic

direction

public org.apache.tinkerpop.gremlin.structure.Direction direction(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: JanusGraphRelation

Returns the direction of this relation from the perspective of the specified vertex.

Specified by:

direction in interface JanusGraphRelation

Parameters:

vertex - vertex on which the relation is incident

Returns:

The direction of this relation from the perspective of the specified vertex.

isIncidentOn

public boolean isIncidentOn(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: JanusGraphRelation

Checks whether this relation is incident on the specified vertex.

Specified by:

isIncidentOn in interface JanusGraphRelation

Parameters:

vertex - vertex to check incidence for

Returns:

true, if this relation is incident on the vertex, else false

isInvisible

public boolean isInvisible()

Description copied from interface: InternalElement

Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.

Specified by:

isInvisible in interface InternalElement

Overrides:

isInvisible in class AbstractElement

Returns:

isLoop

public boolean isLoop()

Description copied from interface: JanusGraphRelation

Checks whether this relation is a loop. An relation is a loop if it connects a vertex with itself.

Specified by:

isLoop in interface JanusGraphRelation

Returns:

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

getType

public RelationType getType()

Description copied from interface: JanusGraphRelation

Returns the type of this relation.

The type is either a label (EdgeLabel if this relation is an edge or a key (PropertyKey) if this relation is a property.

Specified by:

getType in interface JanusGraphRelation

Returns:

Type of this relation

longId

public long longId()

Description copied from interface: JanusGraphRelation

Returns the long-type representation of ID

Specified by:

longId in interface JanusGraphRelation

Returns:

id

public RelationIdentifier id()

Description copied from interface: JanusGraphElement

Returns a unique identifier for this entity.

The unique identifier may only be set when the transaction in which entity is created commits. Some entities are never assigned a unique identifier if they depend on a parent entity.

JanusGraph allocates blocks of identifiers and automatically assigns identifiers to elements automatically be default. This behavior can be partially overridden by setting GraphDatabaseConfiguration.ALLOW_SETTING_VERTEX_ID

Specified by:

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

Specified by:

id in interface Idfiable

Specified by:

id in interface JanusGraphElement

Overrides:

id in class AbstractElement

Returns:

The unique identifier for this entity

See Also:

JanusGraphElement.hasId()

property

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

Description copied from interface: JanusGraphElement

Sets the value for the given key on this element. The key must be defined to have Cardinality.SINGLE, otherwise this method throws an exception.

Specified by:

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

Specified by:

property in interface JanusGraphElement

Parameters:

key - the string identifying the key

value - the object value

valueOrNull

public <O> O valueOrNull(PropertyKey key)

Description copied from interface: JanusGraphElement

Retrieves the value associated with the given key on this element and casts it to the specified type. If the key has cardinality SINGLE, then there can be at most one value and this value is returned (or null). Otherwise a list of all associated values is returned, or an empty list if non exist.

Specified by:

valueOrNull in interface JanusGraphElement

Parameters:

key - key

Returns:

value or list of values associated with key

getCompareId

protected Object getCompareId()

Description copied from class: AbstractElement

Long identifier used to compare elements. Often, this is the same as AbstractElement.id() but some instances of elements may be considered the same even if their ids differ. In that case, this method should be overwritten to return an id that can be used for comparison.

Overrides:

getCompareId in class AbstractElement

Returns:

value

public <O> O value(String key)

Description copied from interface: JanusGraphRelation

Retrieves the value associated with the given key on this vertex and casts it to the specified type. If the key has cardinality SINGLE, then there can be at most one value and this value is returned (or null). Otherwise a list of all associated values is returned, or an empty list if non exist.

Specified by:

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

Specified by:

value in interface JanusGraphRelation

Parameters:

key - string identifying a key

Returns:

value or list of values associated with key

properties

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

Specified by:

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