oracle.pg.common

Class OracleVertexBase

java.lang.Object

oracle.pg.common.OracleElementBase

oracle.pg.common.OracleVertexBase

All Implemented Interfaces:

java.lang.Comparable<java.lang.Object>, org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.util.Host, org.apache.tinkerpop.gremlin.structure.Vertex

Direct Known Subclasses:

OracleVertex, OracleVertex, OracleVertex

public abstract class OracleVertexBase
extends OracleElementBase
implements org.apache.tinkerpop.gremlin.structure.Vertex, java.lang.Comparable<java.lang.Object>

This class implements the Blueprints Vertex interface on top of a supported backed database

Nested Class Summary

Nested classes/interfaces inherited from class oracle.pg.common.OracleElementBase

OracleElementBase.FLAG

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

org.apache.tinkerpop.gremlin.structure.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
org.apache.tinkerpop.gremlin.structure.Edge	addEdge(java.lang.String label, org.apache.tinkerpop.gremlin.structure.Vertex inVertex) This method adds an outgoing edge from this vertex to the inVertex with the provided edge label.
org.apache.tinkerpop.gremlin.structure.Edge	addEdge(java.lang.String label, org.apache.tinkerpop.gremlin.structure.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.
abstract long	degree(org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(org.apache.tinkerpop.gremlin.structure.Direction direction, OraclePropertyGraphBase.OptimizationFlag flag, java.lang.String... labels) Return the edges incident to the vertex according to the given direction and edge labels.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String... labels) Return the edges incident to the vertex according to the given direction and edge labels.
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
int	hashCode() This method returns the hash code
java.lang.String	label() Gets the label for the vertex which helps categorize it.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.VertexProperty<java.lang.Object>>	properties(java.lang.String... propertyKeys) Get an Iterator of properties.
OracleVertexPropertyBase<java.lang.Object>	property(java.lang.String key) Get the VertexProperty for the provided key.
OracleVertexPropertyBase<java.lang.Object>	property(java.lang.String key, java.lang.Object value) Assign a key/value property to the element.
org.apache.tinkerpop.gremlin.structure.VertexProperty<java.lang.Object>	property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality, java.lang.String key, java.lang.Object value, java.lang.Object... keyValues) Create a new vertex property.
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.
java.lang.String	toString() Returns a String format of the vertex instance.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction, OraclePropertyGraphBase.OptimizationFlag flag, java.lang.String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.

Methods inherited from class oracle.pg.common.OracleElementBase

clearAddedKeys, clearDeletedKeys, getAddedKeys, getAttributes, getDeletedKeys, getDeletedProperties, getFlag, graph, id, isPartial, keys, property, property, propertyCommon, propertyValue, refresh, removeProperty, setCreatedWithOptFlag, setFlag, setGraph, setPartial

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

property

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

graph, id, keys, value, values

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Method Detail

addEdge

public final org.apache.tinkerpop.gremlin.structure.Edge addEdge(java.lang.String label,
                                                                 org.apache.tinkerpop.gremlin.structure.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 final org.apache.tinkerpop.gremlin.structure.Edge addEdge(java.lang.String label,
                                                                 org.apache.tinkerpop.gremlin.structure.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 org.apache.tinkerpop.gremlin.structure.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 final 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<java.lang.Object>

Parameters:

o - object to compare to

degree

public abstract long degree(org.apache.tinkerpop.gremlin.structure.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

edges

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                                      OraclePropertyGraphBase.OptimizationFlag flag,
                                                                                      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

edges

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                                   java.lang.String... labels)

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

Specified by:

edges in interface org.apache.tinkerpop.gremlin.structure.Vertex

Parameters:

direction - the direction of the edges to retrieve

labels - the labels of the edges to retrieve

Returns:

an iterable of incident 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 final void forceRefresh()
                        throws java.lang.Exception

Physically refresh this Vertex instance by reading from the underlying database

Specified by:

forceRefresh in class OracleElementBase

Throws:

java.lang.Exception

hashCode

public final 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 org.apache.tinkerpop.gremlin.structure.Element

properties

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.VertexProperty<java.lang.Object>> properties(java.lang.String... propertyKeys)

Get an Iterator of properties.

Specified by:

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

Specified by:

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

property

public final OracleVertexPropertyBase<java.lang.Object> 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 org.apache.tinkerpop.gremlin.structure.Element

Specified by:

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

Parameters:

key - the key of the vertex property to get

Returns:

the retrieved vertex property

property

public final OracleVertexPropertyBase<java.lang.Object> property(java.lang.String key,
                                                                 java.lang.Object value)

Assign a key/value property to the element.

Specified by:

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

Specified by:

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

Parameters:

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

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

property

public final org.apache.tinkerpop.gremlin.structure.VertexProperty<java.lang.Object> property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality cardinality,
                                                                                              java.lang.String key,
                                                                                              java.lang.Object value,
                                                                                              java.lang.Object... keyValues)

Create a new vertex property. If the cardinality is VertexProperty.Cardinality.single, then set the key to the value. Multiple values for a vertex property are not supported. If the cardinality is VertexProperty.Cardinality.list, then a UnsupportedOperationException will be thrown. If the cardinality is VertexProperty.Cardinality.set, then a UnsupportedOperationException will be thrown. Vertex property properties are not supported, so keyvalues are not stored.

Specified by:

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

remove

public final 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 org.apache.tinkerpop.gremlin.structure.Element

setLabel

public final void setLabel(java.lang.String szLbl)

Sets the label for the vertex which helps categorize it.

Parameters:

szLbl - the label for this vertex

setLabel

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

Sets the label for the vertex which helps categorize it.

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

toString

public final java.lang.String toString()

Returns a String format of the vertex instance.

Overrides:

toString in class java.lang.Object

vertices

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                                           OraclePropertyGraphBase.OptimizationFlag flag,
                                                                                           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

vertices

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                                        java.lang.String... labels)

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

Specified by:

vertices in interface org.apache.tinkerpop.gremlin.structure.Vertex

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