oracle.pg.common

Interface SparkUtilsBase

public interface SparkUtilsBase

This interface defines some helper methods to facilitate running Apache Spark tasks against property graph data stored in one of the supported backend databases.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEdgeLabel(java.lang.Object graphElementReprOnDB) When the given graph element is a repsentation of an Edge, returns the edge label.
java.lang.Long	getElementId(java.lang.Object graphElementReprOnDB) This method returns a graph element (Vertex or Edge) ID.
java.lang.Object	getGraphElementReprOnDB(java.lang.Object dbObject) This method returns a graph element representation stored in one of the underlying databases.
java.lang.Long	getInVertexId(java.lang.Object graphElementReprOnDB) When the given graph element is a repsentation of an Edge, returns the in-vertex (or destination) ID.
java.lang.Long	getOutVertexId(java.lang.Object graphElementReprOnDB) When the given graph element is a repsentation of an Edge, returns the out-vertex (or source) ID.
java.util.Set<java.lang.String>	getPropertyNames(java.lang.Object graphElementReprOnDB) This method returns a set of property names for a given graph element (Vertex or Edge).
java.lang.Object	getPropertyValue(java.lang.Object graphElementReprOnDB, java.lang.String keyName) This method returns the property value of a graph element for a given property key.
boolean	isElementForEdge(java.lang.Object graphElementReprOnDB) Returns true if the given graph element is a repsentation of an Edge.
boolean	isElementForVertex(java.lang.Object graphElementReprOnDB) Returns true if the given graph element is a repsentation of a Vertex.

Method Detail

getEdgeLabel

java.lang.String getEdgeLabel(java.lang.Object graphElementReprOnDB)

When the given graph element is a repsentation of an Edge, returns the edge label.

getElementId

java.lang.Long getElementId(java.lang.Object graphElementReprOnDB)

This method returns a graph element (Vertex or Edge) ID.

getGraphElementReprOnDB

java.lang.Object getGraphElementReprOnDB(java.lang.Object dbObject)

This method returns a graph element representation stored in one of the underlying databases. This representation is database specific and the return value should only be consumed by other APIs defined in this interface.

getInVertexId

java.lang.Long getInVertexId(java.lang.Object graphElementReprOnDB)

When the given graph element is a repsentation of an Edge, returns the in-vertex (or destination) ID.

getOutVertexId

java.lang.Long getOutVertexId(java.lang.Object graphElementReprOnDB)

When the given graph element is a repsentation of an Edge, returns the out-vertex (or source) ID.

getPropertyNames

java.util.Set<java.lang.String> getPropertyNames(java.lang.Object graphElementReprOnDB)

This method returns a set of property names for a given graph element (Vertex or Edge). A NULL value will be returned if there is no properties (K/V pairs) in the given graph element.

getPropertyValue

java.lang.Object getPropertyValue(java.lang.Object graphElementReprOnDB,
                                  java.lang.String keyName)
                           throws java.io.IOException,
                                  java.text.ParseException

This method returns the property value of a graph element for a given property key.

Throws:

java.io.IOException

java.text.ParseException

isElementForEdge

boolean isElementForEdge(java.lang.Object graphElementReprOnDB)

Returns true if the given graph element is a repsentation of an Edge.

isElementForVertex

boolean isElementForVertex(java.lang.Object graphElementReprOnDB)

Returns true if the given graph element is a repsentation of a Vertex.