org.janusgraph.graphdb.vertices

Class AbstractVertex

java.lang.Object

org.janusgraph.graphdb.internal.AbstractElement

org.janusgraph.graphdb.vertices.AbstractVertex

All Implemented Interfaces:

Comparable<JanusGraphElement>, org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.util.Host, org.apache.tinkerpop.gremlin.structure.Vertex, Idfiable, JanusGraphElement, JanusGraphVertex, InternalElement, InternalVertex, Removable

Direct Known Subclasses:

StandardVertex

public abstract class AbstractVertex
extends AbstractElement
implements InternalVertex, org.apache.tinkerpop.gremlin.structure.Vertex

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVertex(StandardJanusGraphTx tx, long id)

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.
Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(org.apache.tinkerpop.gremlin.structure.Direction direction, String... labels)
long	getCompareId() Long identifier used to compare elements.
protected org.apache.tinkerpop.gremlin.structure.Vertex	getVertexLabelInternal()
Object	id() Returns a unique identifier for this entity.
boolean	isModified() Checks whether this entity has been loaded into the current transaction and modified.
boolean	isTxOpen()
InternalVertex	it() Returns this element in the context of the current transaction.
String	label() Returns the name of the vertex label for this vertex.
<V> Iterator<org.apache.tinkerpop.gremlin.structure.VertexProperty<V>>	properties(String... keys)
<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)
VertexCentricQueryBuilder	query() Starts a new JanusGraphVertexQuery for this vertex.
void	remove() Deletes this entity and any incident edges or properties from the graph.
String	toString()
StandardJanusGraphTx	tx() Returns the transaction to which the element is currently bound or should be refreshed into
<O> O	valueOrNull(PropertyKey key) Retrieves the value associated with the given key on this element and casts it to the specified type.
protected void	verifyAccess()
VertexLabel	vertexLabel() Returns the vertex label of this vertex.
Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction, String... edgeLabels)

Methods inherited from class org.janusgraph.graphdb.internal.AbstractElement

clone, compare, compareTo, equals, hashCode, hasId, isInvisible, isLoaded, isNew, isRemoved, isTemporaryId, longId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janusgraph.graphdb.internal.InternalVertex

addRelation, getAddedRelations, hasAddedRelations, hasLoadedRelations, hasRemovedRelations, loadRelations, removeRelation

Methods inherited from interface org.janusgraph.core.JanusGraphVertex

property

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

property

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

getHostingVertex

Methods inherited from interface org.janusgraph.graphdb.internal.InternalElement

getLifeCycle, graph, isInvisible, setId

Methods inherited from interface org.janusgraph.core.JanusGraphElement

hasId, isLoaded, isNew, isRemoved, longId

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

keys, value, values

Constructor Detail

AbstractVertex

protected AbstractVertex(StandardJanusGraphTx tx,
                         long id)

Method Detail

it

public final InternalVertex it()

Description copied from interface: InternalElement

Returns this element in the context of the current transaction.

Specified by:

it in interface InternalElement

Specified by:

it in interface InternalVertex

Returns:

tx

public final StandardJanusGraphTx tx()

Description copied from interface: InternalElement

Returns the transaction to which the element is currently bound or should be refreshed into

Specified by:

tx in interface InternalElement

Returns:

isTxOpen

public final boolean isTxOpen()

getCompareId

public long getCompareId()

Description copied from class: AbstractElement

Long identifier used to compare elements. Often, this is the same as AbstractElement.longId() but some instances of elements may be considered the same even if their ids differ. In that case, this method should be overwritten to return an id that can be used for comparison.

Overrides:

getCompareId in class AbstractElement

Returns:

toString

public String toString()

Overrides:

toString in class Object

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 JanusGraphElement

Returns:

The unique identifier for this entity

See Also:

JanusGraphElement.hasId()

isModified

public boolean isModified()

Description copied from interface: JanusGraphVertex

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

Specified by:

isModified in interface JanusGraphVertex

Returns:

True, has been loaded and modified, else false.

verifyAccess

protected final void verifyAccess()

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 JanusGraphElement

Specified by:

remove in interface Removable

label

public String label()

Description copied from interface: JanusGraphVertex

Returns the name of the vertex label for this vertex.

Specified by:

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

Specified by:

label in interface JanusGraphVertex

getVertexLabelInternal

protected org.apache.tinkerpop.gremlin.structure.Vertex getVertexLabelInternal()

vertexLabel

public VertexLabel vertexLabel()

Description copied from interface: JanusGraphVertex

Returns the vertex label of this vertex.

Specified by:

vertexLabel in interface JanusGraphVertex

Returns:

query

public VertexCentricQueryBuilder query()

Description copied from interface: JanusGraphVertex

Starts a new JanusGraphVertexQuery for this vertex.

Initializes and returns a new JanusGraphVertexQuery based on this vertex.

Specified by:

query in interface JanusGraphVertex

Specified by:

query in interface InternalVertex

Returns:

New JanusGraphQuery for this vertex

See Also:

JanusGraphVertexQuery

valueOrNull

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

property

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

Specified by:

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

Specified by:

property in interface JanusGraphVertex

property

public <V> JanusGraphVertexProperty<V> property(@Nullable
                                                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

Specified by:

property in interface JanusGraphVertex

addEdge

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

Description copied from interface: JanusGraphVertex

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

Specified by:

addEdge in interface JanusGraphVertex

Parameters:

label - label of the edge to be created

vertex - incoming vertex of the edge to be created

Returns:

new edge

edges

public Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                   String... labels)

Specified by:

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

properties

public <V> Iterator<org.apache.tinkerpop.gremlin.structure.VertexProperty<V>> properties(String... keys)

Specified by:

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

Specified by:

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

vertices

public Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                        String... edgeLabels)

Specified by:

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