org.janusgraph.graphdb.olap.computer

Class FulgoraVertexProperty<V>

java.lang.Object

org.janusgraph.graphdb.olap.computer.FulgoraVertexProperty<V>

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.Property<V>, org.apache.tinkerpop.gremlin.structure.VertexProperty<V>, Idfiable, JanusGraphElement, JanusGraphProperty<V>, JanusGraphRelation, JanusGraphVertexProperty<V>, Removable

public class FulgoraVertexProperty<V>
extends Object
implements JanusGraphVertexProperty<V>

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.VertexProperty

org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality, org.apache.tinkerpop.gremlin.structure.VertexProperty.Exceptions

Field Summary

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
FulgoraVertexProperty(org.janusgraph.graphdb.olap.computer.VertexMemoryHandler mixinParent, JanusGraphVertex vertex, String key, V value)

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.
JanusGraphVertex	element() Returns the vertex on which this property is incident.
RelationType	getType() Returns the type of this relation.
boolean	hasId() Checks whether this entity has a unique identifier.
Object	id() Returns a unique identifier for this entity.
boolean	isEdge() Checks whether this relation is an edge.
boolean	isIncidentOn(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Checks whether this relation is incident on the specified vertex.
boolean	isLoaded() Checks whether this entity has been loaded into the current transaction and not yet modified.
boolean	isLoop() Checks whether this relation is a loop.
boolean	isNew() Checks whether this entity has been newly created in the current transaction.
boolean	isPresent()
boolean	isProperty() Checks whether this relation is a property.
boolean	isRemoved() Checks whether this entity has been deleted into the current transaction.
String	key()
long	longId() Returns the long-type representation of ID
<A> Iterator<org.apache.tinkerpop.gremlin.structure.Property<A>>	properties(String... propertyKeys)
<A> org.apache.tinkerpop.gremlin.structure.Property<A>	property(String s, A v) Sets the value for the given key on this element.
void	remove() Deletes this entity and any incident edges or properties from the graph.
V	value()
<A> A	value(String key) Retrieves the value associated with the given key on this vertex and casts it to the specified type.
<A> A	valueOrNull(PropertyKey key) Retrieves the value associated with the given key on this element and casts it to the specified type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janusgraph.core.JanusGraphVertexProperty

empty, getRemover, graph, propertyKey

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

keys, label, property, values

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

label

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

ifPresent, orElse, orElseGet, orElseThrow

Constructor Detail

FulgoraVertexProperty

public FulgoraVertexProperty(org.janusgraph.graphdb.olap.computer.VertexMemoryHandler mixinParent,
                             JanusGraphVertex vertex,
                             String key,
                             V value)

Method Detail

key

public String key()

Specified by:

key in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Specified by:

key in interface JanusGraphProperty<V>

value

public V value()
        throws NoSuchElementException

Specified by:

value in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Throws:

NoSuchElementException

isPresent

public boolean isPresent()

Specified by:

isPresent in interface org.apache.tinkerpop.gremlin.structure.Property<V>

element

public JanusGraphVertex element()

Description copied from interface: JanusGraphVertexProperty

Returns the vertex on which this property is incident.

Specified by:

element in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Specified by:

element in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

Specified by:

element in interface JanusGraphVertexProperty<V>

Returns:

The vertex of this property.

remove

public void remove()

Description copied from interface: JanusGraphElement

Deletes this entity and any incident edges or properties from the graph.

Specified by:

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

Specified by:

remove in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Specified by:

remove in interface JanusGraphElement

Specified by:

remove in interface Removable

id

public Object 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

Returns:

The unique identifier for this entity

See Also:

JanusGraphElement.hasId()

longId

public long longId()

Description copied from interface: JanusGraphRelation

Returns the long-type representation of ID

Specified by:

longId in interface JanusGraphRelation

Returns:

hasId

public boolean hasId()

Description copied from interface: JanusGraphElement

Checks whether this entity has a unique identifier.

Note that some entities may never be assigned an identifier and others will only be assigned an identifier at the end of a transaction.

Specified by:

hasId in interface JanusGraphElement

Returns:

true if this entity has been assigned a unique id, else false

property

public <A> org.apache.tinkerpop.gremlin.structure.Property<A> property(String s,
                                                                       A v)

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:

s - the string identifying the key

v - the object value

valueOrNull

public <A> A 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

isNew

public boolean isNew()

Description copied from interface: JanusGraphElement

Checks whether this entity has been newly created in the current transaction.

Specified by:

isNew in interface JanusGraphElement

Returns:

True, if entity has been newly created, else false.

isLoaded

public boolean isLoaded()

Description copied from interface: JanusGraphElement

Checks whether this entity has been loaded into the current transaction and not yet modified.

Specified by:

isLoaded in interface JanusGraphElement

Returns:

True, has been loaded and not modified, else false.

isRemoved

public boolean isRemoved()

Description copied from interface: JanusGraphElement

Checks whether this entity has been deleted into the current transaction.

Specified by:

isRemoved in interface JanusGraphElement

Returns:

True, has been deleted, else false.

value

public <A> A 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

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

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

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.

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

properties

public <A> Iterator<org.apache.tinkerpop.gremlin.structure.Property<A>> properties(String... propertyKeys)

Specified by:

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

Specified by:

properties in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>