oracle.pg.common

Class OracleEdgeBase

java.lang.Object

oracle.pg.common.OracleElementBase

oracle.pg.common.OracleEdgeBase

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Edge, org.apache.tinkerpop.gremlin.structure.Element

Direct Known Subclasses:

OracleEdge, OracleEdge, OracleEdge

public abstract class OracleEdgeBase
extends OracleElementBase
implements org.apache.tinkerpop.gremlin.structure.Edge

This class implements the Blueprints Edge and Edge interface by using one of the supported backend 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.Edge

org.apache.tinkerpop.gremlin.structure.Edge.Exceptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_LBL
static java.lang.String	NULL_LBL

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
OracleEdgeBase()

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o) This method returns true if the current OracleEdge instance is considered equal to the given OracleEdge instance
void	forceRefresh() Physically refresh this Edge instance by reading from the underlying database
int	hashCode() This method returns the hash code
OracleVertexBase	inVertex() Return the head/in vertex of the edge
java.lang.Object	inVertexID() Return the head/in vertex ID.
java.lang.String	label() Return the label associated with the edge.
OracleVertexBase	outVertex() Return the tail/out vertex of the edge
java.lang.Object	outVertexID() Return the tail/out vertex ID.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Property<java.lang.Object>>	properties(java.lang.String... propertyKeys) Get an Iterator of properties.
OraclePropertyBase<java.lang.Object>	property(java.lang.String key) Get a Property for the Element given its key.
OraclePropertyBase<java.lang.Object>	property(java.lang.String key, java.lang.Object value) Add or set a property value for the Element given its key.
void	remove() This method removes this edge from its underlying graph.
void	setInVertex(OracleVertexBase v)
void	setLabel(java.lang.String label) Set the label associated with the edge.
void	setLabel(java.lang.String label, boolean skipUpdate) Set the label associated with the edge.
void	setOutVertex(OracleVertexBase v)
java.lang.String	toString() Returns a String representation of the Edge
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction) Review the vertex (or vertices) associated with this edge as defined by the direction.

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.Edge

bothVertices

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

graph, id, keys, value, values

Field Detail

EMPTY_LBL

public static final java.lang.String EMPTY_LBL

NULL_LBL

public static final java.lang.String NULL_LBL

Constructor Detail

OracleEdgeBase

public OracleEdgeBase()

Method Detail

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.

Parameters:

o - object to compare to

equals

public final boolean equals(java.lang.Object o)

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

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to compare this edge against

forceRefresh

public final void forceRefresh()
                        throws java.lang.Exception

Physically refresh this Edge 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

inVertex

public OracleVertexBase inVertex()

Return the head/in vertex of the edge

Specified by:

inVertex in interface org.apache.tinkerpop.gremlin.structure.Edge

inVertexID

public java.lang.Object inVertexID()

Return the head/in vertex ID.

label

public final java.lang.String label()

Return the label associated with the edge.

Specified by:

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

outVertex

public OracleVertexBase outVertex()

Return the tail/out vertex of the edge

Specified by:

outVertex in interface org.apache.tinkerpop.gremlin.structure.Edge

outVertexID

public java.lang.Object outVertexID()

Return the tail/out vertex ID.

properties

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

Get an Iterator of properties.

Specified by:

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

Specified by:

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

property

public final OraclePropertyBase<java.lang.Object> property(java.lang.String key)

Get a Property for the Element given its key. The default implementation calls the raw Element#properties.

Specified by:

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

property

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

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

Specified by:

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

Parameters:

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

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

remove

public final void remove()

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

Specified by:

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

setInVertex

public final void setInVertex(OracleVertexBase v)

setLabel

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

Set the label associated with the edge.

setLabel

public final void setLabel(java.lang.String label,
                           boolean skipUpdate)

Set the label associated with the edge.

setOutVertex

public final void setOutVertex(OracleVertexBase v)

toString

public final java.lang.String toString()

Returns a String representation of the Edge

Overrides:

toString in class java.lang.Object

vertices

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

Review the vertex (or vertices) associated with this edge as defined by the direction. If the direction is Direction.BOTH then the iterator order is Direction.OUT then Direction.IN

Specified by:

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

Parameters:

direction - Get the incoming vertex, outgoing vertex, or botth vertices

Returns:

an iterator with 1 or 2 vertices