oracle.pg.common

Class OraclePropertyGraphBase

java.lang.Object

oracle.pg.common.OraclePropertyGraphBase

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, oracle.pg.common.messages.MesgConsts, OracleCSVDatatypeConstants, OracleGraphAttributeUpdater, OracleIndexableGraph, OracleMessageConstants, OracleMetadataGraph, OraclePropertyGraphConstants, OraclePropertyGraphDatatypeConstants, org.apache.tinkerpop.gremlin.structure.Graph, org.apache.tinkerpop.gremlin.structure.util.Host

Direct Known Subclasses:

OraclePropertyGraph, OraclePropertyGraph, SQLAnalyticsGraph

public abstract class OraclePropertyGraphBase
extends java.lang.Object
implements org.apache.tinkerpop.gremlin.structure.Graph, OracleIndexableGraph, OracleMetadataGraph, OracleGraphAttributeUpdater, OraclePropertyGraphConstants, oracle.pg.common.messages.MesgConsts, OracleMessageConstants, java.io.Closeable

This class implements the Blueprints Graph interface on top of a supported backend database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OraclePropertyGraphBase.CacheStatus This enum defines a set of cache status.
static class	OraclePropertyGraphBase.OptimizationFlag This enum defines a set of optimization flags that can be used to influence the construction of Vertex or Edge objects during scans.

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

org.apache.tinkerpop.gremlin.structure.Graph.Exceptions, org.apache.tinkerpop.gremlin.structure.Graph.Features, org.apache.tinkerpop.gremlin.structure.Graph.Hidden, org.apache.tinkerpop.gremlin.structure.Graph.OptIn, org.apache.tinkerpop.gremlin.structure.Graph.OptIns, org.apache.tinkerpop.gremlin.structure.Graph.OptOut, org.apache.tinkerpop.gremlin.structure.Graph.OptOuts, org.apache.tinkerpop.gremlin.structure.Graph.Variables

Nested classes/interfaces inherited from interface oracle.pg.common.OraclePropertyGraphConstants

OraclePropertyGraphConstants.QueueAction

Field Summary

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

GRAPH

Fields inherited from interface oracle.pg.common.OracleMessageConstants

MG_ERR_USER_REQ_OP_CANCEL, MSG_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_E_AUTO_IDX_NOT_EXIST, MSG_ERR_ARG_CANNOT_BE_NULL, MSG_ERR_ID_CANNOT_BE_NULL, MSG_ERR_NO_ELEM_TO_BE_CONSUMED, MSG_ERR_NO_OP_SUPPORTED, MSG_IDX_KEY_NOT_NULL, MSG_IDX_KEYS_NOT_NULL, MSG_TXT_IDX_NOT_FOUND, MSG_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_V_AUTO_IDX_NOT_EXIST

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

Fields inherited from interface oracle.pg.common.OraclePropertyGraphConstants

VERTEX_LABEL

Fields inherited from interface oracle.pg.common.OracleCSVDatatypeConstants

CSV_DATE_TIME_FORMATS, CSV_DT_KEYWORD_BOOLEAN, CSV_DT_KEYWORD_BYTE, CSV_DT_KEYWORD_CHAR, CSV_DT_KEYWORD_DATE, CSV_DT_KEYWORD_DOUBLE, CSV_DT_KEYWORD_FLOAT, CSV_DT_KEYWORD_INTEGER, CSV_DT_KEYWORD_JSON, CSV_DT_KEYWORD_LONG, CSV_DT_KEYWORD_RDF, CSV_DT_KEYWORD_SHORT, CSV_DT_KEYWORD_SPATIAL, CSV_DT_KEYWORD_STRING, OPG_DATETIME_FORMAT

Fields inherited from interface oracle.pg.common.OraclePropertyGraphDatatypeConstants

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_JSON, TYPE_DT_LONG, TYPE_DT_SERI, TYPE_DT_SHORT, TYPE_DT_SPATIAL, TYPE_DT_STRING, TYPE_DT_URI

Method Summary

