oracle.pg.nosql

Class OraclePropertyGraph

java.lang.Object

oracle.pg.common.OraclePropertyGraphBase

oracle.pg.nosql.OraclePropertyGraph

All Implemented Interfaces:

Graph, IndexableGraph, KeyIndexableGraph, TransactionalGraph, MesgConsts

public class OraclePropertyGraph
extends OraclePropertyGraphBase

This class implements the Blueprints Graph interface on top of a supported backend database. Note that this implementation is not thread safe. To safely perform concurrent operations against a single graph, multiple instances of OraclePropertyGraph are recommended.

Nested Class Summary

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

OraclePropertyGraphBase.OptimizationFlag

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

TransactionalGraph.Conclusion

Field Summary

Fields inherited from class oracle.pg.common.OraclePropertyGraphBase

TYPE_DT_BOOL, TYPE_DT_BYTE, TYPE_DT_CHAR, TYPE_DT_DATE, TYPE_DT_DOUBLE, TYPE_DT_EMPTY, TYPE_DT_FLOAT, TYPE_DT_INTEGER, TYPE_DT_LONG, TYPE_DT_SERI, TYPE_DT_SHORT, TYPE_DT_STRING

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
void	addAttributeToAllEdges(EdgeOpCallback eoc, boolean skipStoreToCache, int dop, ProgressListener pl) Adds an attribute to all edges based on the specified EdgeOpCallback.
void	addAttributeToAllVertices(VertexOpCallback voc, boolean skipStoreToCache, int dop, ProgressListener pl) Adds an attribute to all vertices based on the specified VertexOpCallback.
Edge	addEdge(Object id, Vertex outVertex, Vertex inVertex, String label) This method adds an edge to the graph instance.
Vertex	addVertex(Object id) This method adds an vertex to the graph instance.
void	clearCache() Clear the vertex cache and edge cache
void	clearRepository() This method removes all vertices and edges from this property graph instance.
void	closeKVStore() This method closes the underlying KVStore instance
void	commit() Commit changes done to this property graph instace.
long	countEdges(int dop, ProgressListener pl) Counts all Edges using parallel scan with dop threads
long	countVertices(int dop, ProgressListener pl) Counts all vertices using parallel scan with dop threads
void	createGraphTables() This method creates the vertex, edge, and index metadata tables for a property graph
void	createIndexTable() This method creates the index metadata tables for a property graph
int	getClearTableDOP() Returns the number of workers used when removing all data from a table
int	getClearTablePKBufferSize() Returns the size of the primary key buffer used when removing all data from a table
int	getClearTableThreadsPerWorker() Returns the number of threads per clear table worker used when removing all rows from a table
int	getCustomizedParallelScanDOP() Get the dop used for parallel scan
OracleEdge	getEdge(Object id) Return the edge referenced by the object identifier.
OracleEdgeBase	getEdgeInstance(Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
OracleEdgeBase	getEdgeInstance(OracleVertexBase outVertex, OracleVertexBase inVertex, String edgeLabel, Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
int	getEdgePropertyNames(int dop, int timeout, Set<String> propertyNames, ProgressListener pl) Gets the property names of all edges using parallel scans and the specified DOP.
Iterable<Edge>	getEdges(String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>	getEdges(String key, Object value, Class dtClass, boolean acceptWildcard, boolean preferredLuceneQuery) Return an iterable to all matching edges that have a particular key/value property.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID) Gets an array of Iterable objects that hold all the edges in the graph.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int iTotalSplits, int iStartSplitID, boolean bOptimizedSplits, String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int iTotalSplits, int startSplitID, String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String key) Gets an array of Iterable objects that hold all the edges in the graph that have a particular key.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys, EdgeFilterCallback efc) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>[]	getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>[]	getEdgesWithCustomizedParallelTableScan(String[] keys) Return an Iterable to all the edges in the graph that have any of the specified keys.
Iterable<Edge>[]	getEdgesWithCustomizedParallelTableScan(String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag optFlag) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>	getEdgesWithDefaultParallelTableScan(String[] keys) Return an Iterable to all the edges in the graph that have any of the specified keys.
Iterable<Edge>	getEdgesWithDefaultParallelTableScan(String[] keys, EdgeFilterCallback efc) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
Iterable<Edge>	getEdgesWithDefaultParallelTableScan(String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag optFlag) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
int	getEdgeTableSplits() Get the number of Edge table splits used for parallel scans in the edge table.
String	getEdgeTabName() Get the name of the Oracle NoSQL Database table used to store edges in this property graph.
Features	getFeatures() Get the particular features of the graph implementation.
String	getGraphName() This method returns the name of this property graph instance
static OraclePropertyGraph	getInstance(oracle.kv.KVStoreConfig kvconfig, String szGraphName) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.kv.KVStoreConfig kvconfig, String szGraphName, oracle.kv.LoginCredentials lc) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.kv.KVStoreConfig kvconfig, String szGraphName, String username, String password) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.kv.KVStoreConfig kvconfig, String szGraphName, String username, String password, Properties secProperties) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.kv.KVStoreConfig kvconfig, String szGraphName, String username, String password, String trustStoreFile) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.pgx.config.PgNosqlGraphConfig config) Returns an instance of OraclePropertyGraph using a PGX PgNosqlGraphConfig object.
static OraclePropertyGraph	getInstance(String storeName, String host, int port, String szGraphName) Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.
Set<Long>	getInvalidEdgeIDSet(int dop, ProgressListener pl) Gets a set of invalid edges that are stored in the property graph.
oracle.kv.KVStoreConfig	getKVStoreConfig() Get the KVStoreConfig object associated with the backend database
static oracle.kv.KVStoreConfig	getKVStoreConfig(oracle.pgx.config.PgNosqlGraphConfig config) Gets an KVStoreConfig from a PGX PgNosqlGraphConfig object
long	getMaxEdgeID(int dop, ProgressListener pl) Get the maximum edge ID using parallel scan and the specified DOP.
long	getMaxVertexID(int dop, ProgressListener pl) Get maximum vertex ID using parallel scans and the specified DOP.
long	getMinEdgeID(int dop, ProgressListener pl) Get the minimum edge ID using parallel scan with dop threads
long	getMinVertexID(int dop, ProgressListener pl) Get minimum vertex ID using parallel scans and the specified DOP.
long	getOperationQueueSize() Get the size of the operation queue
OracleIndexManager	getOracleIndexManager() Gets the Oracle PropertyGraphIndex Manager associated to this property graph instance.
oracle.kv.table.TableIteratorOptions	getTableIteratorOptions() Gets the TableIteratorOptions object associated to this property graph
OracleVertex	getVertex(Object id) Return the vertex referenced by the object identifier.
Set<Long>	getVertexIDSet(int dop, ProgressListener pl) Gets a set of Vertex IDs that are stored in the property graph
OracleVertexBase	getVertexInstance(Long vid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleVertexBase.
int	getVertexPropertyNames(int dop, int timeout, Set<String> propertyNames, ProgressListener pl) Gets the property names of all vertices using parallel scans and the specified DOP.
int	getVertexTableSplits() Get the number of Vertex table splits used for parallel scans in the vertex table.
String	getVertexTabName() Get the name of the Oracle NoSQL Database table used to store vertices in this property graph.
Iterable<Vertex>	getVertices(String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>	getVertices(String key, Object value, Class dtClass, boolean acceptWildcard, boolean preferredLuceneQuery) Return an iterable to all matching vertices that have a particular key/value property.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID) Gets an array of Iterable objects that hold all the vertices in the graph.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int iTotalSplits, int iStartSplitID, boolean bOptimizedSplits, String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int iTotalSplits, int startSplitID, String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String key) Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys, VertexFilterCallback vfc) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>[]	getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray, boolean bSkipStoreToCache, int startSplitID, String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>[]	getVerticesWithCustomizedParallelTableScan(String[] keys) Return an Iterable to all the vertices in the graph that have any of the specified keys.
Iterable<Vertex>[]	getVerticesWithCustomizedParallelTableScan(String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>	getVerticesWithDefaultParallelTableScan(String[] keys) Return an Iterable to all the vertices in the graph that have any of the specified keys.
Iterable<Vertex>	getVerticesWithDefaultParallelTableScan(String[] keys, VertexFilterCallback vfc) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
Iterable<Vertex>	getVerticesWithDefaultParallelTableScan(String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag optFlag) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
void	removeAttributeFromAllEdges(EdgeOpCallback eoc, boolean skipStoreToCache, int dop, ProgressListener pl) Removes an attribute from all edges based on the specified EdgeOpCallback.
void	removeAttributeFromAllVertices(VertexOpCallback voc, boolean skipStoreToCache, int dop, ProgressListener pl) Removes an attribute from all vertices based on the specified VertexOpCallback.
void	removeEdge(Edge edge) Remove the provided edge from the graph
void	removeVertex(Vertex vertex) Remove the provided vertex from the graph
void	setClearTableDOP(int dop) Sets the number of workers to be used when removing all rows from a table
void	setClearTablePKBufferSize(int size) Set the size of the primary key buffer used when removing all rows from a table
void	setClearTableThreadsPerWorker(int threads) Sets the number of threads per clear table worker to be used when removing all rows from a table
void	setCustomizedParallelScanDOP(int iDOP) Set the dop used for parallel scan
void	setTableIteratorOptions(oracle.kv.table.TableIteratorOptions tio) Sets the TableIteratorOptions object associated to this property graph
void	shutdown() A shutdown function is required to properly close the graph.
String	toString() Returns a very succinct String representation of this Graph instance

Methods inherited from class oracle.pg.common.OraclePropertyGraphBase

addAttributeToAllEdges, addAttributeToAllEdges, addAttributeToAllVertices, addAttributeToAllVertices, commitIndices, countEdges, countEdges, countVertices, countVertices, createIndex, createKeyIndex, createKeyIndex, createKeyIndex, dropAllAutoIndices, dropAllIndices, dropAllManualIndices, dropIndex, dropKeyIndex, dropKeyIndex, dropKeyIndex, getAutoIndex, getBatchSize, getConfig, getDefaultEdgeOptFlag, getDefaultIndexParameters, getDefaultVertexOptFlag, getEdgeFilterCallback, getEdgePropertyNames, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getIndex, getIndexedKeys, getIndexParameters, getIndices, getInvalidEdgeIDSet, getInvalidEdgeIDSet, getMaxEdgeID, getMaxEdgeID, getMaxVertexID, getMaxVertexID, getMinEdgeID, getMinEdgeID, getMinVertexID, getMinVertexID, getProgressListener, getQueueSize, getShortestPath, getShortestPath, getSimpleDateFormat, getStringForObj, getVertexFilterCallback, getVertexIDSet, getVertexIDSet, getVertexPropertyNames, getVertexPropertyNames, getVertexPropertyNames, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, isEdgeAutoIndexEnabled, isEmpty, isVertexAutoIndexEnabled, query, refreshAutoIndices, removeAttributeFromAllEdges, removeAttributeFromAllEdges, removeAttributeFromAllVertices, removeAttributeFromAllVertices, rollback, serializableToStr, setBatchSize, setDefaultEdgeOptFlag, setDefaultIndexParameters, setDefaultVertexOptFlag, setEdgeFilterCallback, setProgressListener, setQueueSize, setVertexFilterCallback, startTransaction, stopTransaction, strToSerializable, sum

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addAttributeToAllEdges

public void addAttributeToAllEdges(EdgeOpCallback eoc,
                          boolean skipStoreToCache,
                          int dop,
                          ProgressListener pl)

Adds an attribute to all edges based on the specified EdgeOpCallback.

Specified by:

addAttributeToAllEdges in class OraclePropertyGraphBase

Parameters:

eoc - an EdgeOpCallback object.

skipStoreToCache - if true, the edges instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the edges.

pl - a ProgressListener object.

addAttributeToAllVertices

public void addAttributeToAllVertices(VertexOpCallback voc,
                             boolean skipStoreToCache,
                             int dop,
                             ProgressListener pl)

Adds an attribute to all vertices based on the specified VertexOpCallback.

Specified by:

addAttributeToAllVertices in class OraclePropertyGraphBase

Parameters:

voc - a VertexOpCallback object.

skipStoreToCache - if true, the vertices instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the vertices.

pl - a ProgressListener object.

addEdge

public Edge addEdge(Object id,
           Vertex outVertex,
           Vertex inVertex,
           String label)

This method adds an edge to the graph instance. Note that this is just a logical operation. Note that this is not a thread safe method.

Specified by:

addEdge in interface Graph

Specified by:

addEdge in class OraclePropertyGraphBase

Parameters:

id - the id of the edge

outVertex - has to be of type OracleVertex

inVertex - has to be of type OracleVertex

label - edge label

Returns:

an OracleEdge object.

addVertex

public Vertex addVertex(Object id)

This method adds an vertex to the graph instance. Note that this is just a logical operation. Note that this is not a thread safe method.

Specified by:

addVertex in interface Graph

Specified by:

addVertex in class OraclePropertyGraphBase

Parameters:

id - the id of the vertex

Returns:

an OracleVertex object.

clearCache

public void clearCache()

Clear the vertex cache and edge cache

clearRepository

public void clearRepository()
                     throws Exception

This method removes all vertices and edges from this property graph instance. Additionally, all existing index are removed from this property graph instance. A DDL (truncate) is executed so there is no way to rollback.

Specified by:

clearRepository in class OraclePropertyGraphBase

Throws:

Exception

closeKVStore

public void closeKVStore()

This method closes the underlying KVStore instance

commit

public void commit()

Commit changes done to this property graph instace.

countEdges

public long countEdges(int dop,
              ProgressListener pl)

Counts all Edges using parallel scan with dop threads

Specified by:

countEdges in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the edges.

pl - a ProgressListener object.

Returns:

number of edges in the graph

countVertices

public long countVertices(int dop,
                 ProgressListener pl)

Counts all vertices using parallel scan with dop threads

Specified by:

countVertices in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

number of vertices in the graph

createGraphTables

public void createGraphTables()
                       throws Exception

This method creates the vertex, edge, and index metadata tables for a property graph

Throws:

Exception

createIndexTable

public void createIndexTable()
                      throws Exception

This method creates the index metadata tables for a property graph

Throws:

Exception

getClearTableDOP

public int getClearTableDOP()

Returns the number of workers used when removing all data from a table

Returns:

the degree of parallelism used when removing all rows from a table

getClearTablePKBufferSize

public int getClearTablePKBufferSize()

Returns the size of the primary key buffer used when removing all data from a table

Returns:

buffer size

getClearTableThreadsPerWorker

public int getClearTableThreadsPerWorker()

Returns the number of threads per clear table worker used when removing all rows from a table

Returns:

the number of threads per clear table worker used when removing all rows from a table

getCustomizedParallelScanDOP

public int getCustomizedParallelScanDOP()

Get the dop used for parallel scan

getEdge

public OracleEdge getEdge(Object id)

Return the edge referenced by the object identifier.

Specified by:

getEdge in interface Graph

Specified by:

getEdge in class OraclePropertyGraphBase

Parameters:

id - the object identifier of the referenced edge

Returns:

an OracleEdge object

getEdgeInstance

public OracleEdgeBase getEdgeInstance(Long eid,
                             boolean bCreateIfAbsentFromCache,
                             boolean bSkipStoreToCache)

Returns an instance of OracleEdgeBase. 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.

Specified by:

getEdgeInstance in class OraclePropertyGraphBase

Parameters:

eid - the id of the edge

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 OracleEdgeBase object.

getEdgeInstance

public OracleEdgeBase getEdgeInstance(OracleVertexBase outVertex,
                             OracleVertexBase inVertex,
                             String edgeLabel,
                             Long eid,
                             boolean bCreateIfAbsentFromCache,
                             boolean bSkipStoreToCache)

Returns an instance of OracleEdgeBase. 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.

Specified by:

getEdgeInstance in class OraclePropertyGraphBase

Parameters:

eid - the id of the edge

outVertex - the outgoing Vertex of the edge

inVertex - the incoming Vertex of the edge

edgeLabel - the label for the Edge.

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 OracleEdgeBase object.

getEdgePropertyNames

public int getEdgePropertyNames(int dop,
                       int timeout,
                       Set<String> propertyNames,
                       ProgressListener pl)

Gets the property names of all edges using parallel scans and the specified DOP.

Specified by:

getEdgePropertyNames in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the edges

timeout - time out in the unit of seconds

propertyNames - a set of property names to be returned

pl - a ProgressListener object.

getEdges

public Iterable<Edge> getEdges(String[] keys,
                      EdgeFilterCallback efc,
                      OraclePropertyGraphBase.OptimizationFlag flag)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified.

Specified by:

getEdges in class OraclePropertyGraphBase

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep a edge in the Iterable.

flag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

getEdges

public Iterable<Edge> getEdges(String key,
                      Object value,
                      Class dtClass,
                      boolean acceptWildcard,
                      boolean preferredLuceneQuery)

Return an iterable to all matching edges that have a particular key/value property. When an automatic text index on the given key is absent, a full table scan will be carried out to find matching edges.

Specified by:

getEdges in class OraclePropertyGraphBase

Parameters:

key - the name of the property. It MUST not be NULL.

value - the value of the property. It can be NULL which will cause all vertices with the given key to be returned.

dtClass - the datatype of the value object.

acceptWildcard - specifies if wild cards can be used in the value object. Wild cards can be used only when an automatic text index on the given key is present.

preferredLuceneQuery - if true, a look up to the automatic index will be executed to find the matches.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int startSplitID)

