ai.grakn.kb.internal.structure

Class AbstractElement<E extends org.apache.tinkerpop.gremlin.structure.Element,P extends Enum>

java.lang.Object

ai.grakn.kb.internal.structure.AbstractElement<E,P>

Type Parameters:

E - The type of the element. Either VertexElement of EdgeElement

P - Enum indicating the allowed properties on each type. Either Schema.VertexProperty or Schema.EdgeProperty

Direct Known Subclasses:

EdgeElement, VertexElement

public abstract class AbstractElement<E extends org.apache.tinkerpop.gremlin.structure.Element,P extends Enum>
extends Object

GraknTx AbstractElement

Base class used to represent a construct in the graph. This includes exposed constructs such as Concept and hidden constructs such as EdgeElement and Casting

Author:

fppt

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the element from the graph
E	element()
boolean	equals(Object object)
int	hashCode()
ElementId	id()
boolean	isDeleted()
String	label()
<X> X	property(P key)
void	property(P key, Object value)
Boolean	propertyBoolean(P key)
<X> void	propertyImmutable(P property, X newValue, X foundValue)
<X> void	propertyImmutable(P property, X newValue, X foundValue, java.util.function.Function<X,Object> converter) Sets a property which cannot be mutated
void	propertyUnique(P key, String value) Sets the value of a property with the added restriction that no other vertex can have that property.
EmbeddedGraknTx<?>	tx()

Methods inherited from class java.lang.Object

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

Method Detail

element

public E element()

id

public ElementId id()

delete

public void delete()

Deletes the element from the graph

property

public void property(P key,
                     Object value)

Parameters:

key - The key of the property to mutate

value - The value to commit into the property

property

@Nullable
public <X> X property(P key)

Parameters:

key - The key of the non-unique property to retrieve

Returns:

The value stored in the property

propertyBoolean

public Boolean propertyBoolean(P key)

tx

public EmbeddedGraknTx<?> tx()

Returns:

The grakn graph this concept is bound to.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

The hash code of the underlying vertex

equals

public boolean equals(Object object)

Overrides:

equals in class Object

Returns:

true if the elements equal each other

propertyUnique

public void propertyUnique(P key,
                           String value)

Sets the value of a property with the added restriction that no other vertex can have that property.

Parameters:

key - The key of the unique property to mutate

value - The new value of the unique property

propertyImmutable

public <X> void propertyImmutable(P property,
                                  X newValue,
                                  @Nullable
                                  X foundValue,
                                  java.util.function.Function<X,Object> converter)

Sets a property which cannot be mutated

Parameters:

property - The key of the immutable property to mutate

newValue - The new value to put on the property (if the property is not set)

foundValue - The current value of the property

converter - Helper method to ensure data is persisted in the correct format

propertyImmutable

public <X> void propertyImmutable(P property,
                                  X newValue,
                                  X foundValue)

label

public String label()

Returns:

the label of the element in the graph.

isDeleted

public final boolean isDeleted()