oracle.pg.hbase

Class OracleEdge

java.lang.Object

oracle.pg.hbase.OracleElement

oracle.pg.hbase.OracleEdge

All Implemented Interfaces:

com.tinkerpop.blueprints.Element, java.lang.Comparable, MesgConsts, OracleEdgeBase, OracleElementBase, Edge

public class OracleEdge
extends OracleElement
implements OracleEdgeBase, MesgConsts, java.lang.Comparable

This class implements the Blueprints Edge and Element interfaces on top of the Apache HBase database.

Nested Class Summary

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

Edge.Exceptions

Field Summary

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

DEFAULT_LABEL

Fields inherited from interface oracle.pg.common.messages.MesgConsts

ERR_ARG_CANNOT_BE_NULL, ERR_CODE_NOT_IN_LIST, ERR_DOP_CONSTRAINT, ERR_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_E_AUTO_IDX_NOT_EXIST, ERR_E_DS_MUSTBE_FILE_OR_IS, ERR_E_MAX_LINE_CONSTRAINT, ERR_EDGE_DIR_NOT_BOTH, ERR_EDGE_WORK_TBL_NOT_CLEAN, ERR_GRAPH_NAME_CANT_BENULL, ERR_HIT_EXCEPTION, ERR_HIT_INTERRUPT, ERR_HIT_IO, ERR_HIT_OPGE, ERR_HIT_PARSEE, ERR_ID_CANNOT_BE_NULL, ERR_IDX_KEY_CANNOT_BE_NULL, ERR_IDX_KEY_NOT_NULL, ERR_IDX_KEYS_NOT_NULL, ERR_IN_DS_EDGE_CANTBE_NULL, ERR_IN_DS_VERT_CANTBE_NULL, ERR_IN_E_FLAT_DOESNT_EXIST, ERR_IN_V_FLAT_DOESNT_EXIST, ERR_INPUT_LIST_NOT_NULL, ERR_INPUT_NOT_NULL, ERR_INVALID_CHANGE_ACTION, ERR_INVALID_NUM_FIELDS, ERR_INVALID_NUM_NOARG, ERR_INVALID_NUMBER, ERR_INVALID_VAL, ERR_KEY_CANNOT_BE_ID, ERR_KEY_CANNOT_BE_NULL, ERR_KEY_CANNOT_BE_NULL_EMPTY, ERR_KEY_NOT_SET_TO, ERR_NO_ELEM_TO_BE_CONSUMED, ERR_NO_OP_SUPPORTED, ERR_NOT_IMPLEMENTED_YET, ERR_NOT_ORACLE_V_E, ERR_NUM_PART_CONSTRAINT, ERR_OFFSET_CONSTRAINT, ERR_OFFSET_E_MUST_BE_POS, ERR_OFFSET_V_MUST_BE_POS, ERR_OPT_FLAG_EDGE_INVALID, ERR_OPT_FLAG_VERT_INVALID, ERR_ORA_TEXT_INVALID_KEY, ERR_ORA_TEXT_ONLY_AUTO, ERR_OUTPUT_LIST_NOT_NULL, ERR_PG_ALREADY_EXISTS, ERR_PG_NOT_EMPTY, ERR_PG_NOT_NULL, ERR_SIZE_MUST_BE_POS, ERR_TIMEOUT_TAB_CREATION, ERR_TXT_IDX_NOT_FOUND, ERR_TYPE_ID_NOT_RECO, ERR_UNSUPPORTED_VAL_TYP, ERR_USER_REQ_OP_CANCEL, ERR_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_V_AUTO_IDX_NOT_EXIST, ERR_V_DS_MUSTBE_FILE_OR_IS, ERR_V_MAX_LINE_CONSTRAINT, ERR_VALUE_CANNOT_BE_NULL, INFO_EMP_K_NO_P_VAL, INFO_NUL_K_NO_P_VAL

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
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid) Returns an instance of OracleEdge
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid, boolean bCreateIfAbsentFromCache) Returns an instance of OracleEdge.
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdge.
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid, java.lang.String label) Returns an instance of OracleEdge
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid, java.lang.String label, boolean bCreateIfAbsentFromCache) Returns an instance of OracleEdge.
static OracleEdge	getInstance(OraclePropertyGraph opg, java.lang.Long eid, java.lang.String label, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdge.
static OracleEdge	getInstance(OraclePropertyGraph opg, OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdge
static OracleEdge	getInstance(OraclePropertyGraph opg, OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.String edgeLabel, java.lang.Long eid) Returns an instance of OracleEdge
static OracleEdge	getInstance(OraclePropertyGraph opg, OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.String edgeLabel, java.lang.Long eid, boolean bCreateIfAbsentFromCache) Returns an instance of OracleEdge
static OracleEdge	getInstance(OraclePropertyGraph opg, OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.String edgeLabel, java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdge
OracleVertex	getInVertex() Return the head/in vertex of the edge
java.lang.Object	getInVertexID() Return the head/in vertex ID.
java.lang.String	getLabel() Return the label associated with the edge.
OracleVertex	getOutVertex() Return the tail/out vertex of the edge
java.lang.Object	getOutVertexID() Return the tail/out vertex ID.
com.tinkerpop.blueprints.Vertex	getVertex(com.tinkerpop.blueprints.Direction direction) Return the tail/out or head/in vertex.
int	hashCode() This method returns the hash code
<V> java.util.Iterator<Property<V>>	properties(java.lang.String... propertyKeys) TODO needs to be optimized
<V> OracleProperty<V>	property(java.lang.String key) Review the vertex (or vertices) associated with this edge as defined by the direction.
OracleProperty	property(java.lang.String key, java.lang.Object value) TODO needs to be optimized Assign a key/value property to the element.
void	remove() This method removes this edge from its underlying graph.
void	setLabel(java.lang.String label) Set the label associated with the edge.
void	setProperty(java.lang.String key, java.lang.Object value) Assign a key/value property to the element.
void	setProperty(java.lang.String key, java.lang.Object value, boolean skipQueue) Assign a key/value property to the element.
void	setPropertyGraph(OraclePropertyGraphBase opg) Sets the property graph instance associated to this element
java.lang.String	toString() Returns a String representation of the Edge

Methods inherited from class oracle.pg.hbase.OracleElement

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pg.common.OracleEdgeBase

inVertex, label, outVertex, vertices

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

bothVertices

Methods inherited from interface oracle.pg.common.OracleElementBase

setPartial, setProperty

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, removeProperty

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

graph, id, keys, value, values

Method Detail

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

equals

public 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 void forceRefresh()
                  throws java.lang.Exception

Physically refresh this Edge instance by reading from the underlying database

Specified by:

forceRefresh in interface OracleElementBase

Specified by:

forceRefresh in class OracleElement

Throws:

java.lang.Exception

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid,
                                     boolean bCreateIfAbsentFromCache)

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

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid,
                                     boolean bCreateIfAbsentFromCache,
                                     boolean bSkipStoreToCache)

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

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

bSkipStoreToCache - whether the Edge should be stored in the cache or not

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid,
                                     java.lang.String label)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

