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

Class ElementVertex

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.Vertex,G>

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

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

All Implemented Interfaces:

com.tinkerpop.blueprints.Element, com.tinkerpop.blueprints.Vertex

@ParametersAreNonnullByDefault
public class ElementVertex
extends IdVertex<ModelGraph>

A Vertex representing an element that can have a meta-class and a container.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DELIMITER The delimiter used to separate the property name and its value in a composed property.
protected static String	PROPERTY_SIZE The property key used to define the number of edges with a specific label.

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

Method Summary

Modifier and Type	Method and Description
static ElementVertex	from(com.tinkerpop.blueprints.Vertex baseVertex, ModelGraph graph) Retrieves the ElementVertex that wraps the baseVertex, or creates a new instance on it.
Optional<ClassVertex>	getClassVertex() Returns the meta-class vertex.
Optional<ContainingEdge>	getContainingEdge() Returns the containing edge.
Id	getElementId() Returns the converted identifier of this element vertex.
Object	getId()
Optional<ElementVertex>	getReference(FeatureBean feature) Returns the reference of the feature.
Optional<ElementVertex>	getReference(FeatureBean feature, int position) Returns the reference of the feature at the defined position.
Iterable<ElementEdge>	getReferenceEdges(FeatureBean feature) Returns all references of the feature.
Iterable<ElementEdge>	getReferenceEdges(FeatureBean feature, int startPosition, int endPosition) Returns all references of the feature between the startPosition and the endPosition.
int	getSize(FeatureBean feature) Returns the size of the feature.
<V> Optional<V>	getValue(FeatureBean feature) Returns the value of the feature.
<V> Optional<V>	getValue(FeatureBean feature, int position) Returns the value of the feature at the defined position.
<V> Iterable<V>	getValues(FeatureBean feature) Returns all values of the feature.
void	moveValue(FeatureBean feature, int sourceIndex, int targetIndex) Moves the current value of the specified feature from the sourceIndex to the targetIndex.
ElementVertexQuery	query()
void	removeContainingEdge() Removes the containing edge.
void	removeReferences(FeatureBean feature) Removes the current reference of the feature.
void	removeValue(FeatureBean feature) Removes the current value of the feature.
void	removeValue(FeatureBean feature, int position) Removes the current value of the feature at the defined position.
Optional<ElementVertex>	replaceReference(FeatureBean feature, int position, Id reference) Replaces the current reference of the feature at the defined position.
<V> Optional<V>	replaceValue(FeatureBean feature, int position, V value) Replaces the current value of the feature at the defined position.
boolean	setClassVertex(ClassBean bean) Defines the meta-class vertex from the specified bean.
void	setContainingEdge(SingleFeatureBean bean) Defines the containing edge from the specified bean.
Optional<ElementVertex>	setReference(FeatureBean feature, Id reference) Replaces the current reference of the feature by the specified reference.
void	setReference(FeatureBean feature, int position, Id reference) Defines the current reference of the feature at the defined position.
void	setSize(FeatureBean feature, int size) Defines the size of the feature.
<V> void	setValue(FeatureBean feature, int position, V value) Defines the current value of the feature at the defined position.
<V> Optional<V>	setValue(FeatureBean feature, V value) Replaces the current value of the feature by the specified value.

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

addEdge, addEdge, getEdge, getEdge, getEdges, getEdges, getVertex, getVertex, getVertices, getVertices, remove, toString

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

equals, 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

getProperty, getPropertyKeys, removeProperty, setProperty

Field Detail

DELIMITER

protected static final String DELIMITER

The delimiter used to separate the property name and its value in a composed property.

See Also:

format(FeatureBean, Object), Constant Field Values

PROPERTY_SIZE

protected static final String PROPERTY_SIZE

The property key used to define the number of edges with a specific label.

See Also:

Constant Field Values

Method Detail

from

@Nonnull
public static ElementVertex from(com.tinkerpop.blueprints.Vertex baseVertex,
                                           ModelGraph graph)

Retrieves the ElementVertex that wraps the baseVertex, or creates a new instance on it.

Parameters:

baseVertex - the base vertex

graph - the graph that owns this vertex

Returns:

the element vertex

getId

@Nonnull
public Object getId()

Specified by:

getId in interface com.tinkerpop.blueprints.Element

Overrides:

getId in class IdElement<com.tinkerpop.blueprints.Vertex,ModelGraph>

getElementId

@Nonnull
public Id getElementId()

Returns the converted identifier of this element vertex.

Returns:

the converted identifier

query

@Nonnull
public ElementVertexQuery query()

Specified by:

query in interface com.tinkerpop.blueprints.Vertex

Overrides:

query in class IdVertex<ModelGraph>

getClassVertex

@Nonnull
public Optional<ClassVertex> getClassVertex()

Returns the meta-class vertex.

Returns:

an Optional containing the meta-class vertex

setClassVertex

public boolean setClassVertex(ClassBean bean)

Defines the meta-class vertex from the specified bean. If the meta-class is already defined, then this method does nothing.

Parameters:

bean - the simple representation of the meta-class vertex

Returns:

true if the meta-class has been defined for this vertex, false if the meta-class was already defined

getContainingEdge

@Nonnull
public Optional<ContainingEdge> getContainingEdge()