Modifier and Type	Method and Description
abstract org.apache.tinkerpop.gremlin.structure.Edge	addEdge(java.lang.Object id, org.apache.tinkerpop.gremlin.structure.Vertex outVertex, org.apache.tinkerpop.gremlin.structure.Vertex inVertex, java.lang.String label) This method adds an edge to the graph instance.
void	addUpdatedEdge(OracleEdgeBase e) Add an updated edge into this property graph
void	addUpdatedVertex(OracleVertexBase v) Add an updated vertex into this property graph
org.apache.tinkerpop.gremlin.structure.Vertex	addVertex(java.lang.Object... keyValues) Add a Vertex to the graph given an optional series of key/value pairs.
org.apache.tinkerpop.gremlin.structure.Vertex	addVertex(java.lang.Object id)
abstract org.apache.tinkerpop.gremlin.structure.Vertex	addVertexById(java.lang.Object id) This method adds an vertex to the graph instance.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	adjacentEdgesFromVertices(java.lang.Object[] ids, org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String[] labels, int dop) Return an iterator to the vertices in the graph identified by the specified requestedIds using the specified dop
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	adjacentEdgesFromVertices(java.lang.Object[] ids, java.lang.String[] labels, org.apache.tinkerpop.gremlin.structure.Direction direction) Return an iterator to the vertices in the graph identified by the specified requestedIds
void	clearCache() Clears the internal Vertex and Edge cache.
abstract void	clearRepository() This method removes all vertices and edges from this property graph instance.
void	clearUpdateQueue()
abstract void	commit() Commits current changes done to this graph
void	commitIndices() Commits all changes executed into the text indices associated to this graph
org.apache.tinkerpop.gremlin.process.computer.GraphComputer	compute() Generate a GraphComputer using the default engine of the underlying graph system.
<C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C	compute(java.lang.Class<C> graphComputerClass) Declare the GraphComputer to use for OLAP operations on the graph.
org.apache.commons.configuration.Configuration	configuration() Get the org.apache.commons.configuration.Configuration associated with the construction of this graph.
<T extends org.apache.tinkerpop.gremlin.structure.Element> OracleIndex<T>	createIndex(java.lang.String indexName, java.lang.Class<T> indexClass, Parameter... indexParameters) Generates an index with a particular name, for a particular class, and of a particular type.
java.lang.Object	decodeObject(int iType, java.lang.String szVal)
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges() Return an Iterator to all the edges in the graph.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(java.lang.Object... ids) Get the Edge objects in this graph with the provided edge ids or Edge objects.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByIds(java.lang.Object[] ids) Return an iterator to the edges in the graph identified by the specified requestedIds
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByIds(java.lang.Object[] ids, int dop) Return an iterator to the edges in the graph identified by the specified requestedIds using the specified dop
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByProperty(java.lang.String key, java.lang.Object value) Return an iterable to all matching edges that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByProperty(java.lang.String key, java.lang.Object value, boolean useWildCard) Return an iterable to all matching edges that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByProperty(java.lang.String key, java.lang.Object value, boolean acceptWildcard, boolean useLuceneSyntax) Return an iterable to all matching edges that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByProperty(java.lang.String key, java.lang.Object value, java.lang.Class<?> dtClass, boolean acceptWildcard) Return an iterable to all matching edges that have a particular key/value property.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByProperty(java.lang.String key, java.lang.Object value, java.lang.Class<?> dtClass, boolean acceptWildcard, boolean useLuceneSyntax) Return an iterable to all matching edges that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByPropertyKey(java.lang.String key) Return an Iterator to all the edges in the graph that have a particular key.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByPropertyKey(java.lang.String[] keys) Return an Iterator to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByPropertyKey(java.lang.String[] keys, EdgeFilterCallback efc) Return an Iterator to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edgesByPropertyKey(java.lang.String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag) Return an Iterator to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
int	getBatchSize() Get the size of the batch used for update operations.
OraclePropertyGraphBase.CacheStatus	getCacheStatus() Returns the currenct cache status
AbstractPgGraphConfig	getConfig() Gets the PGX graph config object
java.lang.Class	getDatatypeClassFromValueObjForTextIndex(java.lang.Object value) Gets the data type class from the given value object.
static java.time.format.DateTimeFormatter	getDateTimeFormatter() This method returns a DateTimeFormatter object to serialize/de-serialize Date related data
OraclePropertyGraphBase.OptimizationFlag	getDefaultEdgeOptFlag() Get the edge optimization flag associated to this property graph
OracleIndexParameters	getDefaultIndexParameters() Get the default index parameters associated to this property graph.
OraclePropertyGraphBase.OptimizationFlag	getDefaultVertexOptFlag() Get the vertex optimization flag associated to this property graph
abstract org.apache.tinkerpop.gremlin.structure.Edge	getEdge(java.lang.Object id) Return the edge referenced by the object identifier.
EdgeFilterCallback	getEdgeFilterCallback() Get the default EdgeFilterCallback associated to this property graph
abstract OracleEdgeBase	getEdgeInstance(java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
abstract OracleEdgeBase	getEdgeInstance(OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.String edgeLabel, java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
java.util.Iterator<java.util.Map.Entry<java.lang.Object,java.lang.Object>>	getElementsProperties(java.lang.Object[] ids, java.lang.String propertyName, int dop, java.lang.Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementClass)
java.lang.String	getGraphName() This method returns the name of this property graph instance
static OraclePropertyGraphBase.OptimizationFlag	getJustEdgeIdOptFlag() This method returns OptimizationFlag.JUST_EDGE_ID
static OraclePropertyGraphBase.OptimizationFlag	getJustVertexIdOptFlag() This method returns OptimizationFlag.JUST_VERTEX_ID
long	getMaxLabelLengthAllowedInBytes() Get the maximum value length allowed for a label in Bytes
long	getMaxPropertyNameLengthAllowedInBytes() Get the maximum value length allowed for a property name in Bytes
long	getMaxValueLengthAllowedInBytes() Get the maximum value length allowed for a property value in Bytes
long	getOperationQueueSize() Get the size of the operation queue
abstract OracleIndexManager	getOracleIndexManager() Gets the OracleIndexManager object associated to this property graph instance.
ProgressListener	getProgressListener() Gets the ProgressListener associated to this property graph.
int	getQueueSize() This method returns the queue size.
java.util.List<org.apache.tinkerpop.gremlin.structure.Vertex>	getShortestPath(PgxGraph g, java.lang.Long startVertexID, java.lang.Long endVertexID, java.lang.String weightPropertyName, java.util.List<java.lang.Double> weights) Finds a shortest path between two vertices using a PGX in-memory analytics.
java.util.List<org.apache.tinkerpop.gremlin.structure.Vertex>	getShortestPath(PgxGraph g, org.apache.tinkerpop.gremlin.structure.Vertex start, org.apache.tinkerpop.gremlin.structure.Vertex end, java.lang.String weightPropertyName, java.util.List<java.lang.Double> weights) Finds a shortest path between two vertices using a PGX in-memory analytics.
java.text.SimpleDateFormat	getSimpleDateFormat() This method returns a SimpleDateFormat object to serialize/de-serialize Date related data
static java.lang.String	getStringForObj(java.lang.Object objVa1) Get the string representation of the object
java.lang.String	getTextIndexDirectoryPrefix() This method returns the prefix used when creating a text index directory (or collection)
abstract org.apache.tinkerpop.gremlin.structure.Vertex	getVertex(java.lang.Object id) Return the vertex referenced by the object identifier.
VertexFilterCallback	getVertexFilterCallback() Get the default VertexFilterCallback associated to this property graph
abstract OracleVertexBase	getVertexInstance(java.lang.Long vid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleVertexBase.
<I extends org.apache.tinkerpop.gremlin.structure.io.Io> I	io(org.apache.tinkerpop.gremlin.structure.io.Io.Builder<I> builder) Construct a particular Io implementation for reading and writing the Graph and other data.
boolean	isBuiltinElementsCacheDisabled() Returns true if the built-in graph elements (vertices/edges) cache is disabled
boolean	isDisposed() Validates if the graph is already disposed
boolean	isEmpty() Checks if this property graph is empty
boolean	isShutdown() Validates if the graph is already shutdown
boolean	isSkipRefreshIndicesEnabled() Check if the skip refresh indices is enabled (for Data loading)
boolean	isTransientPropertyGraphInstance() Verifies if this is a transient property graph instance.
abstract void	removeEdge(org.apache.tinkerpop.gremlin.structure.Edge edge) Remove the provided edge from the graph
void	removeEdges(EdgeOpCallback eoc) Removes a set of edges from the graph based on the given OpCallback
void	removeEdges(EdgeOpCallback eoc, int dop) Removes a set of edges from the graph based on the given OpCallback
void	removeEdges(java.lang.Long[] ids) Removes a set of edges from the graph
void	removeEdges(java.lang.Long[] ids, int dop) Removes a set of edges from the graph
abstract void	removeVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Remove the provided vertex from the graph
void	removeVertices(java.lang.Long[] ids) Removes a set of vertices from the graph
void	removeVertices(java.lang.Long[] ids, int dop) Removes a set of vertices from the graph
void	removeVertices(VertexOpCallback voc) Removes a set of vertices from the graph based on the given OpCallback
void	removeVertices(VertexOpCallback voc, int dop) Removes a set of vertices from the graph based on the given OpCallback
void	rollback() Rollbacks the operations done to this property graph instance
static java.lang.String	serializableToStr(java.io.Serializable seri) Convert from a Java Serializable object to a String encoding.
void	setBatchSize(int batchsize) Set the size of the batch used for update operations.
void	setCacheStatus(OraclePropertyGraphBase.CacheStatus cs) Set the currenct cache status.
void	setDefaultEdgeOptFlag(OraclePropertyGraphBase.OptimizationFlag eof) Set the default edge optimization flag associated to this property graph.
void	setDefaultIndexParameters(OracleIndexParameters indexParams) Set the default index parameters associated to this property graph.
void	setDefaultVertexOptFlag(OraclePropertyGraphBase.OptimizationFlag vof) Set the default vertex optimization flag associated to this property graph
void	setEdgeFilterCallback(EdgeFilterCallback efc) Set the default EdgeFilterCallback associated to this property graph
void	setProgressListener(ProgressListener pl) Sets the ProgressListener associated to this property graph.
void	setQueueSize(int size) This method sets the queue size.
void	setSkipRefreshIndices(boolean skip) Set skip refresh indices (for Data loading)
void	setSolrJavaBinFormat(boolean bSolrJavaBinFormat) Set the flag to determine if the SolrCloud server will use a Binary format for the query responses
void	setTransientPropertyGraphInstance(boolean flag) Specifies if this property graph instance is a transient instance.
void	setVertexFilterCallback(VertexFilterCallback vfc) Set the default VertexFilterCallback associated to this property graph
void	startTransaction() Start a transaction.
static java.lang.Object	strToSerializable(java.lang.String s) Convert from a String encoding to a Serializable object
double	sum(java.util.List<java.lang.Double> val) Adds up a list of double values and return the sum.
boolean	supportVertexLabels() Validates if the property graph instance support vertex labels
java.lang.String	toString() Returns a very succinct String representation of this Graph instance
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	traversal() Generate a reusable GraphTraversalSource instance.
<C extends org.apache.tinkerpop.gremlin.process.traversal.TraversalSource> C	traversal(java.lang.Class<C> traversalSourceClass) Generate a TraversalSource using the specified TraversalSource class.
org.apache.tinkerpop.gremlin.structure.Transaction	tx() Configure and control the transactions for those graphs that support this feature.
boolean	useSolrJavaBinFormat() Specifies if the SolrCloud server will use a Binary format for the query responses
org.apache.tinkerpop.gremlin.structure.Graph.Variables	variables() A collection of global Graph.Variables associated with the graph.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices() Return an iterable to all the vertices in the graph.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(java.lang.Object... ids) Get the Vertex objects in this graph with the provided vertex ids or Vertex objects.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByIds(java.lang.Object[] ids) Return an iterable to the vertices in the graph identified by the specified requestedIds
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByIds(java.lang.Object[] ids, int dop) Return an iterable to the vertices in the graph identified by the specified requestedIds using the specified dop
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByProperty(java.lang.String key, java.lang.Object value) Return an iterable to all matching vertices that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByProperty(java.lang.String key, java.lang.Object value, boolean useWildCards) Return an iterable to all matching vertices that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByProperty(java.lang.String key, java.lang.Object value, boolean acceptWildcard, boolean useLuceneSyntax) Return an iterable to all matching vertices that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByProperty(java.lang.String key, java.lang.Object value, java.lang.Class<?> dtClass, boolean acceptWildcard) Return an iterable to all matching vertices that have a particular key/value property.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByProperty(java.lang.String key, java.lang.Object value, java.lang.Class<?> dtClass, boolean acceptWildcard, boolean useLuceneSyntax) Return an iterable to all matching vertices that have a particular key/value property.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByPropertyKey(java.lang.String keys) Return an Iterator to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByPropertyKey(java.lang.String[] keys) Return an Iterator to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByPropertyKey(java.lang.String[] keys, VertexFilterCallback vfc) Return an Iterator to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	verticesByPropertyKey(java.lang.String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag flag) Return an Iterator to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.

Methods inherited from class java.lang.Object

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

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

addVertex, close, features

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Methods inherited from interface oracle.pg.common.OracleIndexableGraph

createKeyIndex, createKeyIndex, createKeyIndex, dropAllAutoIndices, dropAllIndices, dropAllManualIndices, dropIndex, dropKeyIndex, dropKeyIndex, dropKeyIndex, edgesUsingTextSearch, getAutoIndex, getIndex, getIndexedKeys, getIndexParameters, getIndices, isEdgeAutoIndexEnabled, isVertexAutoIndexEnabled, refreshAutoIndices, validateIndexManager, verticesUsingTextSearch

Methods inherited from interface oracle.pg.common.OracleMetadataGraph

countEdges, countEdges, countEdges, countVertices, countVertices, countVertices, getEdgePropertyNames, getEdgePropertyNames, getEdgePropertyNames, getEdgePropertyNames, getElementsProperties, getInvalidEdgeIDSet, getInvalidEdgeIDSet, getInvalidEdgeIDSet, getMaxEdgeID, getMaxEdgeID, getMaxEdgeID, getMaxVertexID, getMaxVertexID, getMaxVertexID, getMinEdgeID, getMinEdgeID, getMinEdgeID, getMinVertexID, getMinVertexID, getMinVertexID, getVertexIDSet, getVertexIDSet, getVertexIDSet, getVertexPropertyNames, getVertexPropertyNames, getVertexPropertyNames, getVertexPropertyNames

Methods inherited from interface oracle.pg.common.OracleGraphAttributeUpdater

addAttributeToAllEdges, addAttributeToAllEdges, addAttributeToAllEdges, addAttributeToAllVertices, addAttributeToAllVertices, addAttributeToAllVertices, getDOPForMetadataOperations, removeAttributeFromAllEdges, removeAttributeFromAllEdges, removeAttributeFromAllEdges, removeAttributeFromAllVertices, removeAttributeFromAllVertices, removeAttributeFromAllVertices, updateGraph

Methods inherited from interface java.io.Closeable

close

Method Detail

addEdge

public abstract org.apache.tinkerpop.gremlin.structure.Edge addEdge(java.lang.Object id,
                                                                    org.apache.tinkerpop.gremlin.structure.Vertex outVertex,
                                                                    org.apache.tinkerpop.gremlin.structure.Vertex inVertex,
                                                                    java.lang.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.

Parameters:

id - the id of the vertex

outVertex - has to be of type OracleVertex

inVertex - has to be of type OracleVertex

label - edge label

Returns:

an Edge object.

addUpdatedEdge

public final void addUpdatedEdge(OracleEdgeBase e)

Add an updated edge into this property graph

Parameters:

v - the updated edge

addUpdatedVertex

public final void addUpdatedVertex(OracleVertexBase v)

Add an updated vertex into this property graph

Parameters:

v - the updated vertex

addVertex

public final org.apache.tinkerpop.gremlin.structure.Vertex addVertex(java.lang.Object... keyValues)

Add a Vertex to the graph given an optional series of key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.

Specified by:

addVertex in interface org.apache.tinkerpop.gremlin.structure.Graph

Parameters:

keyValues - The key/value pairs to turn into vertex properties

Returns:

the newly created vertex

addVertex

public final org.apache.tinkerpop.gremlin.structure.Vertex addVertex(java.lang.Object id)

addVertexById

public abstract org.apache.tinkerpop.gremlin.structure.Vertex addVertexById(java.lang.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.

Parameters:

id - the id of the vertex

Returns:

an Vertex object.

adjacentEdgesFromVertices

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> adjacentEdgesFromVertices(java.lang.Object[] ids,
                                                                                                       org.apache.tinkerpop.gremlin.structure.Direction direction,
                                                                                                       java.lang.String[] labels,
                                                                                                       int dop)

Return an iterator to the vertices in the graph identified by the specified requestedIds using the specified dop

Parameters:

ids - an array of requestedIds

dop - the degree of parallelism to use when searching for the vertices

adjacentEdgesFromVertices

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> adjacentEdgesFromVertices(java.lang.Object[] ids,
                                                                                                 java.lang.String[] labels,
                                                                                                 org.apache.tinkerpop.gremlin.structure.Direction direction)

Return an iterator to the vertices in the graph identified by the specified requestedIds

Parameters:

ids - an array of requestedIds

clearCache

public final void clearCache()

Clears the internal Vertex and Edge cache.

clearRepository

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

Throws:

java.lang.Exception

clearUpdateQueue

public void clearUpdateQueue()

commit

public abstract void commit()

Commits current changes done to this graph

commitIndices

public final void commitIndices()

Commits all changes executed into the text indices associated to this graph

compute

public org.apache.tinkerpop.gremlin.process.computer.GraphComputer compute()
                                                                    throws java.lang.IllegalArgumentException

Generate a GraphComputer using the default engine of the underlying graph system. This is a shorthand method for the more involved method that uses compute(Class).

Specified by:

compute in interface org.apache.tinkerpop.gremlin.structure.Graph

Throws:

java.lang.UnsupportedOperationException

java.lang.IllegalArgumentException

compute

public <C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C compute(java.lang.Class<C> graphComputerClass)
                                                                                  throws java.lang.IllegalArgumentException

Declare the GraphComputer to use for OLAP operations on the graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown.

Specified by:

compute in interface org.apache.tinkerpop.gremlin.structure.Graph

Parameters:

graphComputerClass - the graph computer class to use

Throws:

java.lang.IllegalArgumentException - if the provided GraphComputer class is not supported

java.lang.UnsupportedOperationException

configuration

public org.apache.commons.configuration.Configuration configuration()

Get the org.apache.commons.configuration.Configuration associated with the construction of this graph.

Specified by:

configuration in interface org.apache.tinkerpop.gremlin.structure.Graph

Throws:

java.lang.UnsupportedOperationException

createIndex

public final <T extends org.apache.tinkerpop.gremlin.structure.Element> OracleIndex<T> createIndex(java.lang.String indexName,
                                                                                                   java.lang.Class<T> indexClass,
                                                                                                   Parameter... indexParameters)

Generates an index with a particular name, for a particular class, and of a particular type.

Specified by:

createIndex in interface OracleIndexableGraph

Parameters:

indexName - the name of the index

indexClassthe - element class that this index is indexing (can be base class)

indexParameters - a collection of parameters for the underlying index implementation

Returns:

the index created

decodeObject

public final java.lang.Object decodeObject(int iType,
                                           java.lang.String szVal)
                                    throws java.lang.NumberFormatException,
                                           java.time.format.DateTimeParseException,
                                           java.io.IOException,
                                           java.text.ParseException

Throws:

java.lang.NumberFormatException

java.time.format.DateTimeParseException

java.io.IOException

java.text.ParseException

edges

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges()

Return an Iterator to all the edges in the graph.

edges

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(java.lang.Object... ids)

Get the Edge objects in this graph with the provided edge ids or Edge objects. If no ids are provided, get all edges. Note that an edge identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here. If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with: g.edges(e) g.edges(e.id()) g.edges(1) g.edges(1L) g.edges(1.0d) g.edges(1.0f) g.edges("1") If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id()) g.edges(e.id().toString()) If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id()) If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id().toString()) g.edges("id")

Specified by:

edges in interface org.apache.tinkerpop.gremlin.structure.Graph

Parameters:

ids - the ids of the edges to get

Returns:

an Iterator of edges that match the provided edge ids

edgesByIds

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByIds(java.lang.Object[] ids)

Return an iterator to the edges in the graph identified by the specified requestedIds

Parameters:

ids - an array of requestedIds

edgesByIds

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByIds(java.lang.Object[] ids,
                                                                                  int dop)

Return an iterator to the edges in the graph identified by the specified requestedIds using the specified dop

Parameters:

ids - an array of requestedIds

dop - the degree of parallelism used when searching for the edges

edgesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByProperty(java.lang.String key,
                                                                                             java.lang.Object value)

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.

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 edges with the given key to be returned.

edgesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByProperty(java.lang.String key,
                                                                                             java.lang.Object value,
                                                                                             boolean useWildCard)

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.

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 edges with the given key to be returned.

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

edgesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByProperty(java.lang.String key,
                                                                                             java.lang.Object value,
                                                                                             boolean acceptWildcard,
                                                                                             boolean useLuceneSyntax)

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.

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 edges with the given key to be returned.

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.

useLuceneSyntax - specifies if the value object is using an Apache Lucene Syntax (further details on Apache Lucene Syntax can be found in https://lucene.apache.org/core/2_9_4/queryparsersyntax.html). If the automatic index is not enabled ahd this flag is set to true, an Exception will be thrown as Lucene Syntax is not supported for database lookups.

edgesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByProperty(java.lang.String key,
                                                                                             java.lang.Object value,
                                                                                             java.lang.Class<?> dtClass,
                                                                                             boolean acceptWildcard)

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.

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 edges with the given key to be returned.

dtClassthe - class representing the datatype of the property value. This can be used to cast the property value to a different datatype. For example, if the value is "3.01" and dtClassis Float.Class, then this value will be treated as a 3.01f. If dtClassis set to NULL, then the query will be executed by trying to match the value object to all the supported datatypes.

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.

edgesByProperty

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByProperty(java.lang.String key,
                                                                                                java.lang.Object value,
                                                                                                java.lang.Class<?> dtClass,
                                                                                                boolean acceptWildcard,
                                                                                                boolean useLuceneSyntax)

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.

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 edges with the given key to be returned.

dtClassthe - class representing the datatype of the property value. This can be used to cast the property value to a different datatype. For example, if the value is "3.01" and dtClass is Float.Class, then this value will be treated as a 3.01f. If dtClass is set to NULL, then the query will be executed by trying to match the value object to all the supported datatypes.

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.

useLuceneSyntax - specifies if the value object is using an Apache Lucene Syntax (further details on Apache Lucene Syntax can be found in https://lucene.apache.org/core/2_9_4/queryparsersyntax.html). If the automatic index is not enabled ahd this flag is set to true, an Exception will be thrown as Lucene Syntax is not supported for database lookups.

edgesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByPropertyKey(java.lang.String key)

Return an Iterator to all the edges in the graph that have a particular key.

Parameters:

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

edgesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByPropertyKey(java.lang.String[] keys)

Return an Iterator 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.

edgesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByPropertyKey(java.lang.String[] keys,
                                                                                                EdgeFilterCallback efc)

Return an Iterator 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 Iterator.

edgesByPropertyKey

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edgesByPropertyKey(java.lang.String[] keys,
                                                                                                   EdgeFilterCallback efc,
                                                                                                   OraclePropertyGraphBase.OptimizationFlag flag)

Return an Iterator 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 Iterator.

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.

getBatchSize

public int getBatchSize()

Get the size of the batch used for update operations.

getCacheStatus

public OraclePropertyGraphBase.CacheStatus getCacheStatus()

Returns the currenct cache status

getConfig

public AbstractPgGraphConfig getConfig()

Gets the PGX graph config object

getDatatypeClassFromValueObjForTextIndex

public java.lang.Class getDatatypeClassFromValueObjForTextIndex(java.lang.Object value)

Gets the data type class from the given value object. This is the data type that will be used for text indexing.

Specified by:

getDatatypeClassFromValueObjForTextIndex in interface OracleIndexableGraph

getDateTimeFormatter

public static final java.time.format.DateTimeFormatter getDateTimeFormatter()

This method returns a DateTimeFormatter object to serialize/de-serialize Date related data

getDefaultEdgeOptFlag

public final OraclePropertyGraphBase.OptimizationFlag getDefaultEdgeOptFlag()

Get the edge optimization flag associated to this property graph

Returns:

an OptimizationFlag object

getDefaultIndexParameters

public OracleIndexParameters getDefaultIndexParameters()

Get the default index parameters associated to this property graph. The index parameters provided here will be used when an automatic or manual index is to be created without an explicit specification of the index parameters.

Specified by:

getDefaultIndexParameters in interface OracleIndexableGraph

Returns:

a OracleIndexParameters object.

getDefaultVertexOptFlag

public final OraclePropertyGraphBase.OptimizationFlag getDefaultVertexOptFlag()

Get the vertex optimization flag associated to this property graph

Returns:

an OptimizationFlag object

getEdge

public abstract org.apache.tinkerpop.gremlin.structure.Edge getEdge(java.lang.Object id)

Return the edge referenced by the object identifier.

Parameters:

id - the object identifier of the referenced edge

Returns:

an Edge object

getEdgeFilterCallback

public final EdgeFilterCallback getEdgeFilterCallback()

Get the default EdgeFilterCallback associated to this property graph

Returns:

a EdgeFilterCallback object

getEdgeInstance

public abstract OracleEdgeBase getEdgeInstance(java.lang.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.

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 abstract OracleEdgeBase getEdgeInstance(OracleVertexBase outVertex,
                                               OracleVertexBase inVertex,
                                               java.lang.String edgeLabel,
                                               java.lang.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.

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.

getElementsProperties

public final java.util.Iterator<java.util.Map.Entry<java.lang.Object,java.lang.Object>> getElementsProperties(java.lang.Object[] ids,
                                                                                                              java.lang.String propertyName,
                                                                                                              int dop,
                                                                                                              java.lang.Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementClass)

Specified by:

getElementsProperties in interface OracleMetadataGraph

getGraphName

public final java.lang.String getGraphName()

This method returns the name of this property graph instance

getJustEdgeIdOptFlag

public static final OraclePropertyGraphBase.OptimizationFlag getJustEdgeIdOptFlag()

This method returns OptimizationFlag.JUST_EDGE_ID

getJustVertexIdOptFlag

public static final OraclePropertyGraphBase.OptimizationFlag getJustVertexIdOptFlag()

This method returns OptimizationFlag.JUST_VERTEX_ID

getMaxLabelLengthAllowedInBytes

public long getMaxLabelLengthAllowedInBytes()

Get the maximum value length allowed for a label in Bytes

getMaxPropertyNameLengthAllowedInBytes

public long getMaxPropertyNameLengthAllowedInBytes()

Get the maximum value length allowed for a property name in Bytes

getMaxValueLengthAllowedInBytes

public long getMaxValueLengthAllowedInBytes()

Get the maximum value length allowed for a property value in Bytes

getOperationQueueSize

public long getOperationQueueSize()

Get the size of the operation queue

getOracleIndexManager

public abstract OracleIndexManager getOracleIndexManager()

Gets the OracleIndexManager object associated to this property graph instance.

Specified by:

getOracleIndexManager in interface OracleIndexableGraph

Returns:

a OracleIndexManager object.

getProgressListener

public final ProgressListener getProgressListener()

Gets the ProgressListener associated to this property graph.

Specified by:

getProgressListener in interface OracleGraphAttributeUpdater

Specified by:

getProgressListener in interface OracleMetadataGraph

Returns:

a ProgressListener object.

getQueueSize

public final int getQueueSize()

This method returns the queue size.

Returns:

the size of the queue

getShortestPath

public java.util.List<org.apache.tinkerpop.gremlin.structure.Vertex> getShortestPath(PgxGraph g,
                                                                                     java.lang.Long startVertexID,
                                                                                     java.lang.Long endVertexID,
                                                                                     java.lang.String weightPropertyName,
                                                                                     java.util.List<java.lang.Double> weights)
                                                                              throws java.lang.InterruptedException,
                                                                                     java.util.concurrent.ExecutionException

Finds a shortest path between two vertices using a PGX in-memory analytics.

Parameters:

g - a PgxGraph object.

startVertexID - the start vertex ID

endVertexID - the end vertex ID

weightPropertyName - the property name that will be used to define the weight of the edges in the graph

weights - a list that will be populated with the weights of each edge in the shortest path

Returns:

a list of vertices between the startVertexID and endVertexID that represent the shortest path. If no path was found, return NULL.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getShortestPath

public java.util.List<org.apache.tinkerpop.gremlin.structure.Vertex> getShortestPath(PgxGraph g,
                                                                                     org.apache.tinkerpop.gremlin.structure.Vertex start,
                                                                                     org.apache.tinkerpop.gremlin.structure.Vertex end,
                                                                                     java.lang.String weightPropertyName,
                                                                                     java.util.List<java.lang.Double> weights)
                                                                              throws java.lang.InterruptedException,
                                                                                     java.util.concurrent.ExecutionException

Finds a shortest path between two vertices using a PGX in-memory analytics.

Parameters:

g - a PgxGraph object.

start - the start vertex

end - the end vertex

weightPropertyName - the property name that will be used to define the weight of the edges in the graph

weights - a list that will be populated with the weights of each edge in the shortest path

Returns:

a list of vertices between the startVertexID and endVertexID that represent the shortest path. If no path was found, return NULL.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getSimpleDateFormat

public final java.text.SimpleDateFormat getSimpleDateFormat()

This method returns a SimpleDateFormat object to serialize/de-serialize Date related data

getStringForObj

public static final java.lang.String getStringForObj(java.lang.Object objVa1)

Get the string representation of the object

Parameters:

objVa1 - an object

Returns:

the string representation of the object

getTextIndexDirectoryPrefix

public java.lang.String getTextIndexDirectoryPrefix()

This method returns the prefix used when creating a text index directory (or collection)

getVertex

public abstract org.apache.tinkerpop.gremlin.structure.Vertex getVertex(java.lang.Object id)

Return the vertex referenced by the object identifier.

Parameters:

id - the object identifier of the referenced vertex

Returns:

an Vertex object

getVertexFilterCallback

public final VertexFilterCallback getVertexFilterCallback()

Get the default VertexFilterCallback associated to this property graph

Returns:

a VertexFilterCallback object

getVertexInstance

public abstract OracleVertexBase getVertexInstance(java.lang.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.

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.

io

public <I extends org.apache.tinkerpop.gremlin.structure.io.Io> I io(org.apache.tinkerpop.gremlin.structure.io.Io.Builder<I> builder)

Construct a particular Io implementation for reading and writing the Graph and other data. End-users will "select" the Io implementation that they want to use by supplying the Io.Builder that constructs it. In this way, Graph vendors can supply their IoRegistry to that builder thus allowing for custom serializers to be auto-configured into the Io instance. Registering custom serializers is particularly useful for those graphs that have complex types for Element identifiers. For those graphs that do not need to register any custom serializers, the default implementation should suffice. If the default is overridden, take care to register the current graph via the Io.Builder.graph(Graph) method.

Specified by:

io in interface org.apache.tinkerpop.gremlin.structure.Graph

isBuiltinElementsCacheDisabled

public boolean isBuiltinElementsCacheDisabled()

Returns true if the built-in graph elements (vertices/edges) cache is disabled

isDisposed

public final boolean isDisposed()

Validates if the graph is already disposed

isEmpty

public final boolean isEmpty()
                      throws java.io.IOException

Checks if this property graph is empty

Specified by:

isEmpty in interface OracleMetadataGraph

Returns:

true if the graph does not have any vertices or edges

Throws:

java.io.IOException

isShutdown

public final boolean isShutdown()

Validates if the graph is already shutdown

isSkipRefreshIndicesEnabled

public final boolean isSkipRefreshIndicesEnabled()

Check if the skip refresh indices is enabled (for Data loading)

isTransientPropertyGraphInstance

public final boolean isTransientPropertyGraphInstance()

Verifies if this is a transient property graph instance. Transient graphs are used when reading vertices/edges in parallel. Transient graphs should be l

removeEdge

public abstract void removeEdge(org.apache.tinkerpop.gremlin.structure.Edge edge)

Remove the provided edge from the graph

Parameters:

edge - an Edge object to be removed

removeEdges

public void removeEdges(EdgeOpCallback eoc)

Removes a set of edges from the graph based on the given OpCallback

Parameters:

eoc - the EdgeOpCallback the opCallback used to filter edges for removal

removeEdges

public void removeEdges(EdgeOpCallback eoc,
                        int dop)

Removes a set of edges from the graph based on the given OpCallback

Parameters:

eoc - the EdgeOpCallback the opCallback used to filter edges for removal

removeEdges

public void removeEdges(java.lang.Long[] ids)

Removes a set of edges from the graph

Parameters:

ids - a set with the ids of the edges to be removed

removeEdges

public void removeEdges(java.lang.Long[] ids,
                        int dop)

Removes a set of edges from the graph

Parameters:

ids - a set with the ids of the edges to be removed

removeVertex

public abstract void removeVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Remove the provided vertex from the graph

Parameters:

vertex - a Vertex object to be removed

removeVertices

public void removeVertices(java.lang.Long[] ids)

Removes a set of vertices from the graph

Parameters:

ids - a set with the ids of the vertices to be removed

removeVertices

public void removeVertices(java.lang.Long[] ids,
                           int dop)

Removes a set of vertices from the graph

Parameters:

ids - a set with the ids of the vertices to be removed

removeVertices

public void removeVertices(VertexOpCallback voc)

Removes a set of vertices from the graph based on the given OpCallback

Parameters:

voc - the VertexOpCallback the opCallback used to filter vertices for removal

removeVertices

public void removeVertices(VertexOpCallback voc,
                           int dop)

Removes a set of vertices from the graph based on the given OpCallback

Parameters:

voc - the VertexOpCallback the opCallback used to filter vertices for removal

rollback

public void rollback()

Rollbacks the operations done to this property graph instance

serializableToStr

public static final java.lang.String serializableToStr(java.io.Serializable seri)
                                                throws java.io.IOException

Convert from a Java Serializable object to a String encoding.

Parameters:

seri - an object of Serializable type. It must not be null.

Returns:

a String encoding of the Java Serializable object.

Throws:

java.io.IOException

setBatchSize

public void setBatchSize(int batchsize)

Set the size of the batch used for update operations.

Parameters:

batchsize - the size of the batch used for update operations.

setCacheStatus

public void setCacheStatus(OraclePropertyGraphBase.CacheStatus cs)

Set the currenct cache status. Note that this method will potentially change the caching behavior of the built-in graph elements cache.

setDefaultEdgeOptFlag

public final void setDefaultEdgeOptFlag(OraclePropertyGraphBase.OptimizationFlag eof)

Set the default edge optimization flag associated to this property graph.

Parameters:

eof - an edge OptimizationFlag object to be set to this property graph

setDefaultIndexParameters

public final void setDefaultIndexParameters(OracleIndexParameters indexParams)

Set the default index parameters associated to this property graph. The indexParams provided here will be used when an automatic or manual index is to be created without an explicit specification of the index parameters.

Specified by:

setDefaultIndexParameters in interface OracleIndexableGraph

Parameters:

indexParams - a OracleIndexParameters object.

setDefaultVertexOptFlag

public final void setDefaultVertexOptFlag(OraclePropertyGraphBase.OptimizationFlag vof)

Set the default vertex optimization flag associated to this property graph

Parameters:

vof - an OptimizationFlag object to be set to this property graph

setEdgeFilterCallback

public final void setEdgeFilterCallback(EdgeFilterCallback efc)

Set the default EdgeFilterCallback associated to this property graph

Parameters:

efc - a EdgeFilterCallback object to be set to this property graph

setProgressListener

public final void setProgressListener(ProgressListener pl)

Sets the ProgressListener associated to this property graph.

Specified by:

setProgressListener in interface OracleGraphAttributeUpdater

Parameters:

pl - a ProgressListener object.

setQueueSize

public final void setQueueSize(int size)

This method sets the queue size.

Parameters:

size - the size of the queue

setSkipRefreshIndices

public final void setSkipRefreshIndices(boolean skip)

Set skip refresh indices (for Data loading)

setSolrJavaBinFormat

public final void setSolrJavaBinFormat(boolean bSolrJavaBinFormat)

Set the flag to determine if the SolrCloud server will use a Binary format for the query responses

setTransientPropertyGraphInstance

public final void setTransientPropertyGraphInstance(boolean flag)

Specifies if this property graph instance is a transient instance.

setVertexFilterCallback

public final void setVertexFilterCallback(VertexFilterCallback vfc)

Set the default VertexFilterCallback associated to this property graph

Parameters:

vfc - a VertexFilterCallback object to be set to this property graph

startTransaction

public final void startTransaction()

Start a transaction.

strToSerializable

public static final java.lang.Object strToSerializable(java.lang.String s)
                                                throws java.io.IOException

Convert from a String encoding to a Serializable object

Parameters:

s - String representation of a Java Serializable object. It MUST not be null.

Returns:

a Java Serializable object obtained from an encoded String.

Throws:

java.io.IOException

sum

public double sum(java.util.List<java.lang.Double> val)

Adds up a list of double values and return the sum.

Parameters:

val - a list of Double values.

Returns:

the result of the values addition.

supportVertexLabels

public boolean supportVertexLabels()

Validates if the property graph instance support vertex labels

toString

public final java.lang.String toString()

Returns a very succinct String representation of this Graph instance

Overrides:

toString in class java.lang.Object

traversal

public final org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal()

Generate a reusable GraphTraversalSource instance. The GraphTraversalSource provides methods for creating GraphTraversal instances.

Specified by:

traversal in interface org.apache.tinkerpop.gremlin.structure.Graph

Returns:

a graph traversal source

traversal

public <C extends org.apache.tinkerpop.gremlin.process.traversal.TraversalSource> C traversal(java.lang.Class<C> traversalSourceClass)

Generate a TraversalSource using the specified TraversalSource class. The reusable TraversalSource provides methods for spawning Traversal instances.

Specified by:

traversal in interface org.apache.tinkerpop.gremlin.structure.Graph

Parameters:

traversalSourceClass - the traversal source class

tx

public final org.apache.tinkerpop.gremlin.structure.Transaction tx()

Configure and control the transactions for those graphs that support this feature. Note that this method does not indicate the creation of a "transaction" object. A Transaction in the TinkerPop context is a transaction "factory" or "controller" that helps manage transactions owned by the underlying graph database.

Specified by:

tx in interface org.apache.tinkerpop.gremlin.structure.Graph

useSolrJavaBinFormat

public final boolean useSolrJavaBinFormat()

Specifies if the SolrCloud server will use a Binary format for the query responses

variables

public final org.apache.tinkerpop.gremlin.structure.Graph.Variables variables()

A collection of global Graph.Variables associated with the graph. Variables are used for storing metadata about the graph.

Specified by:

variables in interface org.apache.tinkerpop.gremlin.structure.Graph

vertices

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

Return an iterable to all the vertices in the graph.

vertices

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(java.lang.Object... ids)

Get the Vertex objects in this graph with the provided vertex ids or Vertex objects. If no ids are provided, get all vertices. Note that an vertex identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here. If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with: g.vertices(v) g.vertices(v.id()) g.vertices(1) g.vertices(1L) g.vertices(1.0d) g.vertices(1.0f) g.vertices("1") If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id()) g.edges(e.id().toString()) If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with: g.verticess(v) g.vertices(v.id()) If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with: g.vertices(v) g.vertices(v.id().toString()) g.vertices("id")

Specified by:

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

Parameters:

ids - the ids of the edges to get

Returns:

an Iterator of vertices that match the provided vertex ids

verticesByIds

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByIds(java.lang.Object[] ids)

Return an iterable to the vertices in the graph identified by the specified requestedIds

Parameters:

ids - an array of requestedIds

verticesByIds

public java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByIds(java.lang.Object[] ids,
                                                                                       int dop)

Return an iterable to the vertices in the graph identified by the specified requestedIds using the specified dop

Parameters:

ids - an array of requestedIds

dop - the degree of parallelism to use when searching for the vertices

verticesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByProperty(java.lang.String key,
                                                                                                  java.lang.Object value)

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.

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.

verticesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByProperty(java.lang.String key,
                                                                                                  java.lang.Object value,
                                                                                                  boolean useWildCards)

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.

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.

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

verticesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByProperty(java.lang.String key,
                                                                                                  java.lang.Object value,
                                                                                                  boolean acceptWildcard,
                                                                                                  boolean useLuceneSyntax)

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.

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.

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.

useLuceneSyntax - specifies if the value object is using an Apache Lucene Syntax (further details on Apache Lucene Syntax can be found in https://lucene.apache.org/core/2_9_4/queryparsersyntax.html). If the automatic index is not enabled ahd this flag is set to true, an Exception will be thrown as Lucene Syntax is not supported for database lookups.

verticesByProperty

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByProperty(java.lang.String key,
                                                                                                  java.lang.Object value,
                                                                                                  java.lang.Class<?> dtClass,
                                                                                                  boolean acceptWildcard)

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.

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 class representing the datatype of the property value. This can be used to cast the property value to a different datatype. For example, if the value is "3.01" and dtClass is Float.Class, then this value will be treated as a 3.01f. If dtClass is set to NULL, then the query will be executed by trying to match the value object to all the supported datatypes.

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.

verticesByProperty

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByProperty(java.lang.String key,
                                                                                                     java.lang.Object value,
                                                                                                     java.lang.Class<?> dtClass,
                                                                                                     boolean acceptWildcard,
                                                                                                     boolean useLuceneSyntax)

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.

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.

dtClassthe - class representing the datatype of the property value. This can be used to cast the property value to a different datatype. For example, if the value is "3.01" and dtClassis Float.Class, then this value will be treated as a 3.01f. If dtClassis set to NULL, then the query will be executed by trying to match the value object to all the supported datatypes.

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.

useLuceneSyntax - specifies if the value object is using an Apache Lucene Syntax (further details on Apache Lucene Syntax can be found in https://lucene.apache.org/core/2_9_4/queryparsersyntax.html). If the automatic index is not enabled ahd this flag is set to true, an Exception will be thrown as Lucene Syntax is not supported for database lookups.

verticesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByPropertyKey(java.lang.String keys)

Return an Iterator 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.

verticesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByPropertyKey(java.lang.String[] keys)

Return an Iterator 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.

verticesByPropertyKey

public final java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByPropertyKey(java.lang.String[] keys,
                                                                                                     VertexFilterCallback vfc)

Return an Iterator 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 Iterator.

verticesByPropertyKey

public abstract java.util.Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> verticesByPropertyKey(java.lang.String[] keys,
                                                                                                        VertexFilterCallback vfc,
                                                                                                        OraclePropertyGraphBase.OptimizationFlag flag)

Return an Iterator 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 Iterator.

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