Gets an array of Iterable objects that hold all the edges in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int iTotalSplits,
                                   int iStartSplitID,
                                   boolean bOptimizedSplits,
                                   String[] keys,
                                   EdgeFilterCallback efc,
                                   OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [iStartSplitID, iStartSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

iTotalSplits - the total number of splits

iStartSplitID - the ID of the starting split.

bOptimizedSplits - the flag showing if using optimized splits

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int iTotalSplits,
                                   int startSplitID,
                                   String[] keys,
                                   EdgeFilterCallback efc,
                                   OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

iTotalSplits - the total number of splits

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int startSplitID,
                                   String key)

Gets an array of Iterable objects that hold all the edges in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all edges in the graph will be returned.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int startSplitID,
                                   String[] keys)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int startSplitID,
                                   String[] keys,
                                   EdgeFilterCallback efc)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

Returns:

an Iterable array object.

getEdgesPartitioned

public Iterable<Edge>[] getEdgesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                   boolean bSkipStoreToCache,
                                   int startSplitID,
                                   String[] keys,
                                   EdgeFilterCallback efc,
                                   OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getEdgesWithCustomizedParallelTableScan

public Iterable<Edge>[] getEdgesWithCustomizedParallelTableScan(String[] keys)

Return an Iterable to all the edges in the graph that have any of the specified keys.

