oracle.pg.common

Class OracleVertexPropertyBase<V>

java.lang.Object

oracle.pg.common.OraclePropertyBase<V>

oracle.pg.common.OracleVertexPropertyBase<V>

All Implemented Interfaces:

OracleElement

public class OracleVertexPropertyBase<V>
extends OraclePropertyBase<V>
implements OracleElement

This class implements the VertexProperty Tinkerpop3 interface for vertex properties. A VertexProperty is similar to a Property in that it denotes a key/value pair associated with an Vertex, however it is different in the sense that it also represents an entity that it is an Element that can have properties of its own. A property is much like a Java8 Optional in that a property can be not present (i.e. empty). The key of a property is always a String and the value of a property is an arbitrary Java object. Each underlying graph engine will typically have constraints on what Java objects are allowed to be used as values.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.pg.common.OracleElement

OracleElement.FLAG

Constructor Summary

Constructors

Constructor and Description
OracleVertexPropertyBase(OracleVertexBase oracleVertex, java.lang.String key, V value) Constructs a new OracleVertexProperty object

Method Summary

Modifier and Type	Method and Description
OracleVertexBase	element() Gets the Vertex that owns this VertexProperty.
boolean	equals(java.lang.Object object) Validates if the given object is equal to this Vertex property
OraclePropertyGraphBase	graph() Get the graph that this element is within.
int	hashCode() Gets the hash code associated to this vertex property object
java.lang.Object	id() Gets the unique identifier for the Vertex Property
boolean	isPresent() Return whether the property is empty or not.
java.lang.String	key() Return the key of the property.
java.lang.String	label() Gets the label for the graph Element which helps categorize it.
<U> java.util.Iterator<OraclePropertyBase<U>>	properties(java.lang.String... propertyKeys) Get an Iterator of properties.
<V> OraclePropertyBase<V>	property(java.lang.String key, V value) Add or set a property value for the Element given its key.
void	remove() Removes the Element from the graph.
java.lang.String	toString() Returns the String representation of this vertex property
V	value() Get the value of a Property given it's key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OracleVertexPropertyBase

public OracleVertexPropertyBase(OracleVertexBase oracleVertex,
                                java.lang.String key,
                                V value)

Constructs a new OracleVertexProperty object

Parameters:

oracleVertex - the vertex associated to this property

key - the property name

value - the property value

Method Detail

element

public OracleVertexBase element()

Gets the Vertex that owns this VertexProperty.

Overrides:

element in class OraclePropertyBase<V>

equals

public boolean equals(java.lang.Object object)

Validates if the given object is equal to this Vertex property

Overrides:

equals in class OraclePropertyBase<V>

graph

public OraclePropertyGraphBase graph()

Get the graph that this element is within.

Specified by:

graph in interface OracleElement

Returns:

a OraclePropertyGraphBase

hashCode

public int hashCode()

Gets the hash code associated to this vertex property object

Overrides:

hashCode in class OraclePropertyBase<V>

id

public java.lang.Object id()

Gets the unique identifier for the Vertex Property

Specified by:

id in interface OracleElement

isPresent

public boolean isPresent()

Return whether the property is empty or not.

Overrides:

isPresent in class OraclePropertyBase<V>

key

public java.lang.String key()

Return the key of the property.

Overrides:

key in class OraclePropertyBase<V>

label

public java.lang.String label()

Gets the label for the graph Element which helps categorize it.

Specified by:

label in interface OracleElement

Returns:

The label of the element

properties

public <U> java.util.Iterator<OraclePropertyBase<U>> properties(java.lang.String... propertyKeys)

Get an Iterator of properties.

Specified by:

properties in interface OracleElement

property

public <V> OraclePropertyBase<V> property(java.lang.String key,
                                          V value)

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

Specified by:

property in interface OracleElement

remove

public void remove()

Removes the Element from the graph. TODO fix for multiple values

Specified by:

remove in interface OracleElement

Overrides:

remove in class OraclePropertyBase<V>

toString

public java.lang.String toString()

Returns the String representation of this vertex property

Overrides:

toString in class OraclePropertyBase<V>

value

public V value()
        throws java.util.NoSuchElementException

Get the value of a Property given it's key. The default implementation calls property(java.lang.String) and then returns the associated value.

Overrides:

value in class OraclePropertyBase<V>

Throws:

java.util.NoSuchElementException