org.janusgraph.core

Class JanusGraphLazyRelation<V>

java.lang.Object

org.janusgraph.core.JanusGraphLazyRelation<V>

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Element, Idfiable, JanusGraphElement, JanusGraphRelation, InternalElement, InternalRelation, Removable

Direct Known Subclasses:

JanusGraphLazyEdge, JanusGraphLazyVertexProperty

public abstract class JanusGraphLazyRelation<V>
extends Object
implements InternalRelation

Nested Class Summary

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

org.apache.tinkerpop.gremlin.structure.Element.Exceptions

Constructor Summary

Constructors

Constructor and Description
JanusGraphLazyRelation(Entry dataEntry, InternalVertex vertex, StandardJanusGraphTx tx, InternalRelationType type)
JanusGraphLazyRelation(InternalRelation janusGraphRelation, InternalVertex vertex, StandardJanusGraphTx tx, InternalRelationType type)

Method Summary

Modifier and Type	Method and Description
org.apache.tinkerpop.gremlin.structure.Direction	direction(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Returns the direction of this relation from the perspective of the specified vertex.
boolean	equals(Object other)
int	getArity() Number of vertices on this relation.
Object	getCompareId()
int	getLen() Number of vertices on this relation that are aware of its existence.
byte	getLifeCycle()
Iterable<PropertyKey>	getPropertyKeysDirect()
RelationType	getType() Returns the type of this relation.
<O> O	getValueDirect(PropertyKey key)
InternalVertex	getVertex(int pos) Returns the vertex at the given position (0=OUT, 1=IN) of this relation
JanusGraphTransaction	graph()
int	hashCode()
boolean	hasId() Checks whether this entity has a unique identifier.
Object	id() Returns a unique identifier for this entity.
boolean	isEdge() Checks whether this relation is an edge.
boolean	isIncidentOn(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Checks whether this relation is incident on the specified vertex.
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	isLoop() Checks whether this relation is a loop.
boolean	isNew() Checks whether this entity has been newly created in the current transaction.
boolean	isProperty() Checks whether this relation is a property.
boolean	isRemoved() Checks whether this entity has been deleted into the current transaction.
boolean	isSingle()
InternalRelation	it() Returns this relation in the current transactional context
String	label()
InternalRelation	loadValue()
long	longId() Returns the long-type representation of ID
<V> Iterator<? extends org.apache.tinkerpop.gremlin.structure.Property<V>>	properties(String... propertyKeys)
<V> org.apache.tinkerpop.gremlin.structure.Property<V>	property(String s, V v) Sets the value for the given key on this element.
void	remove() Deletes this entity and any incident edges or properties from the graph.
<O> O	removePropertyDirect(PropertyKey key)
void	setId(Object id)
void	setPropertyDirect(PropertyKey key, Object value)
String	toString()
StandardJanusGraphTx	tx() Returns the transaction to which the element is currently bound or should be refreshed into
V	value()
V	value(String s) Retrieves the value associated with the given key on this vertex and casts it to the specified type.
<V> V	valueOrNull(PropertyKey propertyKey) Retrieves the value associated with the given key on this element and casts it to the specified type.

Methods inherited from class java.lang.Object

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

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

keys, property, values

Constructor Detail

JanusGraphLazyRelation

public JanusGraphLazyRelation(InternalRelation janusGraphRelation,
                              InternalVertex vertex,
                              StandardJanusGraphTx tx,
                              InternalRelationType type)

JanusGraphLazyRelation

public JanusGraphLazyRelation(Entry dataEntry,
                              InternalVertex vertex,
                              StandardJanusGraphTx tx,
                              InternalRelationType type)

Method Detail

loadValue

public InternalRelation loadValue()

value

public V value()

value

public V value(String s)

Description copied from interface: JanusGraphRelation

Retrieves the value associated with the given key on this vertex 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:

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

Specified by:

value in interface JanusGraphRelation

Parameters:

s - string identifying a key

Returns:

value or list of values associated with key

isSingle

public boolean isSingle()

getType

public RelationType getType()

Description copied from interface: JanusGraphRelation

Returns the type of this relation.

The type is either a label (EdgeLabel if this relation is an edge or a key (PropertyKey) if this relation is a property.

Specified by:

getType in interface JanusGraphRelation

Returns:

Type of this relation

direction

public org.apache.tinkerpop.gremlin.structure.Direction direction(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: JanusGraphRelation

Returns the direction of this relation from the perspective of the specified vertex.

Specified by:

direction in interface JanusGraphRelation

Parameters:

vertex - vertex on which the relation is incident

Returns:

The direction of this relation from the perspective of the specified vertex.

isIncidentOn

public boolean isIncidentOn(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Description copied from interface: JanusGraphRelation

Checks whether this relation is incident on the specified vertex.

Specified by:

isIncidentOn in interface JanusGraphRelation

Parameters:

vertex - vertex to check incidence for

Returns:

true, if this relation is incident on the vertex, else false

isLoop

public boolean isLoop()

Description copied from interface: JanusGraphRelation

Checks whether this relation is a loop. An relation is a loop if it connects a vertex with itself.

Specified by:

isLoop in interface JanusGraphRelation

Returns:

true, if this relation is a loop, else false.

isProperty

public boolean isProperty()

Description copied from interface: JanusGraphRelation

Checks whether this relation is a property.

Specified by:

isProperty in interface JanusGraphRelation

Returns:

true, if this relation is a property, else false.

See Also:

JanusGraphVertexProperty

isEdge

public boolean isEdge()

Description copied from interface: JanusGraphRelation

Checks whether this relation is an edge.

Specified by:

isEdge in interface JanusGraphRelation

Returns:

true, if this relation is an edge, else false.

See Also:

JanusGraphEdge

label

public String label()

Specified by:

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

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:

graph

public JanusGraphTransaction graph()

Specified by:

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

Specified by:

graph in interface JanusGraphElement

Specified by:

graph in interface InternalElement

setId

public void setId(Object id)

Specified by:

setId in interface InternalElement

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

getCompareId

public Object getCompareId()

Specified by:

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

longId

public long longId()

Description copied from interface: JanusGraphRelation

Returns the long-type representation of ID

Specified by:

longId in interface JanusGraphRelation

Returns:

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<? extends org.apache.tinkerpop.gremlin.structure.Property<V>> properties(String... propertyKeys)

Specified by:

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

property

public <V> org.apache.tinkerpop.gremlin.structure.Property<V> property(String s,
                                                                       V v)

Description copied from interface: JanusGraphElement

Sets the value for the given key on this element. The key must be defined to have Cardinality.SINGLE, otherwise this method throws an exception.

Specified by:

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

Specified by:

property in interface JanusGraphElement

Parameters:

s - the string identifying the key

v - the object value

valueOrNull

public <V> V valueOrNull(PropertyKey propertyKey)

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:

propertyKey - key

Returns:

value or list of values associated with key

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.

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.

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.

it

public InternalRelation it()

Description copied from interface: InternalRelation

Returns this relation in the current transactional context

Specified by:

it in interface InternalElement

Specified by:

it in interface InternalRelation

Returns:

getVertex

public InternalVertex getVertex(int pos)

Description copied from interface: InternalRelation

Returns the vertex at the given position (0=OUT, 1=IN) of this relation

Specified by:

getVertex in interface InternalRelation

Returns:

getArity

public int getArity()

Description copied from interface: InternalRelation

Number of vertices on this relation.

Specified by:

getArity in interface InternalRelation

Returns:

getLen

public int getLen()

Description copied from interface: InternalRelation

Number of vertices on this relation that are aware of its existence. This number will differ from InternalRelation.getArity()

Specified by:

getLen in interface InternalRelation

getValueDirect

public <O> O getValueDirect(PropertyKey key)

Specified by:

getValueDirect in interface InternalRelation

setPropertyDirect

public void setPropertyDirect(PropertyKey key,
                              Object value)

Specified by:

setPropertyDirect in interface InternalRelation

getPropertyKeysDirect

public Iterable<PropertyKey> getPropertyKeysDirect()

Specified by:

getPropertyKeysDirect in interface InternalRelation

removePropertyDirect

public <O> O removePropertyDirect(PropertyKey key)

Specified by:

removePropertyDirect in interface InternalRelation

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object