Parameters:

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

getEdgesWithCustomizedParallelTableScan

public Iterable<Edge>[] getEdgesWithCustomizedParallelTableScan(String[] keys,
                                                       EdgeFilterCallback efc,
                                                       OraclePropertyGraphBase.OptimizationFlag optFlag)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep a edge in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

getEdgesWithDefaultParallelTableScan

public Iterable<Edge> getEdgesWithDefaultParallelTableScan(String[] keys)

Return an Iterable to all the edges in the graph that have any of the specified keys.

Parameters:

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

getEdgesWithDefaultParallelTableScan

public Iterable<Edge> getEdgesWithDefaultParallelTableScan(String[] keys,
                                                  EdgeFilterCallback efc)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.

Parameters:

keys - an array of property key names. It can be NULL which implies all edges in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

getEdgesWithDefaultParallelTableScan

public Iterable<Edge> getEdgesWithDefaultParallelTableScan(String[] keys,
                                                  EdgeFilterCallback efc,
                                                  OraclePropertyGraphBase.OptimizationFlag optFlag)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep a edge in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

getEdgeTableSplits

public int getEdgeTableSplits()

Get the number of Edge table splits used for parallel scans in the edge table.

Returns:

the number of splits in the edge table

Throws:

IOException

getEdgeTabName