label - the label for the Edge

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid,
                                     java.lang.String label,
                                     boolean bCreateIfAbsentFromCache)

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

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

label - the label for the Edge

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     java.lang.Long eid,
                                     java.lang.String label,
                                     boolean bCreateIfAbsentFromCache,
                                     boolean bSkipStoreToCache)

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

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

eid - the id for the Edge

label - the label for the Edge

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

bSkipStoreToCache - whether the Edge should be stored in the cache or not

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     OracleVertexBase outVertex,
                                     OracleVertexBase inVertex,
                                     java.lang.Long eid,
                                     boolean bCreateIfAbsentFromCache,
                                     boolean bSkipStoreToCache)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

outVertex - the outgoing Vertex of the Edge.

inVertex - the incoming Vertex of the Edge.

eid - the id for the Edge.

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

bSkipStoreToCache - whether the Edge should be stored in the cache or not

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     OracleVertexBase outVertex,
                                     OracleVertexBase inVertex,
                                     java.lang.String edgeLabel,
                                     java.lang.Long eid)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

outVertex - the outgoing Vertex of the Edge.

inVertex - the incoming Vertex of the Edge.

edgeLabel - the label for the Edge.

eid - the id for the Edge.

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     OracleVertexBase outVertex,
                                     OracleVertexBase inVertex,
                                     java.lang.String edgeLabel,
                                     java.lang.Long eid,
                                     boolean bCreateIfAbsentFromCache)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

