oracle.pgx.api

Interface GraphChangeSet<VID>

All Superinterfaces:

GraphBuilder<VID>

All Known Subinterfaces:

EdgeModifier<VID>, VertexModifier<VID>

All Known Implementing Classes:

EdgeModifierImpl, GraphChangeSetImpl, VertexModifierImpl

public interface GraphChangeSet<VID>
extends GraphBuilder<VID>

Method Summary

Modifier and Type	Method and Description
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
default GraphChangeSet<VID>	setRetainEdgeIds(boolean retainEdgeIds) Controls whether the edge ids provided in this graph builder are to be retained in the final graph.
default GraphChangeSet<VID>	setRetainIds(boolean retainIds) Controls for both vertex and edge ids whether to retain them in the final graph.
default GraphChangeSet<VID>	setRetainVertexIds(boolean retainVertexIds) Controls whether to retain the vertex ids provided in this graph builder are to be retained in the final graph.
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 interface oracle.pgx.api.GraphBuilder

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

Method Detail

removeEdge

GraphChangeSet<VID> removeEdge(long edgeId)

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.

Parameters:

edgeId - the ID of the edge to be removed

Returns:

this graph change set

removeVertex

GraphChangeSet<VID> removeVertex(VID vertexId)

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.

Parameters:

vertexId - the ID of the vertex to be removed

Returns:

this graph change set

resetEdge

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>

Parameters:

edgeId - the ID of the edge which should be reset

Returns:

this graph builder

resetVertex

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>

Parameters:

vertex - a VertexBuilder

Returns:

this graph builder

resetVertex

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>

Parameters:

vertexId - the ID of the vertex which should be reset

Returns:

this graph builder

setAddExistingEdgePolicy

GraphChangeSet<VID> setAddExistingEdgePolicy(OnAddExistingElement addExistingEdgePolicy)

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

Parameters:

addExistingEdgePolicy - the new policy

Returns:

this graph builder

setAddExistingVertexPolicy

GraphChangeSet<VID> setAddExistingVertexPolicy(OnAddExistingElement addExistingVertexPolicy)

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

Parameters:

addExistingVertexPolicy - the new policy

Returns:

this graph builder

setRetainEdgeIds

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

setRetainIds

default GraphChangeSet<VID> setRetainIds(boolean retainIds)

Description copied from interface: GraphBuilder

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

Specified by:

setRetainIds in interface GraphBuilder<VID>

Parameters:

retainIds - whether or not to retain vertex and edge ids

Returns:

this graph builder

See Also:

GraphBuilder.setRetainEdgeIds(boolean), GraphBuilder.setRetainVertexIds(boolean)

setRetainVertexIds

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

updateEdge

EdgeModifier<VID> updateEdge(long edgeId)

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

Parameters:

edgeId - the ID of the edge that should be updated

Returns:

an VertexModifier instance

updateVertex

VertexModifier<VID> updateVertex(VID vertexId)

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.

Parameters:

vertexId - the ID of the vertex that should be updated

Returns:

a VertexModifier instance