public String getEdgeTabName()

Get the name of the Oracle NoSQL Database table used to store edges in this property graph.

Returns:

the edge table name.

getFeatures

public Features getFeatures()

Get the particular features of the graph implementation.

getGraphName

public String getGraphName()

This method returns the name of this property graph instance

Overrides:

getGraphName in class OraclePropertyGraphBase

getInstance

public static OraclePropertyGraph getInstance(oracle.kv.KVStoreConfig kvconfig,
                              String szGraphName)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

kvconfig - a KVStoreConfig object

szGraphName - name of the property graph to be created

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(oracle.kv.KVStoreConfig kvconfig,
                              String szGraphName,
                              oracle.kv.LoginCredentials lc)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

kvconfig - a KVStoreConfig object

szGraphName - name of the property graph to be created

lc - a LoginCredentials object that can be used to authenticate a user

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(oracle.kv.KVStoreConfig kvconfig,
                              String szGraphName,
                              String username,
                              String password)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

kvconfig - a KVStoreConfig object

szGraphName - name of the property graph to be created

username - name of the user

password - password of the user

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(oracle.kv.KVStoreConfig kvconfig,
                              String szGraphName,
                              String username,
                              String password,
                              Properties secProperties)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

kvconfig - a KVStoreConfig object

szGraphName - name of the property graph to be created

