com.mware.ge

Class GraphBaseWithSearchIndex

java.lang.Object

com.mware.ge.GraphBase

com.mware.ge.GraphBaseWithSearchIndex

All Implemented Interfaces:

Graph, GraphWithSearchIndex

Direct Known Subclasses:

AbstractStorableGraph, InMemoryGraph

public abstract class GraphBaseWithSearchIndex
extends GraphBase
implements Graph, GraphWithSearchIndex

Field Summary

Fields

Modifier and Type	Field and Description
static String	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	GraphBaseWithSearchIndex(GraphConfiguration configuration)
protected	GraphBaseWithSearchIndex(GraphConfiguration configuration, IdGenerator idGenerator, SearchIndex searchIndex)

Method Summary

Modifier and Type	Method and Description
abstract Authorizations	createAuthorizations(String... auths) Creates an authorizations object.
abstract void	deleteEdge(Edge edge, Authorizations authorizations) Permanently deletes an edge from the graph.
abstract void	deleteVertex(Vertex vertex, Authorizations authorizations) Permanently deletes a vertex from the graph.
abstract void	drop() Drops all tables.
void	flush() Flushes any pending mutations to the graph.
String	getBackupDir()
GraphBackup	getBackupTool(String outputFile)
GraphConfiguration	getConfiguration()
FetchHints	getDefaultFetchHints() The default fetch hints to use if none are provided
abstract Iterable<Edge>	getEdges(FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all edges on the graph.
protected abstract GraphMetadataStore	getGraphMetadataStore()
IdGenerator	getIdGenerator() Gets the id generator used by this graph to create ids.
GraphRestore	getRestoreTool()
SearchIndex	getSearchIndex()
SearchIndexSecurityGranularity	getSearchIndexSecurityGranularity() Gets the granularity of the search index SearchIndexSecurityGranularity
Map<Object,Long>	getVertexPropertyCountByValue(String propertyName, Authorizations authorizations) Gets the number of times a property with a given value occurs on vertices
abstract Iterable<Vertex>	getVertices(FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all vertices on the graph.
boolean	isFieldBoostSupported() Determine if field boost is support.
boolean	isQuerySimilarToTextSupported() Returns true if this graph supports similar to text queries.
abstract boolean	isVisibilityValid(Visibility visibility, Authorizations authorizations) Given an authorization is the visibility object valid.
abstract void	markEdgeHidden(Edge edge, Visibility visibility, Authorizations authorizations) Marks an edge as hidden for a given visibility.
abstract void	markEdgeVisible(Edge edge, Visibility visibility, Authorizations authorizations) Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.
abstract void	markVertexHidden(Vertex vertex, Visibility visibility, Authorizations authorizations) Marks a vertex as hidden for a given visibility.
abstract void	markVertexVisible(Vertex vertex, Visibility visibility, Authorizations authorizations) Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.
abstract EdgeBuilderByVertexId	prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Long timestamp, Visibility visibility) Prepare an edge to be added to the graph.
abstract EdgeBuilder	prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Long timestamp, Visibility visibility) Prepare an edge to be added to the graph.
VertexBuilder	prepareVertex(Long timestamp, Visibility visibility, String conceptType) Prepare a vertex to be added to the graph.
abstract VertexBuilder	prepareVertex(String vertexId, Long timestamp, Visibility visibility, String conceptType) Prepare a vertex to be added to the graph.
GraphQuery	query(Authorizations authorizations) Creates a query builder object used to query the graph.
MultiVertexQuery	query(String[] vertexIds, Authorizations authorizations) Creates a query builder object used to query a list of vertices.
MultiVertexQuery	query(String[] vertexIds, String queryString, Authorizations authorizations) Creates a query builder object used to query a list of vertices.
GraphQuery	query(String queryString, Authorizations authorizations) Creates a query builder object used to query the graph.
SimilarToGraphQuery	querySimilarTo(String[] fields, String text, Authorizations authorizations) Creates a query builder object that finds all vertices similar to the given text for the specified fields.
void	reindex(Authorizations authorizations) Reindex all vertices and edges.
protected void	reindexVertices(Authorizations authorizations)
Iterable<Element>	saveElementMutations(Iterable<ElementMutation<? extends Element>> mutations, Authorizations authorizations) Saves multiple mutations with a single call.
protected void	setup()
protected void	setupGraphMetadata()
protected void	setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)
void	shutdown() Cleans up or disconnects from the underlying storage.
abstract void	softDeleteEdge(Edge edge, Long timestamp, Authorizations authorizations) Soft deletes an edge from the graph.
abstract void	softDeleteVertex(Vertex vertex, Long timestamp, Authorizations authorizations) Soft deletes a vertex from the graph.
abstract void	truncate() Clears all data from the graph.

Methods inherited from class com.mware.ge.GraphBase

