org.janusgraph.graphdb.types.system

Class EmptyVertex

java.lang.Object

org.janusgraph.graphdb.types.system.EmptyVertex

All Implemented Interfaces:

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:

BaseVertexLabel, EmptyRelationType

public class EmptyVertex
extends Object
implements InternalVertex

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
EmptyVertex()

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
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
byte	getLifeCycle()
boolean	hasAddedRelations() Whether this vertex has added relations
boolean	hasId() Checks whether this entity has a unique identifier.
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
Object	id() Returns a unique identifier for this entity.
boolean	isInvisible() Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.
boolean	isLoaded() Checks whether this entity has been loaded into the current transaction and not yet modified.
boolean	isModified() Checks whether this entity has been loaded into the current transaction and modified.
boolean	isNew() Checks whether this entity has been newly created in the current transaction.
boolean	isRemoved() Checks whether this entity has been deleted into the current transaction.
InternalVertex	it() Returns this element in the context of the current transaction.
String	label() Returns the name of the vertex label for this vertex.
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... propertyKeys)
<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	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	setId(Object id)
StandardJanusGraphTx	tx() Returns the transaction to which the element is currently bound or should be refreshed into
<O> O	value(String key)
<O> O	valueOrNull(PropertyKey key) Retrieves the value associated with the given key on this element and casts it to the specified type.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDuplicatedAddedRelation

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

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

keys, values

Constructor Detail

EmptyVertex

public EmptyVertex()

Method Detail

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

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

Returns:

findAddedProperty

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

Specified by:

findAddedProperty in interface InternalVertex

findPreviousRelation

public Iterable<InternalRelation> findPreviousRelation(long id)

Specified by:

findPreviousRelation in interface InternalVertex

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

Returns:

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

Returns:

hasRemovedRelations

public boolean hasRemovedRelations()

Description copied from interface: InternalVertex

Whether this vertex has removed relations

Specified by:

hasRemovedRelations in interface InternalVertex

Returns:

hasAddedRelations

public boolean hasAddedRelations()

Description copied from interface: InternalVertex

Whether this vertex has added relations

Specified by:

hasAddedRelations in interface InternalVertex

Returns:

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

vertexLabel

public VertexLabel vertexLabel()

Description copied from interface: JanusGraphVertex

Returns the vertex label of this vertex.

Specified by:

vertexLabel in interface JanusGraphVertex

Returns:

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

value

public <O> O value(String key)

Specified by:

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

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

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

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

addRelation

public boolean addRelation(InternalRelation e)

Description copied from interface: InternalVertex

Add a new relation to the vertex

Specified by:

addRelation in interface InternalVertex

Returns:

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

Parameters:

e - JanusGraphRelation to be removed

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

Parameters:

s - label of the edge to be created

vertex - incoming vertex of the edge to be created

Returns:

new edge

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 Idfiable

Specified by:

id in interface JanusGraphElement

Returns:

The unique identifier for this entity

See Also:

JanusGraphElement.hasId()

hasId

public boolean hasId()

Description copied from interface: JanusGraphElement

Checks whether this entity has a unique identifier.

Note that some entities may never be assigned an identifier and others will only be assigned an identifier at the end of a transaction.

Specified by:

hasId in interface JanusGraphElement

Returns:

true if this entity has been assigned a unique id, else false

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

properties

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

Specified by:

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

Specified by:

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

setId

public void setId(Object id)

Specified by:

setId in interface InternalElement

getLifeCycle

public byte getLifeCycle()

Specified by:

getLifeCycle in interface InternalElement

Returns:

The lifecycle of this element

See Also:

ElementLifeCycle

isInvisible

public boolean isInvisible()

Description copied from interface: InternalElement

Whether this element is invisible and should only be returned to queries that explicitly ask for invisible elements.

Specified by:

isInvisible in interface InternalElement

Returns:

isRemoved

public boolean isRemoved()

Description copied from interface: JanusGraphElement

Checks whether this entity has been deleted into the current transaction.

Specified by:

isRemoved in interface JanusGraphElement

Returns:

True, has been deleted, else false.

isLoaded

public boolean isLoaded()

Description copied from interface: JanusGraphElement

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

Specified by:

isLoaded in interface JanusGraphElement

Returns:

True, has been loaded and not modified, else false.

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.

isNew

public boolean isNew()

Description copied from interface: JanusGraphElement

Checks whether this entity has been newly created in the current transaction.

Specified by:

isNew in interface JanusGraphElement

Returns:

True, if entity has been newly created, else false.

it

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