outVertex - the outgoing Vertex of the Edge.

inVertex - the incoming Vertex of the Edge.

edgeLabel - the label for the Edge.

eid - the id for the Edge.

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

getInstance

public static OracleEdge getInstance(OraclePropertyGraph opg,
                                     OracleVertexBase outVertex,
                                     OracleVertexBase inVertex,
                                     java.lang.String edgeLabel,
                                     java.lang.Long eid,
                                     boolean bCreateIfAbsentFromCache,
                                     boolean bSkipStoreToCache)

Returns an instance of OracleEdge

Parameters:

opg - the OraclePropertyGraph that the Edge belongs to.

outVertex - the outgoing Vertex of the Edge.

inVertex - the incoming Vertex of the Edge.

edgeLabel - the label for the Edge.

eid - the id for the Edge.

bCreateIfAbsentFromCache - whether the Edge should be created or not if it is not found in the cache.

bSkipStoreToCache - whether the Edge should be stored in the cache or not

getInVertex

public OracleVertex getInVertex()

Return the head/in vertex of the edge

Specified by:

getInVertex in interface OracleEdgeBase

getInVertexID

public java.lang.Object getInVertexID()

Return the head/in vertex ID.

Specified by:

getInVertexID in interface OracleEdgeBase

getLabel

public java.lang.String getLabel()

Return the label associated with the edge.

getOutVertex

public OracleVertex getOutVertex()

Return the tail/out vertex of the edge

Specified by:

getOutVertex in interface OracleEdgeBase

getOutVertexID

public java.lang.Object getOutVertexID()

Return the tail/out vertex ID.

Specified by:

getOutVertexID in interface OracleEdgeBase

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(com.tinkerpop.blueprints.Direction direction)

Return the tail/out or head/in vertex.

hashCode

public int hashCode()

This method returns the hash code

Overrides:

hashCode in class java.lang.Object

properties

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

TODO needs to be optimized

Specified by:

properties in interface Edge

property

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

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

Parameters:

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

Returns:

an iterator with 1 or 2 vertices public Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction) { List<org.apache.tinkerpop.gremlin.structure.Vertex> vertices = new ArrayList<org.apache.tinkerpop.gremlin.structure.Vertex>(); if (org.apache.tinkerpop.gremlin.structure.Direction.IN.equals(direction) || Direction.BOTH.equals(direction)) { vertices.add(inVertex()); } else if (org.apache.tinkerpop.gremlin.structure.Direction.IN.equals(direction) || Direction.BOTH.equals(direction)) { vertices.add(outVertex()); } return vertices.iterator(); } /** Gets the label for the graph Edge which helps categorize it.

property

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

TODO needs to be optimized Assign a key/value property to the element.

Parameters:

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

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

remove

public 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 com.tinkerpop.blueprints.Element

setLabel

public void setLabel(java.lang.String label)

Set the label associated with the edge.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Assign a key/value property to the element.

Specified by:

setProperty in interface com.tinkerpop.blueprints.Element

Overrides:

setProperty in class OracleElement

Parameters:

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

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

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value,
                        boolean skipQueue)

Assign a key/value property to the element.

Specified by:

setProperty in interface OracleElementBase

Overrides:

setProperty in class OracleElement

Parameters:

key - key of the attribute (K/V)

value - value of the attribute (K/V)

skipQueue - when true, then this K/V pair change will not cause this Element to be put in the update queue.

setPropertyGraph

public void setPropertyGraph(OraclePropertyGraphBase opg)

Sets the property graph instance associated to this element

Specified by:

setPropertyGraph in interface OracleElementBase

Parameters:

opg - a OraclePropertyGraph object

toString

public java.lang.String toString()

Returns a String representation of the Edge

Overrides:

toString in class java.lang.Object