com.blazegraph.gremlin.structure

Class BlazeVertexProperty<V>

java.lang.Object

com.blazegraph.gremlin.structure.BlazeVertexProperty<V>

Type Parameters:

V -

All Implemented Interfaces:

BlazeElement, BlazeReifiedElement, org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.Property<V>, org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

Direct Known Subclasses:

EmptyBlazeVertexProperty

public class BlazeVertexProperty<V>
extends Object
implements org.apache.tinkerpop.gremlin.structure.VertexProperty<V>, BlazeReifiedElement

Concrete vertex property implementation for Blazegraph.

Vertex properties can be represented in one of two ways depending on the cardinality of the key. Cardinality.single and Cardinality.set are represented the same way, as follows:

     :vertexId :key "val" .
 

For Cardinality.list, a list index literal with a special datatype is used to manage duplicate list items and ordering. Cardinality.list requires two triples instead of one:

 
     :vertexId :key "0"^^blazegraph:listIndex .
     <<:vertexId :key "0"^^blazegraph:listIndex>> rdf:value "val" .
 
 

In either case, meta-properties can be attached to the reified vertex property triple:

 
     # for Cardinality.single and Cardinality.set
     <<:vertexId :key "val">> :metaKey "metaVal" .
     # for Cardinality.list
     <<:vertexId :key "0"^^blazegraph:listIndex>> :metaKey "metaVal" .
 
 

Author:

mikepersonick

Nested Class Summary

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

org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality, org.apache.tinkerpop.gremlin.structure.VertexProperty.Exceptions

Field Summary

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

DEFAULT_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlazeVertexProperty() Solely for EmptyBlazeVertexProperty.

Method Summary

Modifier and Type	Method and Description
BlazeVertex	element() The vertex to which this property belongs.
boolean	equals(Object object) Pass through to ElementHelper.areEqual(VertexProperty, Object)
BlazeGraph	graph() The BlazeGraph instance.
int	hashCode() Pass through to ElementHelper.hashCode(Element)
String	id() The internally generated element id for this vertex property.
boolean	isPresent()
String	key() Property key.
String	label() The element label, which is the property key.
<U> CloseableIterator<org.apache.tinkerpop.gremlin.structure.Property<U>>	properties(String... keys) Strength return type to CloseableIterator.
<U> BlazeProperty<U>	property(String key, U val) Strengthen return type to BlazeProperty.
com.bigdata.rdf.model.BigdataBNode	rdfId() The reified vertex property triple.
org.openrdf.model.URI	rdfLabel() The RDF representation of the element label (required by BlazeElement).
void	remove()
String	toString() Pass through to StringFactory.propertyString(Property)
V	value() Property value.

Methods inherited from class java.lang.Object

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

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

empty

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

ifPresent, orElse, orElseGet, orElseThrow

Methods inherited from interface com.blazegraph.gremlin.structure.BlazeReifiedElement

property

Methods inherited from interface com.blazegraph.gremlin.structure.BlazeElement

keys, values

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

value

Constructor Detail

BlazeVertexProperty

protected BlazeVertexProperty()

Solely for EmptyBlazeVertexProperty.

Method Detail

rdfId

public com.bigdata.rdf.model.BigdataBNode rdfId()

The reified vertex property triple.

Specified by:

rdfId in interface BlazeElement

Specified by:

rdfId in interface BlazeReifiedElement

See Also:

BlazeElement.rdfId()

id

public String id()

The internally generated element id for this vertex property.

Specified by:

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

graph

public BlazeGraph graph()

The BlazeGraph instance.

Specified by:

graph in interface BlazeElement

Specified by:

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

Specified by:

graph in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

element

public BlazeVertex element()

The vertex to which this property belongs.

Specified by:

element in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Specified by:

element in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

key

public String key()

Property key.

Specified by:

key in interface org.apache.tinkerpop.gremlin.structure.Property<V>

value

public V value()
        throws NoSuchElementException

Property value.

Specified by:

value in interface org.apache.tinkerpop.gremlin.structure.Property<V>

Throws:

NoSuchElementException

isPresent

public boolean isPresent()

Specified by:

isPresent in interface org.apache.tinkerpop.gremlin.structure.Property<V>

See Also:

Property.isPresent()

remove

public void remove()

Specified by:

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

Specified by:

remove in interface org.apache.tinkerpop.gremlin.structure.Property<V>

See Also:

Property.remove(), BlazeGraph.remove(BlazeReifiedElement)

property

public <U> BlazeProperty<U> property(String key,
                                     U val)

Strengthen return type to BlazeProperty.

Specified by:

property in interface BlazeReifiedElement

Specified by:

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

properties

public <U> CloseableIterator<org.apache.tinkerpop.gremlin.structure.Property<U>> properties(String... keys)

Strength return type to CloseableIterator. You MUST close this iterator when finished.

Specified by:

properties in interface BlazeElement

Specified by:

properties in interface BlazeReifiedElement

Specified by:

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

Specified by:

properties in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

hashCode

public int hashCode()

Pass through to ElementHelper.hashCode(Element)

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Pass through to ElementHelper.areEqual(VertexProperty, Object)

Overrides:

equals in class Object

toString

public String toString()

Pass through to StringFactory.propertyString(Property)

Overrides:

toString in class Object

label

public String label()

The element label, which is the property key.

Specified by:

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

Specified by:

label in interface org.apache.tinkerpop.gremlin.structure.VertexProperty<V>

rdfLabel

public org.openrdf.model.URI rdfLabel()

The RDF representation of the element label (required by BlazeElement).

Specified by:

rdfLabel in interface BlazeElement