Returns the containing edge.

Returns:

an Optional containing the containing edge

setContainingEdge

public void setContainingEdge(SingleFeatureBean bean)

Defines the containing edge from the specified bean.

Parameters:

bean - the simple representation of the containing edge

removeContainingEdge

public void removeContainingEdge()

Removes the containing edge.

getSize

@Nonnegative
public int getSize(FeatureBean feature)

Returns the size of the feature.

Parameters:

feature - the feature

Returns:

the size

setSize

public void setSize(FeatureBean feature,
                    @Nonnegative
                    int size)

Defines the size of the feature.

Parameters:

feature - the feature

size - the new size

getValue

@Nonnull
public <V> Optional<V> getValue(FeatureBean feature)

Returns the value of the feature.

Type Parameters:

V - the type of the value

Parameters:

feature - the feature

Returns:

an Optional containing the value

setValue

@Nonnull
public <V> Optional<V> setValue(FeatureBean feature,
                                          V value)

Replaces the current value of the feature by the specified value.

Type Parameters:

V - the type of the value

Parameters:

feature - the feature

value - the new value

Returns:

an Optional containing the replaced value

removeValue

public void removeValue(FeatureBean feature)

Removes the current value of the feature.

Parameters:

feature - the feature

getValue

@Nonnull
public <V> Optional<V> getValue(FeatureBean feature,
                                          @Nonnegative
                                          int position)

Returns the value of the feature at the defined position.

Type Parameters:

V - the type of the value

Parameters:

feature - the feature

position - the position of the value

Returns:

an Optional containing the value

getValues

@Nonnull
public <V> Iterable<V> getValues(FeatureBean feature)

Returns all values of the feature.

Type Parameters:

V - the type of the values

Parameters:

feature - the feature

Returns:

an ordered iterable

setValue

public <V> void setValue(FeatureBean feature,
                         @Nonnegative
                         int position,
                         V value)

Defines the current value of the feature at the defined position.

Type Parameters:

V - the type of the value

Parameters:

feature - the feature

position - the position of the value

value - the new value

replaceValue

@Nonnull
public <V> Optional<V> replaceValue(FeatureBean feature,
                                              @Nonnegative
                                              int position,
                                              V value)

Replaces the current value of the feature at the defined position. If the current value does not exist, then the new value is not defined and this method does nothing.

Type Parameters:

V - the type of the value

Parameters:

feature - the feature

position - the position of the value

value - the new value

Returns:

an Optional containing the replaced value

moveValue

public void moveValue(FeatureBean feature,
                      @Nonnegative
                      int sourceIndex,
                      @Nonnegative
                      int targetIndex)

Moves the current value of the specified feature from the sourceIndex to the targetIndex.

Parameters:

feature - the feature

sourceIndex - the current position of the value to move

targetIndex - the new position of the value

removeValue

public void removeValue(FeatureBean feature,
                        @Nonnegative
                        int position)

Removes the current value of the feature at the defined position.

Parameters:

feature - the feature

position - the position of the value

getReference

@Nonnull
public Optional<ElementVertex> getReference(FeatureBean feature)

Returns the reference of the feature.

Parameters:

feature - the feature

Returns:

an Optional containing the referenced vertex

setReference

@Nonnull
public Optional<ElementVertex> setReference(FeatureBean feature,
                                                      Id reference)

Replaces the current reference of the feature by the specified reference.

Parameters:

feature - the feature

reference - the new reference

Returns:

an Optional containing the replaced referenced vertex

removeReferences

public void removeReferences(FeatureBean feature)

Removes the current reference of the feature.

Parameters:

feature - the feature

getReference

@Nonnull
public Optional<ElementVertex> getReference(FeatureBean feature,
                                                      @Nonnegative
                                                      int position)

Returns the reference of the feature at the defined position.

Parameters:

feature - the feature

position - the position of the reference

Returns:

an Optional containing the referenced vertex

getReferenceEdges

@Nonnull
public Iterable<ElementEdge> getReferenceEdges(FeatureBean feature)

Returns all references of the feature.

Parameters:

feature - the feature

Returns:

an ordered iterable of incident edges

getReferenceEdges

@Nonnull
public Iterable<ElementEdge> getReferenceEdges(FeatureBean feature,
                                                         int startPosition,
                                                         int endPosition)

Returns all references of the feature between the startPosition and the endPosition.

Parameters:

feature - the feature

startPosition - the start position

endPosition - the end position

Returns:

an ordered iterable of incident edges

See Also:

ElementVertexQuery.hasPositionBetween(int, int)

setReference

public void setReference(FeatureBean feature,
                         @Nonnegative
                         int position,
                         Id reference)

Defines the current reference of the feature at the defined position.

Parameters:

feature - the feature

position - the position of the reference

reference - the new reference

replaceReference

@Nonnull
public Optional<ElementVertex> replaceReference(FeatureBean feature,
                                                          @Nonnegative
                                                          int position,
                                                          Id reference)

Replaces the current reference of the feature at the defined position. If the current reference does not exist, then the new reference is not defined and this method does nothing.

Parameters:

feature - the feature

position - the position of the reference

reference - the new reference

Returns:

an Optional containing the replaced reference