addGraphEventListener, addToPropertyDefinitionCache, clearPropertyDefinitionCache, createAuthorizations, deleteAllExtendedDataForElement, dumpGraph, ensurePropertyDefined, filterEdgeIdsByAuthorization, filterVertexIdsByAuthorization, findPaths, findPathsRecursive, findPathsSetIntersection, fireGraphEvent, getAllExtendedData, getExtendedData, getExtendedDataForElements, getExtendedDataInRange, 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.GraphWithSearchIndex

flushGraph

Methods inherited from interface com.mware.ge.Graph

addEdge, addEdge, addEdge, addEdge, addGraphEventListener, addVertex, addVertex, addVertices, createAuthorizations, createAuthorizations, createAuthorizations, defineProperty, deleteEdge, deleteElement, deleteElements, deleteExtendedDataRow, deleteVertex, doEdgesExist, doEdgesExist, doesEdgeExist, doesVertexExist, doVerticesExist, dumpGraph, ensurePropertyDefined, filterEdgeIdsByAuthorization, filterVertexIdsByAuthorization, findPaths, findPaths, findPaths, findPaths, findPaths, findRelatedEdgeIds, findRelatedEdgeIds, findRelatedEdgeIdsForVertices, findRelatedEdges, findRelatedEdges, findRelatedEdgeSummary, findRelatedEdgeSummary, findRelatedEdgeSummaryForVertices, getEdge, getEdge, getEdge, getEdgeCount, getEdges, getEdges, getEdges, getEdges, getEdges, getEdgesInRange, getEdgesInRange, getEdgesInRange, getElement, getElement, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedDataForElements, getExtendedDataForElements, getExtendedDataForElements, getExtendedDataForElements, getExtendedDataInRange, getMetadata, getMetadata, getMetadataWithPrefix, getMetricsRegistry, getNameSubstitutionStrategy, getPropertyDefinition, getPropertyDefinitions, getStreamingPropertyValueInputStreams, getVertex, getVertex, getVertex, getVertexCount, getVertexIds, getVertices, getVertices, getVertices, getVertices, getVertices, getVerticesInOrder, getVerticesInOrder, getVerticesInRange, getVerticesInRange, getVerticesInRange, getVerticesWithPrefix, getVerticesWithPrefix, getVerticesWithPrefix, isPropertyDefined, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareVertex, prepareVertex, reloadMetadata, removeGraphEventListener, removeMetadata, removePropertyDefinition, savePropertyDefinition, setMetadata, softDeleteEdge, softDeleteEdge, softDeleteEdge, softDeleteVertex, softDeleteVertex, softDeleteVertex, visit, visitEdges, visitElements, visitVertices

Field Detail

METADATA_ID_GENERATOR_CLASSNAME

public static final String METADATA_ID_GENERATOR_CLASSNAME

See Also:

Constant Field Values

Constructor Detail

GraphBaseWithSearchIndex

protected GraphBaseWithSearchIndex(GraphConfiguration configuration)

GraphBaseWithSearchIndex

protected GraphBaseWithSearchIndex(GraphConfiguration configuration,
                                   IdGenerator idGenerator,
                                   SearchIndex searchIndex)

Method Detail

setup

protected void setup()

setupGraphMetadata

protected void setupGraphMetadata()

setupGraphMetadata

protected void setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)

query

