fr.inria.atlanmod.neoemf.data.blueprints.internal.graph

Class ElementEdge

java.lang.Object

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.AbstractBasedObject<T>

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.AbstractGraphBasedObject<E,G>

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdElement<com.tinkerpop.blueprints.Edge,G>

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdEdge<ModelGraph>

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.ElementEdge

All Implemented Interfaces:

com.tinkerpop.blueprints.Edge, com.tinkerpop.blueprints.Element

@ParametersAreNonnullByDefault
public class ElementEdge
extends IdEdge<ModelGraph>

An Edge representing the relation between an element and another.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PROPERTY_POSITION The property key used to define the position of an edge.

Fields inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdElement

propertyBased

Fields inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.AbstractGraphBasedObject

graph

Fields inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.AbstractBasedObject

base

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElementEdge(com.tinkerpop.blueprints.Edge base, ModelGraph graph) Constructs a new ElementEdge.

Method Summary

Modifier and Type	Method and Description
protected static ElementEdge	create(ModelGraph graph, ElementVertex referencing, Id referenced, String label) Creates a new ElementEdge between the referencing vertex and its reference.
protected static ElementEdge	create(ModelGraph graph, ElementVertex referencing, Id referenced, String label, int position) Creates a new ElementEdge between the referencing vertex and its positionned reference.
static ElementEdge	from(com.tinkerpop.blueprints.Edge baseEdge, ModelGraph graph) Creates a new instance of ElementEdge on the baseEdge.
int	getPosition() Returns the position of this relation for the referencing vertex.
ElementVertex	getReferencedVertex() Returns the referenced vertex of this relation.
ElementVertex	getReferencingVertex() Returns the referencing vertex of this relation.
void	updatePosition(IntUnaryOperator updateFunc) Updates the position of this relation for the referencing vertex with the specified function.

Methods inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdEdge

getLabel, getVertex, getVertex, remove, toString

Methods inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdElement

equals, getId, getProperty, getPropertyKeys, hashCode, removeProperty, setProperty

Methods inherited from class fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.AbstractBasedObject

getBaseElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, removeProperty, setProperty

Field Detail

PROPERTY_POSITION

protected static final String PROPERTY_POSITION

The property key used to define the position of an edge.

See Also:

Constant Field Values

Constructor Detail

ElementEdge

protected ElementEdge(com.tinkerpop.blueprints.Edge base,
                      ModelGraph graph)

Constructs a new ElementEdge.

Parameters:

base - the base edge

graph - the graph that owns this edge

Method Detail

from

@Nonnull
public static ElementEdge from(com.tinkerpop.blueprints.Edge baseEdge,
                                         ModelGraph graph)

Creates a new instance of ElementEdge on the baseEdge.

Parameters:

baseEdge - the base edge

graph - the graph that owns the edge

Returns:

the element edge

create

@Nonnull
protected static ElementEdge create(ModelGraph graph,
                                              ElementVertex referencing,
                                              Id referenced,
                                              String label)

Creates a new ElementEdge between the referencing vertex and its reference.

Parameters:

graph - the graph that owns the edge

referencing - the referencing vertex

referenced - the identifier of the referenced vertex

label - the label to identify the relation

Returns:

the element edge that has been added in the graph

create

@Nonnull
protected static ElementEdge create(ModelGraph graph,
                                              ElementVertex referencing,
                                              Id referenced,
                                              String label,
                                              @Nonnegative
                                              int position)

Creates a new ElementEdge between the referencing vertex and its positionned reference.

Parameters:

graph - the graph that owns the edge

referencing - the referencing vertex

referenced - the identifier of the referenced vertex

label - the label to identify the relation

position - the index of the relation for the referencing vertex (for multi-valud references)

Returns:

the element edge that has been added in the graph

getReferencedVertex

@Nonnull
public ElementVertex getReferencedVertex()

Returns the referenced vertex of this relation.

Returns:

the referenced vertex

getReferencingVertex

@Nonnull
public ElementVertex getReferencingVertex()

Returns the referencing vertex of this relation.

Returns:

the referencing vertex

getPosition

@Nonnegative
public int getPosition()

Returns the position of this relation for the referencing vertex.

Returns:

the position

updatePosition

public void updatePosition(IntUnaryOperator updateFunc)

Updates the position of this relation for the referencing vertex with the specified function.

Parameters:

updateFunc - the function to update the current position