com.mware.ge.store

Class AbstractStorableGraph<V extends StorableVertex,E extends StorableEdge>

java.lang.Object

com.mware.ge.GraphBase

com.mware.ge.GraphBaseWithSearchIndex

com.mware.ge.store.AbstractStorableGraph<V,E>

All Implemented Interfaces:

Graph, GraphWithSearchIndex, StorableGraph<V,E>

Direct Known Subclasses:

KVStoreGraph

public abstract class AbstractStorableGraph<V extends StorableVertex,E extends StorableEdge>
extends GraphBaseWithSearchIndex
implements StorableGraph<V,E>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractStorableGraph.AddEdgeToVertexRunnable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheEnabled
protected static String	dataTableName
protected static String	edgesTableName
protected CacheOptions	elementCacheOptions
protected CacheService	elementCacheService
protected ElementMutationBuilder	elementMutationBuilder
protected static String	extendedDataTableName
protected GeSerializer	geSerializer
protected Queue<GraphEvent>	graphEventQueue
protected GraphMetadataStore	graphMetadataStore
protected static String	historyEdgesTableName
protected static String	historyVerticesTableName
protected static String	metadataTableName
protected NameSubstitutionStrategy	nameSubstitutionStrategy
protected StreamingPropertyValueStorageStrategy	streamingPropertyValueStorageStrategy
protected static String	verticesTableName

Fields inherited from class com.mware.ge.GraphBaseWithSearchIndex

METADATA_ID_GENERATOR_CLASSNAME

Fields inherited from class com.mware.ge.GraphBase

flushStackTraceTracker, flushTimer, METADATA_DEFINE_PROPERTY_PREFIX, QUERY_LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStorableGraph(StorableGraphConfiguration config)

Method Summary