public GraphQuery query(Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query the graph.

Specified by:

query in interface Graph

Specified by:

query in class GraphBase

Parameters:

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

query

public GraphQuery query(String queryString,
                        Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query the graph.

Specified by:

query in interface Graph

Specified by:

query in class GraphBase

Parameters:

queryString - The string to search for in the text of an element. This will search all fields for the given text.

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

query

public MultiVertexQuery query(String[] vertexIds,
                              String queryString,
                              Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query a list of vertices.

Specified by:

query in interface Graph

Parameters:

vertexIds - The vertex ids to query.

queryString - The string to search for in the text of an element. This will search all fields for the given text.

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

query

public MultiVertexQuery query(String[] vertexIds,
                              Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query a list of vertices.

Specified by:

query in interface Graph

Parameters:

vertexIds - The vertex ids to query.

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

isQuerySimilarToTextSupported

public boolean isQuerySimilarToTextSupported()

Description copied from interface: Graph

Returns true if this graph supports similar to text queries.

Specified by:

isQuerySimilarToTextSupported in interface Graph

Overrides:

isQuerySimilarToTextSupported in class GraphBase

querySimilarTo

public SimilarToGraphQuery querySimilarTo(String[] fields,
                                          String text,
                                          Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object that finds all vertices similar to the given text for the specified fields. This could be implemented similar to the ElasticSearch more like this query.

Specified by:

querySimilarTo in interface Graph

Overrides:

querySimilarTo in class GraphBase

Parameters:

fields - The fields to match against.

text - The text to find similar to.

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

getIdGenerator

public IdGenerator getIdGenerator()

Description copied from interface: Graph

Gets the id generator used by this graph to create ids.

Specified by:

getIdGenerator in interface Graph

Returns:

the id generator.

getConfiguration

public GraphConfiguration getConfiguration()

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface GraphWithSearchIndex

reindex

public void reindex(Authorizations authorizations)

Description copied from interface: Graph

Reindex all vertices and edges.

Specified by:

reindex in interface Graph

Specified by:

reindex in class GraphBase

Parameters:

authorizations - authorizations used to query for the data to reindex.

reindexVertices

protected void reindexVertices(Authorizations authorizations)

flush

public void flush()

Description copied from interface: Graph

Flushes any pending mutations to the graph.

Specified by:

flush in interface Graph

Specified by:

flush in class GraphBase

shutdown

public void shutdown()

Description copied from interface: Graph

Cleans up or disconnects from the underlying storage.

Specified by:

shutdown in interface Graph

Specified by:

shutdown in class GraphBase

drop

public abstract void drop()

Description copied from interface: Graph

Drops all tables. The graph needs to be reinitialized after this operation.

Specified by:

drop in interface Graph

Specified by:

drop in class GraphBase

isFieldBoostSupported

public boolean isFieldBoostSupported()

Description copied from interface: Graph

Determine if field boost is support. That is can you change the boost at a field level to give higher priority.

Specified by:

isFieldBoostSupported in interface Graph

Specified by:

isFieldBoostSupported in class GraphBase

getSearchIndexSecurityGranularity

public SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()

Description copied from interface: Graph

Gets the granularity of the search index SearchIndexSecurityGranularity

Specified by:

getSearchIndexSecurityGranularity in interface Graph

Specified by:

getSearchIndexSecurityGranularity in class GraphBase

getVertexPropertyCountByValue

public Map<Object,Long> getVertexPropertyCountByValue(String propertyName,
                                                      Authorizations authorizations)

Description copied from interface: Graph

Gets the number of times a property with a given value occurs on vertices

Specified by:

getVertexPropertyCountByValue in interface Graph

Parameters:

propertyName - The name of the property to find

authorizations - The authorizations to use to find the property

Returns:

The results

saveElementMutations

public Iterable<Element> saveElementMutations(Iterable<ElementMutation<? extends Element>> mutations,
                                              Authorizations authorizations)

Description copied from interface: Graph

Saves multiple mutations with a single call.

Specified by:

saveElementMutations in interface Graph

Overrides:

saveElementMutations in class GraphBase

Parameters:

mutations - the mutations to save

authorizations - the authorizations used during save

Returns:

the elements which were saved

prepareVertex

public abstract VertexBuilder 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

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.

getVertices

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

Description copied from interface: Graph

Gets all vertices on the graph.

Specified by:

getVertices in interface Graph

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.

prepareEdge

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

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.

prepareVertex

public VertexBuilder prepareVertex(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. The id of the new vertex will be generated using an IdGenerator.

Specified by:

prepareVertex in interface Graph

Parameters:

timestamp - The timestamp of the vertex. null, to use the system generated time.

visibility - The visibility to assign to the new vertex.

Returns:

The vertex builder.

prepareEdge

public abstract EdgeBuilderByVertexId 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

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.

softDeleteVertex

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

Parameters:

vertex - The vertex to soft delete.

authorizations - The authorizations required to soft delete the vertex.

softDeleteEdge

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

Parameters:

edge - The edge to soft delete from the graph.

authorizations - The authorizations required to delete the edge.

getEdges

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

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.

getGraphMetadataStore

protected abstract GraphMetadataStore getGraphMetadataStore()

Specified by:

getGraphMetadataStore in class GraphBase

deleteVertex

public abstract void deleteVertex(Vertex vertex,
                                  Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes a vertex from the graph.

Specified by:

deleteVertex in interface Graph

Parameters:

vertex - The vertex to delete.

authorizations - The authorizations required to delete the vertex.

deleteEdge

public abstract void deleteEdge(Edge edge,
                                Authorizations authorizations)

Description copied from interface: Graph

Permanently deletes an edge from the graph.

Specified by:

deleteEdge in interface Graph

Parameters:

edge - The edge to delete from the graph.

authorizations - The authorizations required to delete the edge.

isVisibilityValid

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

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.

truncate

public abstract void truncate()

Description copied from interface: Graph

Clears all data from the graph.

Specified by:

truncate in interface Graph

markVertexHidden

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

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

Parameters:

vertex - The vertex to mark visible.

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

authorizations - The authorizations used.

markEdgeHidden

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

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

Parameters:

edge - The edge to mark visible.

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

authorizations - The authorizations used.

createAuthorizations

public abstract Authorizations createAuthorizations(String... auths)

Description copied from interface: Graph

Creates an authorizations object.

Specified by:

createAuthorizations in interface Graph

Parameters:

auths - The authorizations granted.

Returns:

A new authorizations object

getDefaultFetchHints

public FetchHints getDefaultFetchHints()

Description copied from interface: Graph

The default fetch hints to use if none are provided

Specified by:

getDefaultFetchHints in interface Graph

getBackupDir

public String getBackupDir()

getBackupTool

public GraphBackup getBackupTool(String outputFile)

getRestoreTool

public GraphRestore getRestoreTool()