oracle.pgx.api

Class GraphBuilderImpl<VID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.GraphBuilderImpl<VID>

Type Parameters:

VID - the vertex ID type

All Implemented Interfaces:

GraphBuilder<VID>

Direct Known Subclasses:

EdgeBuilderImpl, GraphChangeSetImpl, VertexBuilderImpl

public class GraphBuilderImpl<VID>
extends oracle.pgx.api.internal.ApiObject
implements GraphBuilder<VID>

A graph builder for constructing a PgxGraph.

Method Summary

Modifier and Type	Method and Description
EdgeBuilder<VID>	addEdge(long edgeId, VertexBuilder<VID> srcVertex, VertexBuilder<VID> dstVertex) Adds an edge with the given edge ID and the given source and destination vertices.
EdgeBuilder<VID>	addEdge(long edgeId, VID srcVertex, VID dstVertex) Adds an edge with the given edge ID and the given source and destination vertices.
VertexBuilder<VID>	addVertex(VID vertexId) Adds the vertex with the given id to the graph builder.
PgxGraph	build() Blocking version of GraphBuilder.buildAsync().
PgxGraph	build(java.lang.String newGraphName) Blocking version of GraphBuilder.buildAsync(String).
PgxFuture<PgxGraph>	buildAsync() Shortcut for GraphBuilder.buildAsync(String) without a name
PgxFuture<PgxGraph>	buildAsync(java.lang.String newGraphName) Builds a new graph out of the changes in this graph builder
java.lang.Object	getConfigParameter(GraphBuilderConfig.Field parameter) Retrieve the value for the given config parameter
PgxSession	getSession() Gets the session.
GraphBuilder<VID>	resetEdge(long edgeId) Resets any change for the edge with the given ID.
GraphBuilder<VID>	resetVertex(VertexBuilder<VID> vertex) Resets any change for the given vertex.
GraphBuilder<VID>	resetVertex(VID vertexId) Resets any change for the vertex with the given ID.
void	setConfigParameter(GraphBuilderConfig.Field parameter, java.lang.Object value) Set the given configuration parameter to the given value
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pgx.api.GraphBuilder

setRetainEdgeIds, setRetainIds, setRetainVertexIds

Method Detail

addEdge

public EdgeBuilder<VID> addEdge(long edgeId,
                                VertexBuilder<VID> srcVertex,
                                VertexBuilder<VID> dstVertex)

Description copied from interface: GraphBuilder

Adds an edge with the given edge ID and the given source and destination vertices. Throws an exception if an edge with the same ID already exists.

Specified by:

addEdge in interface GraphBuilder<VID>

Parameters:

edgeId - the ID of the new edge

srcVertex - a VertexBuilderImpl instance representing the source vertex

dstVertex - a VertexBuilderImpl instance representing the destination vertex

Returns:

an edge builder instance

See Also:

VertexBuilderImpl

addEdge

public EdgeBuilder<VID> addEdge(long edgeId,
                                VID srcVertex,
                                VID dstVertex)

Description copied from interface: GraphBuilder

Adds an edge with the given edge ID and the given source and destination vertices. Throws an exception if an edge with the same ID already exists. Vertices that don't yet exist in the graph are added on the fly.

Specified by:

addEdge in interface GraphBuilder<VID>

Parameters:

edgeId - the ID of the new edge

srcVertex - the source ID of the new edge

dstVertex - the destination ID of the new edge

Returns:

an edge builder instance

addVertex

public VertexBuilder<VID> addVertex(VID vertexId)

Description copied from interface: GraphBuilder

Adds the vertex with the given id to the graph builder. Throws an exception if a vertex with the given id already exists.

Specified by:

addVertex in interface GraphBuilder<VID>

Parameters:

vertexId - the ID of the new vertex

Returns:

this graph builder

build

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

Description copied from interface: GraphBuilder

Blocking version of GraphBuilder.buildAsync(). Calls GraphBuilder.buildAsync() and waits for the returned PgxFuture to complete.

Specified by:

build in interface GraphBuilder<VID>

Throws:

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

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

build

public final PgxGraph build(java.lang.String newGraphName)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Description copied from interface: GraphBuilder

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

Specified by:

build in interface GraphBuilder<VID>

Throws:

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

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

buildAsync

public final PgxFuture<PgxGraph> buildAsync()

Description copied from interface: GraphBuilder

Shortcut for GraphBuilder.buildAsync(String) without a name

Specified by:

buildAsync in interface GraphBuilder<VID>

Returns:

a new graph

buildAsync

public final PgxFuture<PgxGraph> buildAsync(java.lang.String newGraphName)

Description copied from interface: GraphBuilder

Builds a new graph out of the changes in this graph builder

Specified by:

buildAsync in interface GraphBuilder<VID>

Parameters:

newGraphName - the new name of the graph. If null a name is generated

Returns:

a new graph

getConfigParameter

public java.lang.Object getConfigParameter(GraphBuilderConfig.Field parameter)

Description copied from interface: GraphBuilder

Retrieve the value for the given config parameter

Specified by:

getConfigParameter in interface GraphBuilder<VID>

Parameters:

parameter - the config parameter to get the value for

Returns:

the value for the given config parameter

getSession

public final PgxSession getSession()

Gets the session.

Returns:

the session this graph builder belongs to

resetEdge

public GraphBuilder<VID> resetEdge(long edgeId)

Description copied from interface: GraphBuilder

Resets any change for the edge with the given ID. Does nothing if no change for the given edge ID exists.

Specified by:

resetEdge in interface GraphBuilder<VID>

Parameters:

edgeId - the ID of the edge which should be reset

Returns:

this graph builder

resetVertex

public GraphBuilder<VID> resetVertex(VertexBuilder<VID> vertex)

Description copied from interface: GraphBuilder

Resets any change for the given vertex.

Specified by:

resetVertex in interface GraphBuilder<VID>

Parameters:

vertex - a VertexBuilder

Returns:

this graph builder

resetVertex

public GraphBuilder<VID> resetVertex(VID vertexId)

Description copied from interface: GraphBuilder

Resets any change for the vertex with the given ID. Does nothing if no change for the given vertex ID exists.

Specified by:

resetVertex in interface GraphBuilder<VID>

Parameters:

vertexId - the ID of the vertex which should be reset

Returns:

this graph builder

setConfigParameter

public void setConfigParameter(GraphBuilderConfig.Field parameter,
                               java.lang.Object value)

Description copied from interface: GraphBuilder

Set the given configuration parameter to the given value

Specified by:

setConfigParameter in interface GraphBuilder<VID>

Parameters:

parameter - the config parameter to set

value - the new value for the config parameter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object