Modifier and Type	Method and Description
void	addElementToCache(ElementType elementType, Element element)
protected void	addMutations(Element element, StoreMutation... mutations)
protected abstract void	addMutations(GeObjectType objectType, StoreMutation... mutations)
void	alterConceptType(V vertex, String newConceptType)
void	alterEdgeLabel(E edge, String newEdgeLabel, Authorizations authorizations)
void	alterElementPropertyVisibilities(StorableElement element, List<AlterPropertyVisibility> alterPropertyVisibilities)
void	alterElementVisibility(StorableElement element, Visibility newVisibility, Authorizations authorizations)
void	alterPropertyMetadatas(StorableElement element, List<SetPropertyMetadata> setPropertyMetadatas)
Authorizations	createAuthorizations(String... auths) Creates an authorizations object.
protected StorableEdge	createEdge(EdgeBuilderBase edgeBuilder, long timestamp, FetchHints fetchHints, Authorizations authorizations)
void	deleteEdge(Edge edge, Authorizations authorizations) Permanently deletes an edge from the graph.
void	deleteEdge(String edgeId, Authorizations authorizations) Permanently deletes an edge from the graph.
void	deleteElements(Stream<? extends ElementId> elementIds, Authorizations authorizations) Deletes multiple elements
void	deleteExtendedDataRow(ExtendedDataRowId rowId, Authorizations authorizations) Deletes an extended data row
void	deleteProperty(StorableElement element, Property property, Authorizations authorizations)
void	deleteVertex(String vertexId, Authorizations authorizations) Permanently deletes a vertex from the graph.
void	deleteVertex(Vertex vertex, Authorizations authorizations) Permanently deletes a vertex from the graph.
String	getDataTableName()
static String	getDataTableName(String tableNamePrefix)
Edge	getEdge(String edgeId, FetchHints fetchHints, Long endTime, Authorizations authorizations) Get an edge from the graph.
long	getEdgeCount(Authorizations authorizations) Gets a count of the number of edges in the system.
Iterable<Edge>	getEdges(FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all edges on the graph.
abstract Iterable<Edge>	getEdgesInRange(IdRange range, FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets edges from the graph in the given range.
String	getEdgesTableName()
static String	getEdgesTableName(String tableNamePrefix)
Iterable<ExtendedDataRow>	getExtendedData(Iterable<ExtendedDataRowId> ids, FetchHints fetchHints, Authorizations authorizations) Gets the specified extended data rows.
Iterable<ExtendedDataRow>	getExtendedDataForElements(Iterable<? extends ElementId> elementIdsArg, String tableName, FetchHints fetchHints, Authorizations authorizations) Gets the specified extended data rows.
Iterable<ExtendedDataRow>	getExtendedDataInRange(ElementType elementType, IdRange elementIdRange, Authorizations authorizations) Gets extended data rows from the graph in the given range.
Iterable<ExtendedDataRow>	getExtendedDataInRange(IdRange extendedDataRowKeyRange, Authorizations authorizations)
protected abstract Iterable<ExtendedDataRow>	getExtendedDataRowsInRange(List<IdRange> ranges, FetchHints fetchHints, Authorizations authorizations)
static String	getExtendedDataTableName()
static String	getExtendedDataTableName(String tableNamePrefix)
GeSerializer	getGeSerializer()
protected GraphMetadataStore	getGraphMetadataStore()
String	getHistoryEdgesTableName()
static String	getHistoryEdgesTableName(String tableNamePrefix)
String	getHistoryTableNameFromElementType(ElementType elementType)
String	getHistoryVerticesTableName()
static String	getHistoryVerticesTableName(String tableNamePrefix)
String	getMetadataTableName()
static String	getMetadataTableName(String tableNamePrefix)
NameSubstitutionStrategy	getNameSubstitutionStrategy()
protected abstract long	getRowCountFromTable(String tableName, String signalColumn, Authorizations authorizations)
List<InputStream>	getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues) Opens multiple StreamingPropertyValue input streams at once.
StreamingPropertyValueStorageStrategy	getStreamingPropertyValueStorageStrategy()
String	getTableNameFromElementType(ElementType elementType)
Vertex	getVertex(String vertexId, FetchHints fetchHints, Long endTime, Authorizations authorizations) Get a vertex from the graph.
long	getVertexCount(Authorizations authorizations) Gets a count of the number of vertices in the system.
Iterable<String>	getVertexIds(Authorizations authorizations)
Iterable<Vertex>	getVertices(FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all vertices on the graph.
abstract Iterable<Vertex>	getVerticesInRange(IdRange idRange, FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets vertices from the graph in the given range.
String	getVerticesTableName()
static String	getVerticesTableName(String tableNamePrefix)
Iterable<Vertex>	getVerticesWithPrefix(String vertexIdPrefix, FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets vertices from the graph given the prefix.
void	invalidateElementFromCache(ElementType elementType, String id)
protected boolean	isHistoryInSeparateTable()
boolean	isVisibilityValid(Visibility visibility, Authorizations authorizations) Given an authorization is the visibility object valid.
void	markEdgeHidden(Edge edge, Visibility visibility, Authorizations authorizations) Marks an edge as hidden for a given visibility.
void	markEdgeVisible(Edge edge, Visibility visibility, Authorizations authorizations) Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.
void	markPropertyHidden(StorableElement element, Property property, Long timestamp, Visibility visibility, Authorizations authorizations)
void	markPropertyVisible(StorableElement element, Property property, Long timestamp, Visibility visibility, Authorizations authorizations)
void	markVertexHidden(Vertex vertex, Visibility visibility, Authorizations authorizations) Marks a vertex as hidden for a given visibility.
void	markVertexVisible(Vertex vertex, Visibility visibility, Authorizations authorizations) Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.
StorableEdgeBuilderByVertexId	prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Long timestamp, Visibility visibility) Prepare an edge to be added to the graph.
EdgeBuilder	prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Long timestamp, Visibility visibility) Prepare an edge to be added to the graph.
StorableVertexBuilder	prepareVertex(String vertexId, Long timestamp, Visibility visibility, String conceptType) Prepare a vertex to be added to the graph.
void	saveExtendedDataMutations(Element element, ElementType elementType, IndexHint indexHint, Iterable<ExtendedDataMutation> extendedData, Iterable<ExtendedDataDeleteMutation> extendedDataDeletes, Authorizations authorizations)
void	saveProperties(StorableElement element, Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeletes, Iterable<PropertySoftDeleteMutation> propertySoftDeletes)
void	setGraphMetadataStore(GraphMetadataStore graphMetadataStore)
protected void	setup()
protected void	setupGraphMetadata()
protected void	setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)
void	softDeleteEdge(Edge edge, Long timestamp, Authorizations authorizations) Soft deletes an edge from the graph.
void	softDeleteProperties(Iterable<Property> properties, StorableElement element, Authorizations authorizations)
void	softDeleteProperty(StorableElement element, Property property, Authorizations authorizations)
void	softDeleteVertex(Vertex vertex, Long timestamp, Authorizations authorizations) Soft deletes a vertex from the graph.

Methods inherited from class com.mware.ge.GraphBaseWithSearchIndex

drop, flush, getBackupDir, getBackupTool, getConfiguration, getDefaultFetchHints, getIdGenerator, getRestoreTool, getSearchIndex, getSearchIndexSecurityGranularity, getVertexPropertyCountByValue, isFieldBoostSupported, isQuerySimilarToTextSupported, prepareVertex, query, query, query, query, querySimilarTo, reindex, reindexVertices, saveElementMutations, shutdown, truncate

Methods inherited from class com.mware.ge.GraphBase

addGraphEventListener, addToPropertyDefinitionCache, clearPropertyDefinitionCache, createAuthorizations, deleteAllExtendedDataForElement, dumpGraph, ensurePropertyDefined, filterEdgeIdsByAuthorization, filterVertexIdsByAuthorization, findPaths, findPathsRecursive, findPathsSetIntersection, fireGraphEvent, getAllExtendedData, getMetadata, getMetadata, getMetadataWithPrefix, getMetricsRegistry, getPropertyDefinition, getPropertyDefinitions, getValueType, hasEventListeners, invalidatePropertyDefinition, isPropertyDefined, orderMutations, reloadMetadata, removeGraphEventListener, removeMetadata, removePropertyDefinition, savePropertyDefinition, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mware.ge.store.StorableGraph

getHistoricalPropertyValues

Methods inherited from interface com.mware.ge.GraphWithSearchIndex

flushGraph, getSearchIndex

Methods inherited from interface com.mware.ge.Graph

addEdge, addEdge, addEdge, addEdge, addGraphEventListener, addVertex, addVertex, addVertices, createAuthorizations, createAuthorizations, createAuthorizations, defineProperty, deleteElement, doEdgesExist, doEdgesExist, doesEdgeExist, doesVertexExist, doVerticesExist, drop, dumpGraph, ensurePropertyDefined, filterEdgeIdsByAuthorization, filterVertexIdsByAuthorization, findPaths, findPaths, findPaths, findPaths, findPaths, findRelatedEdgeIds, findRelatedEdgeIds, findRelatedEdgeIdsForVertices, findRelatedEdges, findRelatedEdges, findRelatedEdgeSummary, findRelatedEdgeSummary, findRelatedEdgeSummaryForVertices, flush, getDefaultFetchHints, getEdge, getEdge, getEdges, getEdges, getEdges, getEdges, getEdges, getEdgesInRange, getEdgesInRange, getElement, getElement, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedDataForElements, getExtendedDataForElements, getExtendedDataForElements, getIdGenerator, getMetadata, getMetadata, getMetadataWithPrefix, getMetricsRegistry, getPropertyDefinition, getPropertyDefinitions, getSearchIndexSecurityGranularity, getVertex, getVertex, getVertexPropertyCountByValue, getVertices, getVertices, getVertices, getVertices, getVertices, getVerticesInOrder, getVerticesInOrder, getVerticesInRange, getVerticesInRange, getVerticesWithPrefix, getVerticesWithPrefix, isFieldBoostSupported, isPropertyDefined, isQuerySimilarToTextSupported, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareVertex, prepareVertex, prepareVertex, query, query, query, query, querySimilarTo, reindex, reloadMetadata, removeGraphEventListener, removeMetadata, removePropertyDefinition, saveElementMutations, savePropertyDefinition, setMetadata, shutdown, softDeleteEdge, softDeleteEdge, softDeleteEdge, softDeleteVertex, softDeleteVertex, softDeleteVertex, truncate, visit, visitEdges, visitElements, visitVertices

Field Detail

verticesTableName

protected static String verticesTableName

historyVerticesTableName

protected static String historyVerticesTableName

edgesTableName

protected static String edgesTableName

historyEdgesTableName

protected static String historyEdgesTableName

extendedDataTableName

protected static String extendedDataTableName

dataTableName

protected static String dataTableName

metadataTableName

protected static String metadataTableName

graphEventQueue

protected final Queue<GraphEvent> graphEventQueue

elementMutationBuilder

protected final ElementMutationBuilder elementMutationBuilder

nameSubstitutionStrategy

protected NameSubstitutionStrategy nameSubstitutionStrategy

streamingPropertyValueStorageStrategy

protected final StreamingPropertyValueStorageStrategy streamingPropertyValueStorageStrategy

geSerializer

protected final GeSerializer geSerializer

cacheEnabled

protected final boolean cacheEnabled

graphMetadataStore

protected GraphMetadataStore graphMetadataStore

elementCacheService

protected final CacheService elementCacheService

elementCacheOptions

protected final CacheOptions elementCacheOptions

Constructor Detail

AbstractStorableGraph

protected AbstractStorableGraph(StorableGraphConfiguration config)

Method Detail

setup

protected void setup()

Overrides:

setup in class GraphBaseWithSearchIndex

setupGraphMetadata

protected void setupGraphMetadata()

Overrides:

setupGraphMetadata in class GraphBaseWithSearchIndex

setupGraphMetadata

protected void setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)

