oracle.pg.nosql

Class OracleVertex

java.lang.Object

oracle.pg.nosql.OracleElement

oracle.pg.nosql.OracleVertex

All Implemented Interfaces:

java.lang.Comparable, OracleElementBase, OracleVertexBase, Element, Host, Vertex

public class OracleVertex
extends OracleElement
implements OracleVertexBase, java.lang.Comparable

This class implements the Blueprints Vertex interface on top of the supported backend database.

Nested Class Summary

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

Vertex.Exceptions

Field Summary

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

DEFAULT_LABEL, EMPTY_ARGS

Method Summary

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Edge	addEdge(java.lang.String label, com.tinkerpop.blueprints.Vertex inVertex) This method adds an outgoing edge from this vertex to the inVertex with the provided edge label.
Edge	addEdge(java.lang.String label, Vertex inVertex, java.lang.Object... keyValues) Adds an outgoing edge from this vertex to the inVertex with the provided edge label.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
java.util.Iterator<Edge>	edges(Direction direction, java.lang.String... edgeLabels) Gets an Iterator of incident edges.
boolean	equals(java.lang.Object o) This method returns true if the current OracleVertex instance is considered equal to the given OracleVertex instance
void	forceRefresh() Physically refresh this Vertex instance by reading from the underlying database
long	getDegree(com.tinkerpop.blueprints.Direction direction, java.lang.String... labels) Get the vertex degree according to the provided direction and edge labels
java.lang.Iterable<com.tinkerpop.blueprints.Edge>	getEdges(com.tinkerpop.blueprints.Direction direction, java.lang.String... labels) Return the edges incident to the vertex according to the given direction and edge labels.
static OracleVertex	getInstance(OraclePropertyGraph opg, java.lang.Long vid) Returns an instance of OracleVertex from the underlying graph
static OracleVertex	getInstance(OraclePropertyGraph opg, java.lang.Long vid, boolean bCreateIfAbsentFromCache) Returns an instance of OracleVertex.
static OracleVertex	getInstance(OraclePropertyGraph opg, java.lang.Long vid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleVertex.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(com.tinkerpop.blueprints.Direction direction, java.lang.String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
int	hashCode() This method returns the hash code
java.lang.String	label() Gets the label for the vertex which helps categorize it.
<V> java.util.Iterator<VertexProperty<V>>	properties(java.lang.String... propertyKeys) Get an Iterator of properties.
<V> OracleVertexProperty<V>	property(java.lang.String key) Get the VertexProperty for the provided key.
OracleVertexProperty	property(java.lang.String key, java.lang.Object value) Assign a key/value property to the element.
com.tinkerpop.blueprints.VertexQuery	query() Generate a query object that can be used to fine tune which edges/vertices are retrieved that are incident/adjacent to this vertex.
void	remove() This method removes this vertex from its underlying graph.
void	setLabel(java.lang.String szLbl) Sets the label for the vertex which helps categorize it.
void	setLabel(java.lang.String szLbl, boolean skipQueue, boolean skipLucene) Sets the label for the vertex which helps categorize it.
void	setPropertyGraph(OraclePropertyGraphBase opg) Sets the property graph instance associated to this element
java.lang.String	toString() Returns a String format of the vertex instance.
java.util.Iterator<Vertex>	vertices(Direction direction, java.lang.String... edgeLabels) Gets an Iterator of adjacent vertices.

Methods inherited from class oracle.pg.nosql.OracleElement

getAttributes, getId, getProperty, getPropertyGraph, getPropertyKeys, graph, id, isPartial, refresh, removeProperty, setPartial, setProperty, setProperty, setProperty, setPropertyCommon

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pg.common.OracleVertexBase

property

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

property

Methods inherited from interface oracle.pg.common.OracleElementBase

getAttributes, setPartial, setProperty, setProperty

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, removeProperty, setProperty

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

graph, id, keys, value, values

Method Detail

addEdge

public com.tinkerpop.blueprints.Edge addEdge(java.lang.String label,
                                             com.tinkerpop.blueprints.Vertex inVertex)

This method adds an outgoing edge from this vertex to the inVertex with the provided edge label. To persist the changes done to this vertex into the database, the underlying property graph must be commited.

Parameters:

label - the label of the edge

inVertex - the in vertex of the new edge to create for this vertex

Returns:

an Edge object.

addEdge

public Edge addEdge(java.lang.String label,
                    Vertex inVertex,
                    java.lang.Object... keyValues)

Adds an outgoing edge from this vertex to the inVertex with the provided edge label. To persist the changes done to this vertex into the database, the underlying property graph must be commited.

Specified by:

addEdge in interface Vertex

Parameters:

label - the label of the edge

inVertex - the in vertex of the new edge to create for this vertex

Returns:

an Edge object.

compareTo

public int compareTo(java.lang.Object o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - object to compare to

edges

public java.util.Iterator<Edge> edges(Direction direction,
                                      java.lang.String... edgeLabels)

Gets an Iterator of incident edges.

Specified by:

edges in interface Vertex

Parameters:

direction - The incident direction of the edges to retrieve off this vertex

edgeLabels - The labels of the edges to retrieve. If no labels are provided, then get all edges

equals

public boolean equals(java.lang.Object o)

This method returns true if the current OracleVertex instance is considered equal to the given OracleVertex instance

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to compare this vertex against

forceRefresh

public void forceRefresh()
                  throws java.lang.Exception

Physically refresh this Vertex instance by reading from the underlying database

Specified by:

forceRefresh in interface OracleElementBase

Specified by:

forceRefresh in class OracleElement

Throws:

java.lang.Exception

getDegree

public long getDegree(com.tinkerpop.blueprints.Direction direction,
                      java.lang.String... labels)

Get the vertex degree according to the provided direction and edge labels

Specified by:

getDegree in interface OracleVertexBase

Parameters:

direction - the direction of the edges of the adjacent vertices

labels - the labels of the edges of the adjacent vertices

Returns:

vertex degree

getEdges

public java.lang.Iterable<com.tinkerpop.blueprints.Edge> getEdges(com.tinkerpop.blueprints.Direction direction,
                                                                  java.lang.String... labels)

Return the edges incident to the vertex according to the given direction and edge labels.

Parameters:

direction - the direction of the edges to retrieve

labels - the labels of the edges to retrieve

Returns:

an iterable of incident edges

getInstance

public static OracleVertex getInstance(OraclePropertyGraph opg,
                                       java.lang.Long vid)

Returns an instance of OracleVertex from the underlying graph

Parameters:

opg - the property graph where the OracleVertex instance will be obtained

vid - the id of the vertex

Returns:

a OracleVertex object.

getInstance

public static OracleVertex getInstance(OraclePropertyGraph opg,
                                       java.lang.Long vid,
                                       boolean bCreateIfAbsentFromCache)

Returns an instance of OracleVertex. If there is no match in the cache and bCreateIfAbsentFromCache is false, then a NULL value will be returned.

Parameters:

opg - the property graph where the OracleVertex instance will be obtained

vid - the id of the vertex

bCreateIfAbsentFromCache - if false, returns a NULL value if there is no match in the cache.

Returns:

a OracleVertex object.

getInstance

public static OracleVertex getInstance(OraclePropertyGraph opg,
                                       java.lang.Long vid,
                                       boolean bCreateIfAbsentFromCache,
                                       boolean bSkipStoreToCache)

Returns an instance of OracleVertex. If there is no match in the cache and bCreateIfAbsentFromCache is false, then a NULL value will be returned.If the skipStoreToCache is true, then the vertex will not be stored into the cache.

Parameters:

opg - the property graph where the OracleVertex instance will be obtained

vid - the id of the vertex

bCreateIfAbsentFromCache - if false, returns a NULL value if there is no match in the cache.

bSkipStoreToCache - if true, the vertex instance will not be stored into the cache.

Returns:

a OracleVertex object.

getVertices

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex> getVertices(com.tinkerpop.blueprints.Direction direction,
                                                                       java.lang.String... labels)

Return the vertices adjacent to the vertex according to the provided direction and edge labels.

Parameters:

direction - the direction of the edges of the adjacent vertices

labels - the labels of the edges of the adjacent vertices

Returns:

an iterable of adjacent vertices

hashCode

public int hashCode()

This method returns the hash code

Overrides:

hashCode in class java.lang.Object

label

public java.lang.String label()

Gets the label for the vertex which helps categorize it.

Specified by:

label in interface Element

properties

public <V> java.util.Iterator<VertexProperty<V>> properties(java.lang.String... propertyKeys)

Get an Iterator of properties.

Specified by:

properties in interface Element

Specified by:

properties in interface Vertex

property

public <V> OracleVertexProperty<V> property(java.lang.String key)

Get the VertexProperty for the provided key. If the property does not exist, return VertexProperty.empty(). If there are more than one vertex properties for the provided key, then throw Vertex.Exceptions.multiplePropertiesExistForProvidedKey(java.lang.String).

Specified by:

property in interface Element

Specified by:

property in interface Vertex

Parameters:

key - the key of the vertex property to get

Returns:

the retrieved vertex property

property

public OracleVertexProperty property(java.lang.String key,
                                     java.lang.Object value)

Assign a key/value property to the element.

Specified by:

property in interface Element

Specified by:

property in interface Vertex

Parameters:

key - key of an attribute (K/V pair)

value - value of an attribute (K/V pair)

query

public com.tinkerpop.blueprints.VertexQuery query()

Generate a query object that can be used to fine tune which edges/vertices are retrieved that are incident/adjacent to this vertex.

Returns:

a VertexQuery object with methods for constraining which data is pulled from the underlying graph

remove

public void remove()

This method removes this vertex from its underlying graph. To persist the changes done to this vertex into the database, the underlying property graph must be commited.

Specified by:

remove in interface Element

setLabel

public void setLabel(java.lang.String szLbl)

Sets the label for the vertex which helps categorize it.

Specified by:

setLabel in interface OracleVertexBase

Parameters:

szLbl - the label for this vertex

setLabel

public void setLabel(java.lang.String szLbl,
                     boolean skipQueue,
                     boolean skipLucene)

Sets the label for the vertex which helps categorize it.

Specified by:

setLabel in interface OracleVertexBase

Parameters:

szLbl - the label for this vertex

skipQueue - true to prevent adding this change to the update queue

skipLucene - true to prevent updating element with indices

setPropertyGraph

public void setPropertyGraph(OraclePropertyGraphBase opg)

Sets the property graph instance associated to this element

Specified by:

setPropertyGraph in interface OracleElementBase

Overrides:

setPropertyGraph in class OracleElement

Parameters:

opg - a OraclePropertyGraph object

toString

public java.lang.String toString()

Returns a String format of the vertex instance.

Overrides:

toString in class java.lang.Object

vertices

public java.util.Iterator<Vertex> vertices(Direction direction,
                                           java.lang.String... edgeLabels)

Gets an Iterator of adjacent vertices.

Specified by:

vertices in interface Vertex

Parameters:

direction - The incident direction of the vertices to retrieve off this vertex

edgeLabels - The labels of the edges to retrieve. If no labels are provided, then get all edges.