com.mware.core.model.graph

Class GraphUpdateContext

java.lang.Object

com.mware.core.model.graph.GraphUpdateContext

All Implemented Interfaces:

AutoCloseable

public abstract class GraphUpdateContext
extends Object
implements AutoCloseable

Helper class to create or update graph Elements.

Example

 
 try (GraphUpdateContext ctx = graphRepository.beginGraphUpdate(Priority.NORMAL, user, authorizations)) {
   ElementMutation<Vertex> m = graph.prepareVertex("v1", visibility);
   ctx.update(m, updateContext -> {
     BcProperties.FILE_NAME.updateProperty(updateContext, "key", fileName, metadata, visibility);
   });
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraphUpdateContext.Update<T extends Element>
class	GraphUpdateContext.UpdateFuture<T extends Element>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphUpdateContext(Graph graph, WorkQueueRepository workQueueRepository, WebQueueRepository webQueueRepository, VisibilityTranslator visibilityTranslator, Priority priority, User user, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
void	close() Saves, flushes, and pushes element on work queue.
void	flush() Saves, flushes, and pushes element on work queue.
protected void	flushFutures()
Authorizations	getAuthorizations()
Graph	getGraph()
GraphUpdateContext.UpdateFuture<Edge>	getOrCreateEdgeAndUpdate(String edgeId, String outVertexId, String inVertexId, String label, Long timestamp, Visibility visibility, GraphUpdateContext.Update<Edge> updateFn) Gets a edge by id from the graph.
GraphUpdateContext.UpdateFuture<Edge>	getOrCreateEdgeAndUpdate(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility, GraphUpdateContext.Update<Edge> updateFn) Similar to getOrCreateEdgeAndUpdate(String, String, String, String, Long, Visibility, Update) using the current time as the timestamp.
GraphUpdateContext.UpdateFuture<Vertex>	getOrCreateVertexAndUpdate(String vertexId, Long timestamp, Visibility visibility, String conceptType, GraphUpdateContext.Update<Vertex> updateFn) Gets a vertex by id from the graph.
GraphUpdateContext.UpdateFuture<Vertex>	getOrCreateVertexAndUpdate(String vertexId, Visibility visibility, String conceptType, GraphUpdateContext.Update<Vertex> updateFn) Similar to getOrCreateVertexAndUpdate(String, Long, Visibility, String, Update) using the current time as the timestamp.
Priority	getPriority()
int	getSaveQueueSize()
User	getUser()
boolean	isPushOnQueue()
protected void	saveOutstandingUpdateFutures()
GraphUpdateContext	setPushOnQueue(boolean pushOnQueue) By default updates are added to the work queue.
GraphUpdateContext	setSaveQueueSize(int saveQueueSize) Sets the maximum number of element updates to keep in memory before they are flushed and added to the work queue.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(ElementMutation<T> m, GraphUpdateContext.Update<T> updateFn) Calls the update function, saves the element, and adds any updates to the work queue.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(ElementMutation<T> m, ZonedDateTime modifiedDate, VisibilityJson visibilityJson, GraphUpdateContext.Update<T> updateFn) Similar to update(ElementMutation, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) before calling updateFn.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(ElementMutation<T> m, ZonedDateTime modifiedDate, VisibilityJson visibilityJson, String conceptType, GraphUpdateContext.Update<T> updateFn) Similar to update(ElementMutation, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) and ElementUpdateContext.setConceptType(String) before calling updateFn.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(T element, GraphUpdateContext.Update<T> updateFn) Similar to update(ElementMutation, Update) but prepares the mutation from the element.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(T element, ZonedDateTime modifiedDate, VisibilityJson visibilityJson, GraphUpdateContext.Update<T> updateFn) Similar to update(Element, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) before calling updateFn.
<T extends Element> GraphUpdateContext.UpdateFuture<T>	update(T element, ZonedDateTime modifiedDate, VisibilityJson visibilityJson, String conceptType, GraphUpdateContext.Update<T> updateFn) Similar to update(Element, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) and ElementUpdateContext.setConceptType(String) before calling updateFn.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphUpdateContext

protected GraphUpdateContext(Graph graph,
                             WorkQueueRepository workQueueRepository,
                             WebQueueRepository webQueueRepository,
                             VisibilityTranslator visibilityTranslator,
                             Priority priority,
                             User user,
                             Authorizations authorizations)

Method Detail

close

public void close()

Saves, flushes, and pushes element on work queue.

Specified by:

close in interface AutoCloseable

flush

public void flush()

Saves, flushes, and pushes element on work queue.

flushFutures

protected void flushFutures()

saveOutstandingUpdateFutures

protected void saveOutstandingUpdateFutures()

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(T element,
                                                                     GraphUpdateContext.Update<T> updateFn)

Similar to update(ElementMutation, Update) but prepares the mutation from the element.

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(T element,
                                                                     ZonedDateTime modifiedDate,
                                                                     VisibilityJson visibilityJson,
                                                                     GraphUpdateContext.Update<T> updateFn)

Similar to update(Element, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) before calling updateFn.

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(T element,
                                                                     ZonedDateTime modifiedDate,
                                                                     VisibilityJson visibilityJson,
                                                                     String conceptType,
                                                                     GraphUpdateContext.Update<T> updateFn)

Similar to update(Element, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) and ElementUpdateContext.setConceptType(String) before calling updateFn.

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(ElementMutation<T> m,
                                                                     GraphUpdateContext.Update<T> updateFn)

Calls the update function, saves the element, and adds any updates to the work queue.

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(ElementMutation<T> m,
                                                                     ZonedDateTime modifiedDate,
                                                                     VisibilityJson visibilityJson,
                                                                     GraphUpdateContext.Update<T> updateFn)

Similar to update(ElementMutation, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) before calling updateFn.

update

public <T extends Element> GraphUpdateContext.UpdateFuture<T> update(ElementMutation<T> m,
                                                                     ZonedDateTime modifiedDate,
                                                                     VisibilityJson visibilityJson,
                                                                     String conceptType,
                                                                     GraphUpdateContext.Update<T> updateFn)

Similar to update(ElementMutation, Update) but calls ElementUpdateContext.updateBuiltInProperties(ZonedDateTime, VisibilityJson) and ElementUpdateContext.setConceptType(String) before calling updateFn.

getOrCreateVertexAndUpdate

public GraphUpdateContext.UpdateFuture<Vertex> getOrCreateVertexAndUpdate(String vertexId,
                                                                          Visibility visibility,
                                                                          String conceptType,
                                                                          GraphUpdateContext.Update<Vertex> updateFn)

Similar to getOrCreateVertexAndUpdate(String, Long, Visibility, String, Update) using the current time as the timestamp.

getOrCreateVertexAndUpdate

public GraphUpdateContext.UpdateFuture<Vertex> getOrCreateVertexAndUpdate(String vertexId,
                                                                          Long timestamp,
                                                                          Visibility visibility,
                                                                          String conceptType,
                                                                          GraphUpdateContext.Update<Vertex> updateFn)

Gets a vertex by id from the graph. If the vertex does not exist prepares a new mutation and calls update.

Parameters:

vertexId - The existing vertex id, desired vertex id for new vertices, or null to generate a new id and create a new vertex.

timestamp - The timestamp to assign new vertices or null to use the current time

visibility - The visibility of the new vertex

updateFn - Closure in which all element updates should be made

getOrCreateEdgeAndUpdate

public GraphUpdateContext.UpdateFuture<Edge> getOrCreateEdgeAndUpdate(String edgeId,
                                                                      String outVertexId,
                                                                      String inVertexId,
                                                                      String label,
                                                                      Visibility visibility,
                                                                      GraphUpdateContext.Update<Edge> updateFn)

Similar to getOrCreateEdgeAndUpdate(String, String, String, String, Long, Visibility, Update) using the current time as the timestamp.

getOrCreateEdgeAndUpdate

public GraphUpdateContext.UpdateFuture<Edge> getOrCreateEdgeAndUpdate(String edgeId,
                                                                      String outVertexId,
                                                                      String inVertexId,
                                                                      String label,
                                                                      Long timestamp,
                                                                      Visibility visibility,
                                                                      GraphUpdateContext.Update<Edge> updateFn)

Gets a edge by id from the graph. If the edge does not exist prepares a new mutation and calls update.

Parameters:

edgeId - The existing edge id, desired edge id for new edges, or null to generate a new id and create a new edge.

outVertexId - the out vertex id of newly created edges

inVertexId - the in vertex id of newly created edges

label - the label to assign on newly created edges

timestamp - The timestamp to assign new edges or null to use the current time

visibility - The visibility of the new edge

updateFn - Closure in which all element updates should be made

getPriority

public Priority getPriority()

getUser

public User getUser()

getAuthorizations

public Authorizations getAuthorizations()

getSaveQueueSize

public int getSaveQueueSize()

setSaveQueueSize

public GraphUpdateContext setSaveQueueSize(int saveQueueSize)

Sets the maximum number of element updates to keep in memory before they are flushed and added to the work queue.

isPushOnQueue

public boolean isPushOnQueue()

getGraph

public Graph getGraph()

setPushOnQueue

public GraphUpdateContext setPushOnQueue(boolean pushOnQueue)

By default updates are added to the work queue. If this is false updates will be saved but not added to the work queue.