username - name of the user

password - password of the user

secProperties - a Properties object that defines the KVStoreConfig security settings

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(oracle.kv.KVStoreConfig kvconfig,
                              String szGraphName,
                              String username,
                              String password,
                              String trustStoreFile)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

kvconfig - a KVStoreConfig object

szGraphName - name of the property graph to be created

username - name of the user

password - password of the user

trustStoreFile - the name and path to a client side Java truststore file certificates)

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(oracle.pgx.config.PgNosqlGraphConfig config)
                                       throws Exception

Returns an instance of OraclePropertyGraph using a PGX PgNosqlGraphConfig object.

Parameters:

config - a PgNosqlGraphConfig object

Returns:

an OraclePropertyGraph object

Throws:

Exception

getInstance

public static OraclePropertyGraph getInstance(String storeName,
                              String host,
                              int port,
                              String szGraphName)
                                       throws Exception

Returns an instance of OraclePropertyGraph using the Oracle NoSQL Database connection and graph name provided.

Parameters:

storeName - kvstore name

host - host machine name where Oracle NoSQL database installed

port - port number

szGraphName - name of the property graph to be created

Returns:

an OraclePropertyGraph object and graph name provided.

Throws:

Exception

getInvalidEdgeIDSet

public Set<Long> getInvalidEdgeIDSet(int dop,
                            ProgressListener pl)

