oracle.pgx.api

Interface GraphBuilder<VID>

All Known Subinterfaces:

EdgeBuilder<VID>, EdgeModifier<VID>, GraphChangeSet<VID>, VertexBuilder<VID>, VertexModifier<VID>

All Known Implementing Classes:

EdgeBuilderImpl, EdgeModifierImpl, GraphBuilderImpl, GraphChangeSetImpl, VertexBuilderImpl, VertexModifierImpl

public interface GraphBuilder<VID>

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 buildAsync().
PgxGraph	build(java.lang.String newGraphName) Blocking version of buildAsync(String).
PgxFuture<PgxGraph>	buildAsync() Shortcut for 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
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
default GraphBuilder<VID>	setRetainEdgeIds(boolean retainEdgeIds) Controls whether the edge ids provided in this graph builder are to be retained in the final graph.
default GraphBuilder<VID>	setRetainIds(boolean retainIds) Controls for both vertex and edge ids whether to retain them in the final graph.
default GraphBuilder<VID>	setRetainVertexIds(boolean retainVertexIds) Controls whether to retain the vertex ids provided in this graph builder are to be retained in the final graph.

Method Detail

addEdge

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. Throws an exception if an edge with the same ID already exists.

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

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

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.

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

VertexBuilder<VID> addVertex(VID vertexId)

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

Parameters:

vertexId - the ID of the new vertex

Returns:

this graph builder

build

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

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

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.

build

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

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

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.

buildAsync

PgxFuture<PgxGraph> buildAsync()

Shortcut for buildAsync(String) without a name

Returns:

a new graph

buildAsync

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

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

Parameters:

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

Returns:

a new graph

getConfigParameter

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

Retrieve the value for the given config parameter

Parameters:

parameter - the config parameter to get the value for

Returns:

the value for the given config parameter

Since:

2.4.0

resetEdge

GraphBuilder<VID> resetEdge(long edgeId)

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

Parameters:

edgeId - the ID of the edge which should be reset

Returns:

this graph builder

resetVertex

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

Resets any change for the given vertex.

Parameters:

vertex - a VertexBuilder

Returns:

this graph builder

resetVertex

GraphBuilder<VID> resetVertex(VID vertexId)

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

Parameters:

vertexId - the ID of the vertex which should be reset

Returns:

this graph builder

setConfigParameter

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

Set the given configuration parameter to the given value

Parameters:

parameter - the config parameter to set

value - the new value for the config parameter

Since:

2.4.0

setRetainEdgeIds

default GraphBuilder<VID> setRetainEdgeIds(boolean retainEdgeIds)

Controls whether the edge ids provided in this graph builder are to be retained in the final graph. If true retain the edge ids, if false use internally generated edge ids.

Parameters:

retainEdgeIds - whether or not to retain edge ids

Returns:

this graph builder

Since:

2.4.0

setRetainIds

default GraphBuilder<VID> setRetainIds(boolean retainIds)

Controls for both vertex and edge ids whether to retain them in the final graph.

Parameters:

retainIds - whether or not to retain vertex and edge ids

Returns:

this graph builder

Since:

2.4.0

See Also:

setRetainEdgeIds(boolean), setRetainVertexIds(boolean)

setRetainVertexIds

default GraphBuilder<VID> setRetainVertexIds(boolean retainVertexIds)

Controls whether to retain the vertex ids provided in this graph builder are to be retained in the final graph. If true retain the vertex ids, if false use internally generated vertex ids of type Integer

Parameters:

retainVertexIds - whether or not to retain vertex ids

Returns:

this graph builder

Since:

2.4.0