org.janusgraph.graphdb.vertices

Class StandardVertex

java.lang.Object

org.janusgraph.graphdb.internal.AbstractElement

org.janusgraph.graphdb.vertices.AbstractVertex

org.janusgraph.graphdb.vertices.StandardVertex

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:

CacheVertex

public class StandardVertex
extends AbstractVertex

Author:

Matthias Broecheler (me@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

Constructor Summary

Constructors

Constructor and Description
StandardVertex(StandardJanusGraphTx tx, Object id, byte lifecycle)

Method Summary

Modifier and Type	Method and Description
boolean	addRelation(InternalRelation r) Add a new relation to the vertex
Iterable<InternalRelation>	findAddedProperty(com.google.common.base.Predicate<InternalRelation> query)
Iterable<InternalRelation>	findPreviousRelation(long id)
Iterable<InternalRelation>	getAddedRelations(com.google.common.base.Predicate<InternalRelation> query) Returns an iterable over all newly added relations incident on this vertex that match the given predicate
Iterable<InternalRelation>	getDuplicatedAddedRelation(PropertyKey key, Object value) Returns duplicated properties for the given key and value.
byte	getLifeCycle()
boolean	hasAddedRelations() Whether this vertex has added relations
boolean	hasLoadedRelations(SliceQuery query) Returns true if the results for the given query have already been loaded for this vertex and are locally cached.
boolean	hasRemovedRelations() Whether this vertex has removed relations
EntryList	loadRelations(SliceQuery query, Retriever<SliceQuery,EntryList> lookup) Returns all relations that match the given query.
<V> Iterator<org.apache.tinkerpop.gremlin.structure.VertexProperty<V>>	properties(String... keys)
void	remove() Deletes this entity and any incident edges or properties from the graph.
void	removeRelation(InternalRelation r) Deleted relation e from the adjacency list of this vertex and updates the state of the vertex to reflect the modification.
void	updateLifeCycle(ElementLifeCycle.Event event)
VertexLabel	vertexLabel() Returns the vertex label of this vertex.

Methods inherited from class org.janusgraph.graphdb.vertices.AbstractVertex

addEdge, edges, getCompareId, getVertexLabelInternal, isModified, isTxOpen, it, label, property, property, query, toString, tx, valueOrNull, verifyAccess, vertices

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

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

Methods inherited from class java.lang.Object

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

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

graph, isInvisible, setId

Methods inherited from interface org.janusgraph.core.JanusGraphElement

hasId, id, isLoaded, isNew, isRemoved

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

keys, value, values

Constructor Detail

StandardVertex

public StandardVertex(StandardJanusGraphTx tx,
                      Object id,
                      byte lifecycle)

Method Detail

updateLifeCycle

public final void updateLifeCycle(ElementLifeCycle.Event event)

removeRelation

public void removeRelation(InternalRelation r)

Description copied from interface: InternalVertex

Deleted relation e from the adjacency list of this vertex and updates the state of the vertex to reflect the modification. Note that this method tolerates the prior removal of the vertex and hence does not throw an exception if the relation could not actually be removed from the adjacency list. This behavior was chosen to allow relation deletion while iterating over the list of adjacent relations, in which case the relation deletion is taken care of by the iterator and only vertex status update needs to be executed.

Parameters:

r - JanusGraphRelation to be removed

addRelation

public boolean addRelation(InternalRelation r)

Description copied from interface: InternalVertex

Add a new relation to the vertex

Returns:

getDuplicatedAddedRelation

public Iterable<InternalRelation> getDuplicatedAddedRelation(PropertyKey key,
                                                             Object value)

Returns duplicated properties for the given key and value. If Cardinality is Single, it only matches by key name If Cardinality is Set, it matches by key name and key value

getAddedRelations

public Iterable<InternalRelation> getAddedRelations(com.google.common.base.Predicate<InternalRelation> query)

Description copied from interface: InternalVertex

Returns an iterable over all newly added relations incident on this vertex that match the given predicate

Returns:

findPreviousRelation

public Iterable<InternalRelation> findPreviousRelation(long id)

findAddedProperty

public Iterable<InternalRelation> findAddedProperty(com.google.common.base.Predicate<InternalRelation> query)

loadRelations

public EntryList loadRelations(SliceQuery query,
                               Retriever<SliceQuery,EntryList> lookup)

Description copied from interface: InternalVertex

Returns all relations that match the given query. If these matching relations are not currently held in memory, it uses the given Retriever to retrieve the edges from backend storage.

Returns:

vertexLabel

public VertexLabel vertexLabel()

Description copied from interface: JanusGraphVertex

Returns the vertex label of this vertex.

Specified by:

vertexLabel in interface JanusGraphVertex

Overrides:

vertexLabel in class AbstractVertex

Returns:

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

Overrides:

properties in class AbstractVertex

hasLoadedRelations

public boolean hasLoadedRelations(SliceQuery query)

Description copied from interface: InternalVertex

Returns true if the results for the given query have already been loaded for this vertex and are locally cached.

Returns:

hasRemovedRelations

public boolean hasRemovedRelations()

Description copied from interface: InternalVertex

Whether this vertex has removed relations

Returns:

hasAddedRelations

public boolean hasAddedRelations()

Description copied from interface: InternalVertex

Whether this vertex has added relations

Returns:

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

Overrides:

remove in class AbstractVertex

getLifeCycle

public byte getLifeCycle()

Returns:

The lifecycle of this element

See Also:

ElementLifeCycle