Gets a set of invalid edges that are stored in the property graph. An invalid edge is an edge whose IN or OUT vertex does not exist in the property graph

Specified by:

getInvalidEdgeIDSet in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

getKVStoreConfig

public oracle.kv.KVStoreConfig getKVStoreConfig()

Get the KVStoreConfig object associated with the backend database

Returns:

a KVStoreConfig object

getKVStoreConfig

public static oracle.kv.KVStoreConfig getKVStoreConfig(oracle.pgx.config.PgNosqlGraphConfig config)

Gets an KVStoreConfig from a PGX PgNosqlGraphConfig object

Parameters:

config - the PgNosqlGraphConfig object

Returns:

the KVStoreConfig object

getMaxEdgeID

public long getMaxEdgeID(int dop,
                ProgressListener pl)

Get the maximum edge ID using parallel scan and the specified DOP.

Specified by:

getMaxEdgeID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

maximum edge ID in the graph

getMaxVertexID

public long getMaxVertexID(int dop,
                  ProgressListener pl)

Get maximum vertex ID using parallel scans and the specified DOP.

Specified by:

getMaxVertexID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

maximum vertex ID in the graph

getMinEdgeID

public long getMinEdgeID(int dop,
                ProgressListener pl)

Get the minimum edge ID using parallel scan with dop threads

Specified by:

getMinEdgeID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

minimum edge ID in the graph

getMinVertexID

public long getMinVertexID(int dop,
                  ProgressListener pl)

Get minimum vertex ID using parallel scans and the specified DOP.

Specified by:

getMinVertexID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

