oracle.pg.hbase

Class OracleVertex

java.lang.Object

oracle.pg.hbase.OracleElement

oracle.pg.hbase.OracleVertex

All Implemented Interfaces:

Element, Vertex, MesgConsts, OracleElementBase, OracleVertexBase

public class OracleVertex
extends OracleElement
implements OracleVertexBase

This class implements the Blueprints Vertex and Element interface by using an Apache HBase as back-end.

Field Summary

Fields inherited from interface oracle.pg.common.MesgConsts

ERR_ARG_CANNOT_BE_NULL, ERR_CODE_NOT_IN_LIST, ERR_DOP_CONSTRAINT, ERR_E_DS_MUSTBE_FILE_OR_IS, ERR_E_MAX_LINE_CONSTRAINT, ERR_EDGE_DIR_NOT_BOTH, 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_IN_DS_EDGE_CANTBE_NULL, ERR_IN_DS_VERT_CANTBE_NULL, ERR_IN_E_FLAT_DOESNT_EXIST, ERR_IN_V_FLAT_DOESNT_EXIST, 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_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_PG_ALREADY_EXISTS, ERR_PG_NOT_EMPTY, ERR_SIZE_MUST_BE_POS, ERR_TIMEOUT_TAB_CREATION, ERR_TYPE_ID_NOT_RECO, ERR_UNSUPPORTED_VAL_TYP, ERR_USER_REQ_OP_CANCEL, 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

Methods

Modifier and Type	Method and Description
Edge	addEdge(String label, Vertex inVertex) This method adds an outgoing edge from this vertex to the inVertex with the provided edge label.
boolean	equals(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(Direction direction, String... labels) Get the vertex degree according to the provided direction and edge labels
Iterable<Edge>	getEdges(Direction direction, OraclePropertyGraphBase.OptimizationFlag flag, String... labels) Return the edges incident to the vertex according to the given direction and edge labels.
Iterable<Edge>	getEdges(Direction direction, String... labels) Return the edges incident to the vertex according to the given direction and edge labels.
static OracleVertex	getInstance(OraclePropertyGraph opg, Long vid) Returns an instance of OracleVertex from the underlying graph
static OracleVertex	getInstance(OraclePropertyGraph opg, Long vid, boolean bCreateIfAbsentFromCache) Returns an instance of OracleVertex.
static OracleVertex	getInstance(OraclePropertyGraph opg, Long vid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleVertex.
Iterable<Vertex>	getVertices(Direction direction, OraclePropertyGraphBase.OptimizationFlag flag, String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
Iterable<Vertex>	getVertices(Direction direction, 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
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.
String	toString() Returns a String format of the vertex instance.

Methods inherited from class oracle.pg.hbase.OracleElement

getAttributes, getId, getProperty, getPropertyGraph, getPropertyKeys, 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.OracleElementBase

setPartial, setProperty

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, removeProperty, setProperty

Method Detail

addEdge

public Edge addEdge(String label,
           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.

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.

equals

public boolean equals(Object o)

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

Overrides:

equals in class Object

Parameters:

o - an object to compare this vertex against

forceRefresh

public void forceRefresh()
                  throws 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:

Exception

getDegree

public long getDegree(Direction direction,
             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 Iterable<Edge> getEdges(Direction direction,
                      OraclePropertyGraphBase.OptimizationFlag flag,
                      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

getEdges

public Iterable<Edge> getEdges(Direction direction,
                      String... labels)

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

Specified by:

getEdges in interface Vertex

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,
                       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,
                       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,
                       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 Iterable<Vertex> getVertices(Direction direction,
                           OraclePropertyGraphBase.OptimizationFlag flag,
                           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

getVertices

public Iterable<Vertex> getVertices(Direction direction,
                           String... labels)

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

Specified by:

getVertices in interface 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

hashCode

public int hashCode()

This method returns the hash code

Overrides:

hashCode in class Object

query

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

Specified by:

query in interface 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

toString

public String toString()

Returns a String format of the vertex instance.

Overrides:

toString in class Object