org.janusgraph.core

Interface JanusGraphVertex

All Superinterfaces:

org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.util.Host, Idfiable, JanusGraphElement, Removable, org.apache.tinkerpop.gremlin.structure.Vertex

All Known Subinterfaces:

EdgeLabel, InternalRelationType, InternalVertex, InternalVertexLabel, PropertyKey, RelationType, SystemRelationType, VertexLabel

All Known Implementing Classes:

AbstractVertex, BaseKey, BaseLabel, BaseRelationType, BaseVertexLabel, CacheVertex, EdgeLabelVertex, EmptyRelationType, EmptyVertex, ImplicitKey, JanusGraphSchemaVertex, PreloadedVertex, PropertyKeyVertex, RelationTypeVertex, StandardVertex, VertexLabelVertex

public interface JanusGraphVertex
extends JanusGraphElement, org.apache.tinkerpop.gremlin.structure.Vertex

JanusGraphVertex is the basic unit of a JanusGraph. It extends the functionality provided by Blueprint's Vertex by helper and convenience methods.

Vertices have incident edges and properties. Edge connect the vertex to other vertices. Properties attach key-value pairs to this vertex to define it.

Like JanusGraphRelation a vertex has a vertex label.

Author:

Matthias Bröcheler (http://www.matthiasb.com)

Nested Class Summary

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

org.apache.tinkerpop.gremlin.structure.Vertex.Exceptions

Field Summary

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

DEFAULT_LABEL, EMPTY_ARGS

Method Summary

Modifier and Type	Method and Description
JanusGraphEdge	addEdge(String label, org.apache.tinkerpop.gremlin.structure.Vertex vertex, Object... keyValues) Creates a new edge incident on this vertex.
boolean	isModified() Checks whether this entity has been loaded into the current transaction and modified.
default String	label() Returns the name of the vertex label for this vertex.
default <V> JanusGraphVertexProperty<V>	property(String key, V value) Creates a new property for this vertex and given key with the specified value.
<V> JanusGraphVertexProperty<V>	property(String key, V value, Object... keyValues)
<V> JanusGraphVertexProperty<V>	property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality, String key, V value, Object... keyValues)
JanusGraphVertexQuery<? extends JanusGraphVertexQuery>	query() Starts a new JanusGraphVertexQuery for this vertex.
VertexLabel	vertexLabel() Returns the vertex label of this vertex.

Methods inherited from interface org.janusgraph.core.JanusGraphElement

graph, hasId, id, isLoaded, isNew, isRemoved, remove, valueOrNull

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

edges, properties, property, vertices

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

keys, value, values

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Method Detail

addEdge

JanusGraphEdge addEdge(String label,
                       org.apache.tinkerpop.gremlin.structure.Vertex vertex,
                       Object... keyValues)

Creates a new edge incident on this vertex.

Creates and returns a new JanusGraphEdge of the specified label with this vertex being the outgoing vertex and the given vertex being the incoming vertex.
Automatically creates the edge label if it does not exist and automatic creation of types is enabled. Otherwise, this method with throw an IllegalArgumentException.

Specified by:

addEdge in interface org.apache.tinkerpop.gremlin.structure.Vertex

Parameters:

label - label of the edge to be created

vertex - incoming vertex of the edge to be created

Returns:

new edge

property

default <V> JanusGraphVertexProperty<V> property(String key,
                                                 V value)

Creates a new property for this vertex and given key with the specified value.

Creates and returns a new JanusGraphVertexProperty for the given key on this vertex with the specified object being the value.
Automatically creates the property key if it does not exist and automatic creation of types is enabled. Otherwise, this method with throw an IllegalArgumentException.

Specified by:

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

Specified by:

property in interface JanusGraphElement

Specified by:

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

Parameters:

key - key of the property to be created

value - value of the property to be created

Returns:

New property

Throws:

IllegalArgumentException - if the value does not match the data type of the property key.

property

<V> JanusGraphVertexProperty<V> property(String key,
                                         V value,
                                         Object... keyValues)

Specified by:

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

property

<V> JanusGraphVertexProperty<V> property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality,
                                         String key,
                                         V value,
                                         Object... keyValues)

Specified by:

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

label

default String label()

Returns the name of the vertex label for this vertex.

Specified by:

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

Returns:

vertexLabel

VertexLabel vertexLabel()

Returns the vertex label of this vertex.

Returns:

query

JanusGraphVertexQuery<? extends JanusGraphVertexQuery> query()

Starts a new JanusGraphVertexQuery for this vertex.

Initializes and returns a new JanusGraphVertexQuery based on this vertex.

Returns:

New JanusGraphQuery for this vertex

See Also:

JanusGraphVertexQuery

isModified

boolean isModified()

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

Returns:

True, has been loaded and modified, else false.