minimum vertex ID in the graph

getOperationQueueSize

public long getOperationQueueSize()

Get the size of the operation queue

getOracleIndexManager

public OracleIndexManager getOracleIndexManager()

Gets the Oracle PropertyGraphIndex Manager associated to this property graph instance.

Specified by:

getOracleIndexManager in class OraclePropertyGraphBase

Returns:

a OracleIndexManager object.

getTableIteratorOptions

public oracle.kv.table.TableIteratorOptions getTableIteratorOptions()

Gets the TableIteratorOptions object associated to this property graph

getVertex

public OracleVertex getVertex(Object id)

Return the vertex referenced by the object identifier.

Specified by:

getVertex in interface Graph

Specified by:

getVertex in class OraclePropertyGraphBase

Parameters:

id - the object identifier of the referenced vertex

Returns:

an Vertex object

getVertexIDSet

public Set<Long> getVertexIDSet(int dop,
                       ProgressListener pl)

Gets a set of Vertex IDs that are stored in the property graph

Specified by:

getVertexIDSet in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

getVertexInstance

public OracleVertexBase getVertexInstance(Long vid,
                                 boolean bCreateIfAbsentFromCache,
                                 boolean bSkipStoreToCache)

Returns an instance of OracleVertexBase. 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.

Specified by:

getVertexInstance in class OraclePropertyGraphBase

Parameters:

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 OracleVertexBase object.

getVertexPropertyNames

public int getVertexPropertyNames(int dop,
                         int timeout,
                         Set<String> propertyNames,
                         ProgressListener pl)

Gets the property names of all vertices using parallel scans and the specified DOP.

Specified by:

getVertexPropertyNames in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices

timeout - time out in the unit of seconds

propertyNames - a set of property names to be returned

pl - a ProgressListener object.

getVertexTableSplits

public int getVertexTableSplits()

Get the number of Vertex table splits used for parallel scans in the vertex table.

Returns:

the number of splits in the vertex table

Throws:

IOException

getVertexTabName

public String getVertexTabName()

Get the name of the Oracle NoSQL Database table used to store vertices in this property graph.

Returns:

the vertex table name.

getVertices

public Iterable<Vertex> getVertices(String[] keys,
                           VertexFilterCallback vfc,
                           OraclePropertyGraphBase.OptimizationFlag optFlag)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified.

Specified by:

getVertices in class OraclePropertyGraphBase

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

getVertices

public Iterable<Vertex> getVertices(String key,
                           Object value,
                           Class dtClass,
                           boolean acceptWildcard,
                           boolean preferredLuceneQuery)

Return an iterable to all matching vertices that have a particular key/value property. When an automatic text index on the given key is absent, a full table scan will be carried out to find matching vertices.

Specified by:

getVertices in class OraclePropertyGraphBase

Parameters:

key - the name of the property. It MUST not be NULL.

value - the value of the property. It can be NULL which will cause all vertices with the given key to be returned.

dtClass - the datatype of the value object

acceptWildcard - specifies if wild cards can be used in the value object. Wild cards can be used only when an automatic text index on the given key is present.

preferredLuceneQuery - if true, a look up to the automatic index will be executed to find the matches.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int startSplitID)

Gets an array of Iterable objects that hold all the vertices in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig objects for Oracle NoSQL Database

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

Returns:

an array of Iterable objects.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int iTotalSplits,
                                        int iStartSplitID,
                                        boolean bOptimizedSplits,
                                        String[] keys,
                                        VertexFilterCallback vfc,
                                        OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [iStartSplitID, iStartSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

iTotalSplits - the total number of splits

iStartSplitID - the ID of the starting split.

bOptimizedSplits - the flag showing if using optimized splits

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int iTotalSplits,
                                        int startSplitID,
                                        String[] keys,
                                        VertexFilterCallback vfc,
                                        OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

iTotalSplits - the total number of splits

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int startSplitID,
                                        String key)

Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable array object.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int startSplitID,
                                        String[] keys)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable array object.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int startSplitID,
                                        String[] keys,
                                        VertexFilterCallback vfc)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

Returns:

an Iterable array object.

getVerticesPartitioned

