org.janusgraph.graphdb.vertices

Class PreloadedVertex

java.lang.Object

org.janusgraph.graphdb.internal.AbstractElement

org.janusgraph.graphdb.vertices.AbstractVertex

org.janusgraph.graphdb.vertices.StandardVertex

org.janusgraph.graphdb.vertices.CacheVertex

org.janusgraph.graphdb.vertices.PreloadedVertex

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

public class PreloadedVertex
extends CacheVertex

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PreloadedVertex.AccessCheck
static interface	PreloadedVertex.PropertyMixing

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static PreloadedVertex.AccessCheck	CLOSEDSTAR_CHECK
static PreloadedVertex.AccessCheck	DEFAULT_CHECK
static Retriever<SliceQuery,EntryList>	EMPTY_RETRIEVER
static PreloadedVertex.AccessCheck	OPENSTAR_CHECK

Fields inherited from class org.janusgraph.graphdb.vertices.CacheVertex

queryCache

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

DEFAULT_LABEL, EMPTY_ARGS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
JanusGraphEdge	addEdge(String s, org.apache.tinkerpop.gremlin.structure.Vertex vertex, Object... keyValues) Creates a new edge incident on this vertex.
boolean	addRelation(InternalRelation e) Add a new relation to the vertex
void	addToQueryCache(SliceQuery query, EntryList entries)
Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(org.apache.tinkerpop.gremlin.structure.Direction direction, String... edgeLabels)
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
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)
<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.
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.
void	setAccessCheck(PreloadedVertex.AccessCheck accessCheck)
void	setPropertyMixing(PreloadedVertex.PropertyMixing mixin)

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

getFromCache, getQueryCacheSize, refresh

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

getDuplicatedAddedRelation, getLifeCycle, updateLifeCycle, vertexLabel

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

getCompareId, getVertexLabelInternal, isModified, isTxOpen, it, label, 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

Field Detail

EMPTY_RETRIEVER

public static final Retriever<SliceQuery,EntryList> EMPTY_RETRIEVER

DEFAULT_CHECK

public static final PreloadedVertex.AccessCheck DEFAULT_CHECK

CLOSEDSTAR_CHECK

public static final PreloadedVertex.AccessCheck CLOSEDSTAR_CHECK

OPENSTAR_CHECK

public static final PreloadedVertex.AccessCheck OPENSTAR_CHECK

Constructor Detail

PreloadedVertex

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

Method Detail

setPropertyMixing

public void setPropertyMixing(PreloadedVertex.PropertyMixing mixin)

setAccessCheck

public void setAccessCheck(PreloadedVertex.AccessCheck accessCheck)

addToQueryCache

public void addToQueryCache(SliceQuery query,
                            EntryList entries)

Overrides:

addToQueryCache in class CacheVertex

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

Specified by:

getAddedRelations in interface InternalVertex

Overrides:

getAddedRelations in class StandardVertex

Returns:

findAddedProperty

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

Specified by:

findAddedProperty in interface InternalVertex

Overrides:

findAddedProperty in class StandardVertex

findPreviousRelation

public Iterable<InternalRelation> findPreviousRelation(long id)

Specified by:

findPreviousRelation in interface InternalVertex

Overrides:

findPreviousRelation in class StandardVertex

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

Overrides:

query in class AbstractVertex

Returns:

New JanusGraphQuery for this vertex

See Also:

JanusGraphVertexQuery

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.

Specified by:

hasLoadedRelations in interface InternalVertex

Overrides:

hasLoadedRelations in class CacheVertex

Returns:

hasRemovedRelations

public boolean hasRemovedRelations()

Description copied from interface: InternalVertex

Whether this vertex has removed relations

Specified by:

hasRemovedRelations in interface InternalVertex

Overrides:

hasRemovedRelations in class StandardVertex

Returns:

hasAddedRelations

public boolean hasAddedRelations()

Description copied from interface: InternalVertex

Whether this vertex has added relations

Specified by:

hasAddedRelations in interface InternalVertex

Overrides:

hasAddedRelations in class StandardVertex

Returns:

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.

Specified by:

loadRelations in interface InternalVertex

Overrides:

loadRelations in class CacheVertex

Returns:

property

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

Specified by:

property in interface JanusGraphVertex

Overrides:

property in class AbstractVertex

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

Overrides:

property in class AbstractVertex

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 StandardVertex

addEdge

public JanusGraphEdge addEdge(String s,
                              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

Overrides:

addEdge in class AbstractVertex

Parameters:

s - 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... edgeLabels)

Specified by:

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

Overrides:

edges in class AbstractVertex

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 StandardVertex

remove

public void remove(Iterable<JanusGraphRelation> loadedRelations)

Description copied from interface: InternalVertex

Remove a vertex with pre-loaded relations.

Specified by:

remove in interface InternalVertex

Overrides:

remove in class StandardVertex

Parameters:

loadedRelations - pre-loaded relations.

removeRelation

public void removeRelation(InternalRelation e)

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.

Specified by:

removeRelation in interface InternalVertex

Overrides:

removeRelation in class StandardVertex

Parameters:

e - JanusGraphRelation to be removed

addRelation

public boolean addRelation(InternalRelation e)

Description copied from interface: InternalVertex

Add a new relation to the vertex

Specified by:

addRelation in interface InternalVertex

Overrides:

addRelation in class StandardVertex

Returns: