Package 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	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.
EdgeBuilder<VID>	addEdge(String 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(String edgeId, VID srcVertex, VID dstVertex)	Adds an edge with the given edge ID and the given source and destination vertices.
EdgeBuilder<VID>	addEdge(VertexBuilder<VID> srcVertex, VertexBuilder<VID> dstVertex)	Adds an edge with an implicit ID and the given source and destination vertices.
EdgeBuilder<VID>	addEdge(VID srcVertex, VID dstVertex)	Adds an edge with an implicit ID and the given source and destination vertices.
VertexBuilder<VID>	addVertex()	Adds a vertex with an implicit id to the graph builder.
VertexBuilder<VID>	addVertex(VID vertexId)	Adds the vertex with the given id to the graph builder.
final PgxGraph	build()	Blocking version of GraphBuilder.buildAsync().
final PgxGraph	build(String newGraphName)	Blocking version of GraphBuilder.buildAsync(String).
final PgxFuture<PgxGraph>	buildAsync()	Shortcut for GraphBuilder.buildAsync(String) without a name
final PgxFuture<PgxGraph>	buildAsync(String newGraphName)	Builds a new graph out of the changes in this graph builder
Object	getConfigParameter(GraphBuilderConfig.Field parameter)	Retrieve the value for the given config parameter
final PgxSession	getSession()	Gets the session.
boolean	isGraphBuilderConfigFinalized()
GraphBuilder<VID>	partitionedEdgeIds(boolean partitionedIds)	Specifies if the final graph should use IdStrategy.PARTITIONED_IDS for edges.
GraphBuilder<VID>	partitionedVertexIds(boolean partitionedIds)	Specifies if the final graph should use IdStrategy.PARTITIONED_IDS for vertices.
GraphBuilder<VID>	resetEdge(long edgeId)	Resets any change for the edge with the given ID.
GraphBuilder<VID>	resetEdge(String 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, Object value)	Set the given configuration parameter to the given value
void	setDataSourceVersion(String version)	Sets the version information for the built graph or snapshot
GraphBuilder<VID>	setEdgeIdGenerationStrategy(IdGenerationStrategy edgeIdGenerationStrategy)	Defines the ID generation strategy the GraphBuilder should use for edges.
GraphBuilder<VID>	setRetainEdgeIds(boolean retainEdgeIds)	Controls whether the edge ids provided in this graph builder are to be retained in the final graph.
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.
GraphBuilder<VID>	setVertexIdGenerationStrategy(IdGenerationStrategy vertexIdGenerationStrategy)	Defines the ID generation strategy the GraphBuilder should use for vertices.
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

setRetainIds

Method Details

setDataSourceVersion

public void setDataSourceVersion(String version)

Description copied from interface: GraphBuilder

Sets the version information for the built graph or snapshot

Specified by:

setDataSourceVersion in interface GraphBuilder<VID>

Parameters:

version - the version information

addVertex

public VertexBuilder<VID> addVertex(VID vertexId)

Description copied from interface: GraphBuilder

Adds the vertex with the given id to the graph builder. If the vertex doesn't exist it is added, if it exists a builder for that vertex is returned Throws an UnsupportedOperationException if vertex Id generation strategy is set to IdGenerationStrategy.AUTO_GENERATED

Specified by:

addVertex in interface GraphBuilder<VID>

Parameters:

vertexId - the ID of the new vertex

Returns:

a vertex builder instance

addVertex

public VertexBuilder<VID> addVertex()

Description copied from interface: GraphBuilder

Adds a vertex with an implicit id to the graph builder. A builder for that vertex is returned Throws an UnsupportedOperationException if vertex Id generation strategy is set to IdGenerationStrategy.USER_IDS

Specified by:

addVertex in interface GraphBuilder<VID>

Returns:

a vertex builder instance

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

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

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

resetEdge

public GraphBuilder<VID> resetEdge(String 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

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. If the edge doesn't exist it is added, if it exists a builder for that edge is returned Vertices that don't yet exist in the graph are added on the fly. Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.AUTO_GENERATED

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

addEdge

public EdgeBuilder<VID> addEdge(String 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. If the edge doesn't exist it is added, if it exists a builder for that edge is returned Vertices that don't yet exist in the graph are added on the fly. Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.AUTO_GENERATED

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

addEdge

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

Description copied from interface: GraphBuilder

Adds an edge with an implicit ID and the given source and destination vertices. Vertices that don't yet exist in the graph are added on the fly. Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.USER_IDS

Specified by:

addEdge in interface GraphBuilder<VID>

Parameters:

srcVertex - the source ID of the new edge

dstVertex - the destination ID of the new edge

Returns:

an edge builder instance

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. If the edge doesn't exist it is added, if it exists a builder for that edge is returned Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.AUTO_GENERATED

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(String 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. If the edge doesn't exist it is added, if it exists a builder for that edge is returned Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.AUTO_GENERATED

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(VertexBuilder<VID> srcVertex,
 VertexBuilder<VID> dstVertex)

Description copied from interface: GraphBuilder

Adds an edge with an implicit ID and the given source and destination vertices. Throws an UnsupportedOperationException if edge Id generation strategy is set to IdGenerationStrategy.USER_IDS

Specified by:

addEdge in interface GraphBuilder<VID>

Parameters:

srcVertex - a VertexBuilderImpl instance representing the source vertex

dstVertex - a VertexBuilderImpl instance representing the destination vertex

Returns:

an edge builder instance

See Also:

• VertexBuilderImpl

buildAsync

public final PgxFuture<PgxGraph> buildAsync(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

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

setConfigParameter

public void setConfigParameter(GraphBuilderConfig.Field parameter,
 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

getConfigParameter

public 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

setRetainEdgeIds

public GraphBuilder<VID> setRetainEdgeIds(boolean retainEdgeIds)

Description copied from interface: GraphBuilder

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.

Specified by:

setRetainEdgeIds in interface GraphBuilder<VID>

Parameters:

retainEdgeIds - whether or not to retain edge ids

Returns:

this graph builder

setRetainVertexIds

public GraphBuilder<VID> setRetainVertexIds(boolean retainVertexIds)

Description copied from interface: GraphBuilder

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

Specified by:

setRetainVertexIds in interface GraphBuilder<VID>

Parameters:

retainVertexIds - whether or not to retain vertex ids

Returns:

this graph builder

setVertexIdGenerationStrategy

public GraphBuilder<VID> setVertexIdGenerationStrategy(IdGenerationStrategy vertexIdGenerationStrategy)

Description copied from interface: GraphBuilder

Defines the ID generation strategy the GraphBuilder should use for vertices. If IdGenerationStrategy.AUTO_GENERATED vertices IDs are internally generated, if IdGenerationStrategy.USER_IDS vertices IDs are explicitly defined by the user

Specified by:

setVertexIdGenerationStrategy in interface GraphBuilder<VID>

Parameters:

vertexIdGenerationStrategy - Id generation strategy

Returns:

this graph builder

setEdgeIdGenerationStrategy

public GraphBuilder<VID> setEdgeIdGenerationStrategy(IdGenerationStrategy edgeIdGenerationStrategy)

Description copied from interface: GraphBuilder

Defines the ID generation strategy the GraphBuilder should use for edges. If IdGenerationStrategy.AUTO_GENERATED edges IDs are internally generated, if IdGenerationStrategy.USER_IDS edges IDs are explicitly defined by the user

Specified by:

setEdgeIdGenerationStrategy in interface GraphBuilder<VID>

Parameters:

edgeIdGenerationStrategy - Id generation strategy

Returns:

this graph builder

build

public final PgxGraph build(String newGraphName)
                     throws ExecutionException,
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:

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

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

build

public final PgxGraph build()
                     throws ExecutionException,
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:

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

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

partitionedVertexIds

public GraphBuilder<VID> partitionedVertexIds(boolean partitionedIds)

Description copied from interface: GraphBuilder

Specifies if the final graph should use IdStrategy.PARTITIONED_IDS for vertices. Partitioned Ids can be used only in the context of building a partitioned graph, and only if the original Ids are retained, that is, only if the client is configured to build partitioned graphs and GraphBuilder.setRetainVertexIds(boolean) both are set to true

Specified by:

partitionedVertexIds in interface GraphBuilder<VID>

Parameters:

partitionedIds - whether or not to use IdStrategy.PARTITIONED_IDS for vertices in the final graph

Returns:

this graph builder

partitionedEdgeIds

public GraphBuilder<VID> partitionedEdgeIds(boolean partitionedIds)

Description copied from interface: GraphBuilder

Specifies if the final graph should use IdStrategy.PARTITIONED_IDS for edges. Partitioned Ids can be used only in the context of building a partitioned graph, and only if the original Ids are retained, that is, only if the client is configured to build partitioned graphs and GraphBuilder.setRetainEdgeIds(boolean) both are set to true

Specified by:

partitionedEdgeIds in interface GraphBuilder<VID>

Parameters:

partitionedIds - whether or not to use IdStrategy.PARTITIONED_IDS for edges in the final graph

Returns:

this graph builder

isGraphBuilderConfigFinalized

public boolean isGraphBuilderConfigFinalized()

getSession

public final PgxSession getSession()

Gets the session.

Returns:

the session this graph builder belongs to

toString

public String toString()

Overrides:

toString in class Object