oracle.pgx.api

Class GraphChangeSetImpl<VID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.GraphBuilderImpl<VID>

oracle.pgx.api.GraphChangeSetImpl<VID>

All Implemented Interfaces:

GraphBuilder<VID>, GraphChangeSet<VID>

Direct Known Subclasses:

EdgeModifierImpl, VertexModifierImpl

public class GraphChangeSetImpl<VID>
extends GraphBuilderImpl<VID>
implements GraphChangeSet<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(VertexBuilder<VID> srcVertex, VertexBuilder<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.
PgxFuture<PgxGraph>	buildNewSnapshotAsync() Builds a new snapshot of the graph out of this GraphChangeSet: the resulting PgxGraph is a new snapshot of the PgxGraph object this was created from.
GraphChangeSet<VID>	removeEdge(long edgeId) Removes an edge from the graph.
GraphChangeSet<VID>	removeVertex(VID vertexId) Removes a vertex from the graph.
GraphChangeSet<VID>	resetEdge(long edgeId) Resets any change for the edge with the given ID.
GraphChangeSet<VID>	resetVertex(VertexBuilder<VID> vertex) Resets any change for the given vertex.
GraphChangeSet<VID>	resetVertex(VID vertexId) Resets any change for the vertex with the given ID.
GraphChangeSet<VID>	setAddExistingEdgePolicy(OnAddExistingElement addExistingEdgePolicy) Sets the policy on what to do when an edge is added that already exists
GraphChangeSet<VID>	setAddExistingVertexPolicy(OnAddExistingElement addExistingVertexPolicy) Sets the policy on what to do when a vertex is added that already exists
GraphChangeSet<VID>	setInvalidChangePolicy(OnInvalidChange invalidChangePolicy) Sets the policy on what to do when an invalid action is added
GraphChangeSet<VID>	setRequiredConversionPolicy(OnRequiredConversion requiredConversionPolicy) Sets the policy on what to do when an invalid type is encountered
java.lang.String	toString()
EdgeModifier<VID>	updateEdge(long edgeId) Returns a EdgeModifier with which you can update edge properties and the edge label.
VertexModifier<VID>	updateVertex(VID vertexId) Returns a VertexModifier with which you can update vertex properties.

Methods inherited from class oracle.pgx.api.GraphBuilderImpl

addEdge, addEdge, addVertex, build, build, buildAsync, buildAsync, getConfigParameter, getSession, setConfigParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pgx.api.GraphChangeSet

addEdge, addVertex, buildNewSnapshot, setRetainEdgeIds, setRetainIds, setRetainVertexIds

Methods inherited from interface oracle.pgx.api.GraphBuilder

addEdge, build, build, buildAsync, buildAsync, getConfigParameter, setConfigParameter

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

Specified by:

addEdge in interface GraphChangeSet<VID>

Overrides:

addEdge in class GraphBuilderImpl<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>

Overrides:

addEdge in class GraphBuilderImpl<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

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>

Specified by:

addVertex in interface GraphChangeSet<VID>

Overrides:

addVertex in class GraphBuilderImpl<VID>

Returns:

a vertex builder instance

buildNewSnapshotAsync

public final PgxFuture<PgxGraph> buildNewSnapshotAsync()

Description copied from interface: GraphChangeSet

Builds a new snapshot of the graph out of this GraphChangeSet: the resulting PgxGraph is a new snapshot of the PgxGraph object this was created from.

Specified by:

buildNewSnapshotAsync in interface GraphChangeSet<VID>

Returns:

the PgxFuture to retrieve a new PgxGraph object with the same name of the original graph and the changes added into this; the new PgxGraph is a new snapshot of the original graph

removeEdge

public GraphChangeSet<VID> removeEdge(long edgeId)

Description copied from interface: GraphChangeSet

Removes an edge from the graph. If the graph doesn't have an edge with the given ID, an exception will be thrown once the graph is built.

Specified by:

removeEdge in interface GraphChangeSet<VID>

Parameters:

edgeId - the ID of the edge to be removed

Returns:

this graph change set

removeVertex

public GraphChangeSet<VID> removeVertex(VID vertexId)

Description copied from interface: GraphChangeSet

Removes a vertex from the graph. If the graph doesn't have a vertex with the given ID, an exception will be thrown once the graph is built.

Specified by:

removeVertex in interface GraphChangeSet<VID>

Parameters:

vertexId - the ID of the vertex to be removed

Returns:

this graph change set

resetEdge

public GraphChangeSet<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>

Specified by:

resetEdge in interface GraphChangeSet<VID>

Overrides:

resetEdge in class GraphBuilderImpl<VID>

Parameters:

edgeId - the ID of the edge which should be reset

Returns:

this graph builder

resetVertex

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

Description copied from interface: GraphBuilder

Resets any change for the given vertex.

Specified by:

resetVertex in interface GraphBuilder<VID>

Specified by:

resetVertex in interface GraphChangeSet<VID>

Overrides:

resetVertex in class GraphBuilderImpl<VID>

Parameters:

vertex - a VertexBuilder

Returns:

this graph builder

resetVertex

public GraphChangeSet<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>

Specified by:

resetVertex in interface GraphChangeSet<VID>

Overrides:

resetVertex in class GraphBuilderImpl<VID>

Parameters:

vertexId - the ID of the vertex which should be reset

Returns:

this graph builder

setAddExistingEdgePolicy

public GraphChangeSet<VID> setAddExistingEdgePolicy(OnAddExistingElement addExistingEdgePolicy)

Description copied from interface: GraphChangeSet

Sets the policy on what to do when an edge is added that already exists

Specified by:

setAddExistingEdgePolicy in interface GraphChangeSet<VID>

Parameters:

addExistingEdgePolicy - the new policy

Returns:

this graph builder

setAddExistingVertexPolicy

public GraphChangeSet<VID> setAddExistingVertexPolicy(OnAddExistingElement addExistingVertexPolicy)

Description copied from interface: GraphChangeSet

Sets the policy on what to do when a vertex is added that already exists

Specified by:

setAddExistingVertexPolicy in interface GraphChangeSet<VID>

Parameters:

addExistingVertexPolicy - the new policy

Returns:

this graph builder

setInvalidChangePolicy

public GraphChangeSet<VID> setInvalidChangePolicy(OnInvalidChange invalidChangePolicy)

Description copied from interface: GraphChangeSet

Sets the policy on what to do when an invalid action is added

Specified by:

setInvalidChangePolicy in interface GraphChangeSet<VID>

Returns:

this graph builder

setRequiredConversionPolicy

public GraphChangeSet<VID> setRequiredConversionPolicy(OnRequiredConversion requiredConversionPolicy)

Description copied from interface: GraphChangeSet

Sets the policy on what to do when an invalid type is encountered

Specified by:

setRequiredConversionPolicy in interface GraphChangeSet<VID>

Returns:

this graph builder

toString

public java.lang.String toString()

Overrides:

toString in class GraphBuilderImpl<VID>

updateEdge

public EdgeModifier<VID> updateEdge(long edgeId)

Description copied from interface: GraphChangeSet

Returns a EdgeModifier with which you can update edge properties and the edge label.

Specified by:

updateEdge in interface GraphChangeSet<VID>

Parameters:

edgeId - the ID of the edge that should be updated

Returns:

an VertexModifier instance

updateVertex

public VertexModifier<VID> updateVertex(VID vertexId)

Description copied from interface: GraphChangeSet

Returns a VertexModifier with which you can update vertex properties. Throws an exception if the vertex has been removed with this graph change set before.

Specified by:

updateVertex in interface GraphChangeSet<VID>

Parameters:

vertexId - the ID of the vertex that should be updated

Returns:

a VertexModifier instance