oracle.pgx.api.frames

Class AbstractPgxEntityProviderFromFramesCreator

java.lang.Object

oracle.pgx.api.frames.AbstractPgxEntityProviderFromFramesCreator

Direct Known Subclasses:

PgxEdgeProviderFromFramesCreator, PgxVertexProviderFromFramesCreator

public abstract class AbstractPgxEntityProviderFromFramesCreator
extends java.lang.Object

This class provides the minimum implementation for PgxVertexProviderFromFramesCreator and PgxVertexProviderFromFramesCreator

Constructor Summary

Constructors

Constructor and Description
AbstractPgxEntityProviderFromFramesCreator(SessionContext sessionContext, oracle.pgx.api.internal.Core core, PgxGraphFromFramesCreator graphFromFramesCreator) Create a new entity provider for either vertices or edges

Method Summary

Modifier and Type	Method and Description
PgxGraph	create() Blocking version of createAsync() (String)}.
PgxFuture<PgxGraph>	createAsync() Create a graph from the parameters and providers provided
PgxEdgeProviderFromFramesCreator	edgeProvider(java.lang.String providerName, java.lang.String sourceVertexProvider, java.lang.String destinationVertexProvider, PgxFrame frame) Add a new edge provider to the underlying PgxGraphFromFramesCreator
PgxGraphFromFramesCreator	partitioned(boolean isPartitioned) Set whether the graph should be partitioned or not.
PgxVertexProviderFromFramesCreator	vertexProvider(java.lang.String providerName, PgxFrame frame) Add a new vertex provider to the underlying PgxGraphFromFramesCreator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPgxEntityProviderFromFramesCreator

public AbstractPgxEntityProviderFromFramesCreator(SessionContext sessionContext,
                                                  oracle.pgx.api.internal.Core core,
                                                  PgxGraphFromFramesCreator graphFromFramesCreator)

Create a new entity provider for either vertices or edges

Parameters:

sessionContext - the session context to use

core - the core to use

graphFromFramesCreator - the graph from frames creator used in this entity provider

Method Detail

create

public PgxGraph create()
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException

Blocking version of createAsync() (String)}. Calls createAsync() (String)} and waits for the returned PgxFuture to complete.

Returns:

the newly create graph

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

createAsync

public PgxFuture<PgxGraph> createAsync()

Create a graph from the parameters and providers provided

Returns:

the newly graph created

edgeProvider

public PgxEdgeProviderFromFramesCreator edgeProvider(java.lang.String providerName,
                                                     java.lang.String sourceVertexProvider,
                                                     java.lang.String destinationVertexProvider,
                                                     PgxFrame frame)

Add a new edge provider to the underlying PgxGraphFromFramesCreator

Parameters:

providerName - name of the provider

sourceVertexProvider - name of the source vertex provider

destinationVertexProvider - name of the destination vertex provider

frame - frame to use as provider data source

Returns:

the new edge provider creator

Since:

21.3

partitioned

public PgxGraphFromFramesCreator partitioned(boolean isPartitioned)

Set whether the graph should be partitioned or not.

Parameters:

isPartitioned - whether the graph should be partitioned or not

Returns:

this object

vertexProvider

public PgxVertexProviderFromFramesCreator vertexProvider(java.lang.String providerName,
                                                         PgxFrame frame)

Add a new vertex provider to the underlying PgxGraphFromFramesCreator

Parameters:

providerName - name of the provider

frame - frame to use as provider data source

Returns:

the new vertex provider creator

Since:

21.3