org.janusgraph.graphdb.internal

Interface InternalVertex

All Superinterfaces:

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

All Known Subinterfaces:

InternalRelationType, SystemRelationType

All Known Implementing Classes:

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

public interface InternalVertex
extends JanusGraphVertex, InternalElement

Internal Vertex interface adding methods that should only be used by JanusGraph

Author:

Matthias Broecheler ([email protected])

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
boolean	addRelation(InternalRelation e) 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
default Iterable<InternalRelation>	getDuplicatedAddedRelation(PropertyKey key, Object value)
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
InternalVertex	it() Returns this element in the context of the current transaction.
EntryList	loadRelations(SliceQuery query, Retriever<SliceQuery,EntryList> lookup) Returns all relations that match the given query.
VertexCentricQueryBuilder	query() Starts a new JanusGraphVertexQuery for this vertex.
void	remove(Iterable<JanusGraphRelation> loadedRelations) Remove a vertex with pre-loaded relations.
void	removeRelation(InternalRelation e) Deleted relation e from the adjacency list of this vertex and updates the state of the vertex to reflect the modification.

Methods inherited from interface org.janusgraph.core.JanusGraphVertex

addEdge, isModified, label, property, property, property, vertexLabel

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

edges, properties, property, vertices

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

getHostingVertex

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

getCompareId, getLifeCycle, graph, isInvisible, setId, tx

Methods inherited from interface org.janusgraph.core.JanusGraphElement

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

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

keys, value, values

Method Detail

it

InternalVertex it()

Description copied from interface: InternalElement

Returns this element in the context of the current transaction.

Specified by:

it in interface InternalElement

Returns:

removeRelation

void removeRelation(InternalRelation e)

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:

e - JanusGraphRelation to be removed

remove

void remove(Iterable<JanusGraphRelation> loadedRelations)

Remove a vertex with pre-loaded relations.

Parameters:

loadedRelations - pre-loaded relations.

addRelation

boolean addRelation(InternalRelation e)

Add a new relation to the vertex

Parameters:

e -

Returns:

getAddedRelations

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

Parameters:

query -

Returns:

findPreviousRelation

Iterable<InternalRelation> findPreviousRelation(long id)

findAddedProperty

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

getDuplicatedAddedRelation

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

loadRelations

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

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.

Parameters:

query -

lookup -

Returns:

hasLoadedRelations

boolean hasLoadedRelations(SliceQuery query)

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

Parameters:

query -

Returns:

hasRemovedRelations

boolean hasRemovedRelations()

Whether this vertex has removed relations

Returns:

hasAddedRelations

boolean hasAddedRelations()

Whether this vertex has added relations

Returns:

query

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

Returns:

New JanusGraphQuery for this vertex

See Also:

JanusGraphVertexQuery