Overrides:

setupGraphMetadata in class GraphBaseWithSearchIndex

prepareVertex

public StorableVertexBuilder prepareVertex(String vertexId,
                                           Long timestamp,
                                           Visibility visibility,
                                           String conceptType)

Description copied from interface: Graph

Prepare a vertex to be added to the graph. This method provides a way to build up a vertex with it's properties to be inserted with a single operation.

Specified by:

prepareVertex in interface Graph

Specified by:

prepareVertex in class GraphBaseWithSearchIndex

Parameters:

vertexId - The id to assign the new vertex.

timestamp - The timestamp of the vertex.

visibility - The visibility to assign to the new vertex.

conceptType - The concept to assign the new vertex.

Returns:

The vertex builder.

saveProperties

public void saveProperties(StorableElement element,
                           Iterable<Property> properties,
                           Iterable<PropertyDeleteMutation> propertyDeletes,
                           Iterable<PropertySoftDeleteMutation> propertySoftDeletes)

Specified by:

saveProperties in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

deleteProperty

public void deleteProperty(StorableElement element,
                           Property property,
                           Authorizations authorizations)

Specified by:

deleteProperty in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

softDeleteProperty

public void softDeleteProperty(StorableElement element,
                               Property property,
                               Authorizations authorizations)

Specified by:

