org.apache.tinkerpop.gremlin.neo4j.structure

Class Neo4jVertexProperty<V>

java.lang.Object

org.apache.tinkerpop.gremlin.neo4j.structure.Neo4jVertexProperty<V>

All Implemented Interfaces:

Element, Property<V>, VertexProperty<V>

public final class Neo4jVertexProperty<V>
extends Object
implements VertexProperty<V>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

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

VertexProperty.Cardinality, VertexProperty.Exceptions

Field Summary

Fields

Modifier and Type	Field and Description
protected String	key
protected V	value
protected Neo4jVertex	vertex
protected Neo4jNode	vertexPropertyNode

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
Neo4jVertexProperty(Neo4jVertex vertex, Neo4jNode vertexPropertyNode)
Neo4jVertexProperty(Neo4jVertex vertex, String key, V value)
Neo4jVertexProperty(Neo4jVertex vertex, String key, V value, Neo4jNode vertexPropertyNode)

Method Summary

Modifier and Type	Method and Description
Vertex	element() Gets the Vertex that owns this VertexProperty.
boolean	equals(Object object)
int	hashCode()
Object	id() Gets the unique identifier for the graph Element.
boolean	isPresent() Whether the property is empty or not.
String	key() The key of the property.
Set<String>	keys() Get the keys of the properties associated with this element.
<U> Iterator<Property<U>>	properties(String... propertyKeys) Get an Iterator of properties.
<U> Property<U>	property(String key, U value) Add or set a property value for the Element given its key.
void	remove() Remove the property from the associated element.
String	toString()
V	value() The value of the property.

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, graph, label

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

ifPresent, orElse, orElseGet, orElseThrow

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

property, value, values

Field Detail

vertex

protected final Neo4jVertex vertex

key

protected final String key

value

protected final V value

vertexPropertyNode

protected Neo4jNode vertexPropertyNode

Constructor Detail

Neo4jVertexProperty

public Neo4jVertexProperty(Neo4jVertex vertex,
                           String key,
                           V value)

Neo4jVertexProperty

public Neo4jVertexProperty(Neo4jVertex vertex,
                           String key,
                           V value,
                           Neo4jNode vertexPropertyNode)

Neo4jVertexProperty

public Neo4jVertexProperty(Neo4jVertex vertex,
                           Neo4jNode vertexPropertyNode)

Method Detail

element

public Vertex element()

Description copied from interface: VertexProperty

Gets the Vertex that owns this VertexProperty.

Specified by:

element in interface Property<V>

Specified by:

element in interface VertexProperty<V>

Returns:

The element associated with this property (i.e. Vertex, Edge, or VertexProperty).

id

public Object id()

Description copied from interface: Element

Gets the unique identifier for the graph Element.

Specified by:

id in interface Element

Returns:

The id of the element

key

public String key()

Description copied from interface: Property

The key of the property.

Specified by:

key in interface Property<V>

Returns:

The property key

value

public V value()
        throws NoSuchElementException

Description copied from interface: Property

The value of the property.

Specified by:

value in interface Property<V>

Returns:

The property value

Throws:

NoSuchElementException - thrown if the property is empty

isPresent

public boolean isPresent()

Description copied from interface: Property

Whether the property is empty or not.

Specified by:

isPresent in interface Property<V>

Returns:

True if the property exists, else false

properties

public <U> Iterator<Property<U>> properties(String... propertyKeys)

Description copied from interface: VertexProperty

Get an Iterator of properties.

Specified by:

properties in interface Element

Specified by:

properties in interface VertexProperty<V>

property

public <U> Property<U> property(String key,
                                U value)

Description copied from interface: Element

Add or set a property value for the Element given its key.

Specified by:

property in interface Element

remove

public void remove()

Description copied from interface: Property

Remove the property from the associated element.

Specified by:

remove in interface Element

Specified by:

remove in interface Property<V>

keys

public Set<String> keys()

Description copied from interface: Element

Get the keys of the properties associated with this element. The default implementation iterators the properties and stores the keys into a HashSet.

Specified by:

keys in interface Element

Returns:

The property key set

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object