public Iterable<Vertex>[] getVerticesPartitioned(oracle.kv.KVStoreConfig[] kvcArray,
                                        boolean bSkipStoreToCache,
                                        int startSplitID,
                                        String[] keys,
                                        VertexFilterCallback vfc,
                                        OraclePropertyGraphBase.OptimizationFlag optFlag)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The total splits are determined by the # of connections in the array. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

kvcArray - an array of KVStoreConfig to initialize DOP connections to the Oracle NoSQL database. DOP is determined by kvcArray.length.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

Returns:

an Iterable array object.

getVerticesWithCustomizedParallelTableScan

public Iterable<Vertex>[] getVerticesWithCustomizedParallelTableScan(String[] keys)

Return an Iterable to all the vertices in the graph that have any of the specified keys.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

getVerticesWithCustomizedParallelTableScan

public Iterable<Vertex>[] getVerticesWithCustomizedParallelTableScan(String[] keys,
                                                            VertexFilterCallback vfc,
                                                            OraclePropertyGraphBase.OptimizationFlag optFlag)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

getVerticesWithDefaultParallelTableScan

public Iterable<Vertex> getVerticesWithDefaultParallelTableScan(String[] keys)

Return an Iterable to all the vertices in the graph that have any of the specified keys.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

getVerticesWithDefaultParallelTableScan

public Iterable<Vertex> getVerticesWithDefaultParallelTableScan(String[] keys,
                                                       VertexFilterCallback vfc)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

getVerticesWithDefaultParallelTableScan

public Iterable<Vertex> getVerticesWithDefaultParallelTableScan(String[] keys,
                                                       VertexFilterCallback vfc,
                                                       OraclePropertyGraphBase.OptimizationFlag optFlag)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

optFlag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

removeAttributeFromAllEdges

public void removeAttributeFromAllEdges(EdgeOpCallback eoc,
                               boolean skipStoreToCache,
                               int dop,
                               ProgressListener pl)

Removes an attribute from all edges based on the specified EdgeOpCallback.

Specified by:

removeAttributeFromAllEdges in class OraclePropertyGraphBase

Parameters:

eoc - a EdgeOpCallback object.

skipStoreToCache - if true, the edges instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the edges.

pl - a ProgressListener object.

removeAttributeFromAllVertices

public void removeAttributeFromAllVertices(VertexOpCallback voc,
                                  boolean skipStoreToCache,
                                  int dop,
                                  ProgressListener pl)

Removes an attribute from all vertices based on the specified VertexOpCallback.

Specified by:

removeAttributeFromAllVertices in class OraclePropertyGraphBase

Parameters:

voc - a VertexOpCallback object.

skipStoreToCache - if true, the vertices instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the vertices.

pl - a ProgressListener object.

removeEdge

public void removeEdge(Edge edge)

Remove the provided edge from the graph

Specified by:

removeEdge in interface Graph

Specified by:

removeEdge in class OraclePropertyGraphBase

Parameters:

edge - an Edge object to be removed

removeVertex

public void removeVertex(Vertex vertex)

Remove the provided vertex from the graph

Parameters:

vertex - a Vertex object to be removed

setClearTableDOP

public void setClearTableDOP(int dop)

Sets the number of workers to be used when removing all rows from a table

Parameters:

dop - degree of parallelism

setClearTablePKBufferSize

public void setClearTablePKBufferSize(int size)

Set the size of the primary key buffer used when removing all rows from a table

Parameters:

size - buffer size

setClearTableThreadsPerWorker

public void setClearTableThreadsPerWorker(int threads)

Sets the number of threads per clear table worker to be used when removing all rows from a table

Parameters:

threads - number of threads per clear table worker

setCustomizedParallelScanDOP

public void setCustomizedParallelScanDOP(int iDOP)

Set the dop used for parallel scan

setTableIteratorOptions

public void setTableIteratorOptions(oracle.kv.table.TableIteratorOptions tio)

Sets the TableIteratorOptions object associated to this property graph

shutdown

public void shutdown()

A shutdown function is required to properly close the graph.

toString

public String toString()

Returns a very succinct String representation of this Graph instance

Overrides:

toString in class Object