softDeleteProperty in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

softDeleteProperties

public void softDeleteProperties(Iterable<Property> properties,
                                 StorableElement element,
                                 Authorizations authorizations)

Specified by:

softDeleteProperties in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

addMutations

protected void addMutations(Element element,
                            StoreMutation... mutations)

addMutations

protected abstract void addMutations(GeObjectType objectType,
                                     StoreMutation... mutations)

getVertices

public Iterable<Vertex> getVertices(FetchHints fetchHints,
                                    Long endTime,
                                    Authorizations authorizations)
                             throws GeException

Description copied from interface: Graph

Gets all vertices on the graph.

Specified by:

getVertices in interface Graph

Specified by:

getVertices in class GraphBaseWithSearchIndex

Parameters:

fetchHints - Hint at what parts of the vertex to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

Throws:

GeException

deleteElements

public void deleteElements(Stream<? extends ElementId> elementIds,
                           Authorizations authorizations)

Description copied from interface: Graph

Deletes multiple elements

Specified by:

deleteElements in interface Graph

Parameters:

elementIds - The element ids to delete

authorizations - The authorizations required to delete the elements

deleteVertex

public void deleteVertex(Vertex vertex,
                         Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes a vertex from the graph.

Specified by:

deleteVertex in interface Graph

Specified by:

deleteVertex in class GraphBaseWithSearchIndex

Parameters:

vertex - The vertex to delete.

authorizations - The authorizations required to delete the vertex.

deleteVertex

public void deleteVertex(String vertexId,
                         Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes a vertex from the graph.

Specified by:

deleteVertex in interface Graph

Parameters:

vertexId - The vertex id to delete.

authorizations - The authorizations required to delete the vertex.

deleteEdge

public void deleteEdge(String edgeId,
                       Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes an edge from the graph. This method requires fetching the edge before deletion.

Specified by:

deleteEdge in interface Graph

Parameters:

edgeId - The edge id of the edge to delete from the graph.

authorizations - The authorizations required to delete the edge.

softDeleteVertex

public void softDeleteVertex(Vertex vertex,
                             Long timestamp,
                             Authorizations authorizations)

Description copied from interface: Graph

Soft deletes a vertex from the graph.

Specified by:

softDeleteVertex in interface Graph

Specified by:

softDeleteVertex in class GraphBaseWithSearchIndex

Parameters:

vertex - The vertex to soft delete.

authorizations - The authorizations required to soft delete the vertex.

markVertexHidden

public void markVertexHidden(Vertex vertex,
                             Visibility visibility,
                             Authorizations authorizations)

Description copied from interface: Graph

Marks a vertex as hidden for a given visibility.

Specified by:

markVertexHidden in interface Graph

Specified by:

markVertexHidden in class GraphBaseWithSearchIndex

Parameters:

vertex - The vertex to mark hidden.

visibility - The visibility string under which this vertex is hidden. This visibility can be a superset of the vertex visibility to mark it as hidden for only a subset of authorizations.

authorizations - The authorizations used.

markVertexVisible

public void markVertexVisible(Vertex vertex,
                              Visibility visibility,
                              Authorizations authorizations)

Description copied from interface: Graph

Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.

Specified by:

markVertexVisible in interface Graph

Specified by:

markVertexVisible in class GraphBaseWithSearchIndex

Parameters:

vertex - The vertex to mark visible.

visibility - The visibility string under which this vertex is now visible.

authorizations - The authorizations used.

getStreamingPropertyValueInputStreams

public List<InputStream> getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues)

Description copied from interface: Graph

Opens multiple StreamingPropertyValue input streams at once. This can have performance benefits by reducing the number of queries to the underlying data source.

Specified by:

getStreamingPropertyValueInputStreams in interface Graph

Parameters:

streamingPropertyValues - list of StreamingPropertyValues to get input streams for

Returns:

InputStreams in the same order as the input list

getExtendedData

public Iterable<ExtendedDataRow> getExtendedData(Iterable<ExtendedDataRowId> ids,
                                                 FetchHints fetchHints,
                                                 Authorizations authorizations)

Description copied from interface: Graph

Gets the specified extended data rows.

Specified by:

getExtendedData in interface Graph

Overrides:

getExtendedData in class GraphBase

Parameters:

ids - The ids of the rows to get.

authorizations - The authorizations used to get the rows

Returns:

Rows

getExtendedDataRowsInRange

protected abstract Iterable<ExtendedDataRow> getExtendedDataRowsInRange(List<IdRange> ranges,
                                                                        FetchHints fetchHints,
                                                                        Authorizations authorizations)

getExtendedDataForElements

public Iterable<ExtendedDataRow> getExtendedDataForElements(Iterable<? extends ElementId> elementIdsArg,
                                                            String tableName,
                                                            FetchHints fetchHints,
                                                            Authorizations authorizations)

Description copied from interface: Graph

Gets the specified extended data rows.

Specified by:

getExtendedDataForElements in interface Graph

Overrides:

getExtendedDataForElements in class GraphBase

Parameters:

elementIdsArg - The element ids of the elements to get the rows from

tableName - The name of the table within the element to get the rows from

fetchHints - Fetch hints to filter extended data

authorizations - The authorizations used to get the rows

Returns:

Rows

getExtendedDataInRange

public Iterable<ExtendedDataRow> getExtendedDataInRange(ElementType elementType,
                                                        IdRange elementIdRange,
                                                        Authorizations authorizations)

Description copied from interface: Graph

Gets extended data rows from the graph in the given range.

Specified by:

getExtendedDataInRange in interface Graph

Overrides:

getExtendedDataInRange in class GraphBase

Parameters:

elementType - The type of element to get the rows from

elementIdRange - The range of element ids to get extended data rows for.

authorizations - The authorizations required to load the vertex.

Returns:

The extended data rows for the element ids in the range.

getExtendedDataInRange

public Iterable<ExtendedDataRow> getExtendedDataInRange(IdRange extendedDataRowKeyRange,
                                                        Authorizations authorizations)

saveExtendedDataMutations

public void saveExtendedDataMutations(Element element,
                                      ElementType elementType,
                                      IndexHint indexHint,
                                      Iterable<ExtendedDataMutation> extendedData,
                                      Iterable<ExtendedDataDeleteMutation> extendedDataDeletes,
                                      Authorizations authorizations)

Specified by:

saveExtendedDataMutations in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

getEdge

public Edge getEdge(String edgeId,
                    FetchHints fetchHints,
                    Long endTime,
                    Authorizations authorizations)

Description copied from interface: Graph

Get an edge from the graph.

Specified by:

getEdge in interface Graph

Parameters:

edgeId - The edge id to retrieve from the graph.

fetchHints - Hint at what parts of the edge to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the edge.

Returns:

The edge if successful. null if the edge is not found or the required authorizations were not provided.

getEdges

public Iterable<Edge> getEdges(FetchHints fetchHints,
                               Long endTime,
                               Authorizations authorizations)

Description copied from interface: Graph

Gets all edges on the graph.

Specified by:

getEdges in interface Graph

Specified by:

getEdges in class GraphBaseWithSearchIndex

Parameters:

fetchHints - Hint at what parts of the edge to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the edge.

Returns:

An iterable of all the edges.

getEdgesInRange

public abstract Iterable<Edge> getEdgesInRange(IdRange range,
                                               FetchHints fetchHints,
                                               Long endTime,
                                               Authorizations authorizations)

Description copied from interface: Graph

Gets edges from the graph in the given range.

Specified by:

getEdgesInRange in interface Graph

Parameters:

range - The range of ids to get.

fetchHints - Hint at what parts of the vertex to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the vertex.

Returns:

The edges in the range.

prepareEdge

public StorableEdgeBuilderByVertexId prepareEdge(String edgeId,
                                                 String outVertexId,
                                                 String inVertexId,
                                                 String label,
                                                 Long timestamp,
                                                 Visibility visibility)

Description copied from interface: Graph

Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.

Specified by:

prepareEdge in interface Graph

Specified by:

prepareEdge in class GraphBaseWithSearchIndex

Parameters:

edgeId - The id to assign the new edge.

outVertexId - The source vertex id. The "out" side of the edge.

inVertexId - The destination vertex id. The "in" side of the edge.

label - The label to assign to the edge. eg knows, works at, etc.

timestamp - The timestamp of the edge.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

prepareEdge

public EdgeBuilder prepareEdge(String edgeId,
                               Vertex outVertex,
                               Vertex inVertex,
                               String label,
                               Long timestamp,
                               Visibility visibility)

Description copied from interface: Graph

Prepare an edge to be added to the graph. This method provides a way to build up an edge with it's properties to be inserted with a single operation.

Specified by:

prepareEdge in interface Graph

Specified by:

prepareEdge in class GraphBaseWithSearchIndex

Parameters:

edgeId - The id to assign the new edge.

outVertex - The source vertex. The "out" side of the edge.

inVertex - The destination vertex. The "in" side of the edge.

label - The label to assign to the edge. eg knows, works at, etc.

timestamp - The timestamp of the edge.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

createEdge

protected StorableEdge createEdge(EdgeBuilderBase edgeBuilder,
                                  long timestamp,
                                  FetchHints fetchHints,
                                  Authorizations authorizations)

deleteExtendedDataRow

public void deleteExtendedDataRow(ExtendedDataRowId rowId,
                                  Authorizations authorizations)

Description copied from interface: Graph

Deletes an extended data row

Specified by:

deleteExtendedDataRow in interface Graph

softDeleteEdge

public void softDeleteEdge(Edge edge,
                           Long timestamp,
                           Authorizations authorizations)

Description copied from interface: Graph

Soft deletes an edge from the graph.

Specified by:

softDeleteEdge in interface Graph

Specified by:

softDeleteEdge in class GraphBaseWithSearchIndex

Parameters:

edge - The edge to soft delete from the graph.

authorizations - The authorizations required to delete the edge.

deleteEdge

public void deleteEdge(Edge edge,
                       Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes an edge from the graph.

Specified by:

deleteEdge in interface Graph

Specified by:

deleteEdge in class GraphBaseWithSearchIndex

Parameters:

edge - The edge to delete from the graph.

authorizations - The authorizations required to delete the edge.

markEdgeHidden

public void markEdgeHidden(Edge edge,
                           Visibility visibility,
                           Authorizations authorizations)

Description copied from interface: Graph

Marks an edge as hidden for a given visibility.

Specified by:

markEdgeHidden in interface Graph

Specified by:

markEdgeHidden in class GraphBaseWithSearchIndex

Parameters:

edge - The edge to mark hidden.

visibility - The visibility string under which this edge is hidden. This visibility can be a superset of the edge visibility to mark it as hidden for only a subset of authorizations.

authorizations - The authorizations used.

markEdgeVisible

public void markEdgeVisible(Edge edge,
                            Visibility visibility,
                            Authorizations authorizations)

Description copied from interface: Graph

Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.

Specified by:

markEdgeVisible in interface Graph

Specified by:

markEdgeVisible in class GraphBaseWithSearchIndex

Parameters:

edge - The edge to mark visible.

visibility - The visibility string under which this edge is now visible.

authorizations - The authorizations used.

createAuthorizations

public Authorizations createAuthorizations(String... auths)

Description copied from interface: Graph

Creates an authorizations object.

Specified by:

createAuthorizations in interface Graph

Specified by:

createAuthorizations in class GraphBaseWithSearchIndex

Parameters:

auths - The authorizations granted.

Returns:

A new authorizations object

getVertex

public Vertex getVertex(String vertexId,
                        FetchHints fetchHints,
                        Long endTime,
                        Authorizations authorizations)
                 throws GeException

Description copied from interface: Graph

Get a vertex from the graph.

Specified by:

getVertex in interface Graph

Parameters:

vertexId - The vertex id to retrieve from the graph.

fetchHints - Hint at what parts of the vertex to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the vertex.

Returns:

The vertex if successful. null if the vertex is not found or the required authorizations were not provided.

Throws:

GeException

getVertexIds

public Iterable<String> getVertexIds(Authorizations authorizations)

Specified by:

getVertexIds in interface Graph

getVerticesWithPrefix

public Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix,
                                              FetchHints fetchHints,
                                              Long endTime,
                                              Authorizations authorizations)

Description copied from interface: Graph

Gets vertices from the graph given the prefix.

Specified by:

getVerticesWithPrefix in interface Graph

Parameters:

vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.

fetchHints - Hint at what parts of the vertex to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the vertex.

Returns:

The vertex if successful. null if the vertex is not found or the required authorizations were not provided.

getVerticesInRange

public abstract Iterable<Vertex> getVerticesInRange(IdRange idRange,
                                                    FetchHints fetchHints,
                                                    Long endTime,
                                                    Authorizations authorizations)

Description copied from interface: Graph

Gets vertices from the graph in the given range.

Specified by:

getVerticesInRange in interface Graph

Parameters:

idRange - The range of ids to get.

fetchHints - Hint at what parts of the vertex to fetch.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations required to load the vertex.

Returns:

The vertices in the range.

alterElementVisibility

public void alterElementVisibility(StorableElement element,
                                   Visibility newVisibility,
                                   Authorizations authorizations)

Specified by:

alterElementVisibility in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

alterEdgeLabel

public void alterEdgeLabel(E edge,
                           String newEdgeLabel,
                           Authorizations authorizations)

Specified by:

alterEdgeLabel in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

alterConceptType

public void alterConceptType(V vertex,
                             String newConceptType)

Specified by:

alterConceptType in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

alterElementPropertyVisibilities

public void alterElementPropertyVisibilities(StorableElement element,
                                             List<AlterPropertyVisibility> alterPropertyVisibilities)

Specified by:

alterElementPropertyVisibilities in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

alterPropertyMetadatas

public void alterPropertyMetadatas(StorableElement element,
                                   List<SetPropertyMetadata> setPropertyMetadatas)

Specified by:

alterPropertyMetadatas in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

isVisibilityValid

public boolean isVisibilityValid(Visibility visibility,
                                 Authorizations authorizations)

Description copied from interface: Graph

Given an authorization is the visibility object valid.

Specified by:

isVisibilityValid in interface Graph

Specified by:

isVisibilityValid in class GraphBaseWithSearchIndex

Parameters:

visibility - The visibility you want to check.

authorizations - The given authorizations.

Returns:

true if the visibility is valid given an authorization, else return false.

markPropertyHidden

public void markPropertyHidden(StorableElement element,
                               Property property,
                               Long timestamp,
                               Visibility visibility,
                               Authorizations authorizations)

Specified by:

markPropertyHidden in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

markPropertyVisible

public void markPropertyVisible(StorableElement element,
                                Property property,
                                Long timestamp,
                                Visibility visibility,
                                Authorizations authorizations)

Specified by:

markPropertyVisible in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

getVertexCount

public long getVertexCount(Authorizations authorizations)

Description copied from interface: Graph

Gets a count of the number of vertices in the system.

Specified by:

getVertexCount in interface Graph

getEdgeCount

public long getEdgeCount(Authorizations authorizations)

Description copied from interface: Graph

Gets a count of the number of edges in the system.

Specified by:

getEdgeCount in interface Graph

getRowCountFromTable

protected abstract long getRowCountFromTable(String tableName,
                                             String signalColumn,
                                             Authorizations authorizations)

invalidateElementFromCache

public void invalidateElementFromCache(ElementType elementType,
                                       String id)

Specified by:

invalidateElementFromCache in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>

addElementToCache

public void addElementToCache(ElementType elementType,
                              Element element)

getGraphMetadataStore

protected GraphMetadataStore getGraphMetadataStore()

Specified by:

getGraphMetadataStore in class GraphBaseWithSearchIndex

setGraphMetadataStore

public void setGraphMetadataStore(GraphMetadataStore graphMetadataStore)

getVerticesTableName

public static String getVerticesTableName(String tableNamePrefix)

getHistoryVerticesTableName

public static String getHistoryVerticesTableName(String tableNamePrefix)

getEdgesTableName

public static String getEdgesTableName(String tableNamePrefix)

getHistoryEdgesTableName

public static String getHistoryEdgesTableName(String tableNamePrefix)

getExtendedDataTableName

public static String getExtendedDataTableName(String tableNamePrefix)

getDataTableName

public static String getDataTableName(String tableNamePrefix)

getMetadataTableName

public static String getMetadataTableName(String tableNamePrefix)

getVerticesTableName

public String getVerticesTableName()

getHistoryVerticesTableName

public String getHistoryVerticesTableName()

getEdgesTableName

public String getEdgesTableName()

getHistoryEdgesTableName

public String getHistoryEdgesTableName()

getExtendedDataTableName

public static String getExtendedDataTableName()

getDataTableName

public String getDataTableName()

getMetadataTableName

public String getMetadataTableName()

isHistoryInSeparateTable

protected boolean isHistoryInSeparateTable()

getTableNameFromElementType

public String getTableNameFromElementType(ElementType elementType)

getHistoryTableNameFromElementType

public String getHistoryTableNameFromElementType(ElementType elementType)

getStreamingPropertyValueStorageStrategy

public StreamingPropertyValueStorageStrategy getStreamingPropertyValueStorageStrategy()

getNameSubstitutionStrategy

public NameSubstitutionStrategy getNameSubstitutionStrategy()

Specified by:

getNameSubstitutionStrategy in interface Graph

getGeSerializer

public GeSerializer getGeSerializer()

Specified by:

getGeSerializer in interface StorableGraph<V extends StorableVertex,E extends StorableEdge>