com.mware.ge

Class GraphBase

java.lang.Object

com.mware.ge.GraphBase

All Implemented Interfaces:

Graph

Direct Known Subclasses:

GraphBaseWithSearchIndex

public abstract class GraphBase
extends Object
implements Graph

Field Summary

Fields

Modifier and Type	Field and Description
protected StackTraceTracker	flushStackTraceTracker
protected Timer	flushTimer
static String	METADATA_DEFINE_PROPERTY_PREFIX
protected static GeLogger	QUERY_LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphBase(boolean strictTyping, GeMetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method and Description
void	addGraphEventListener(GraphEventListener graphEventListener) Adds a graph event listener that will be called when graph events occur.
protected void	addToPropertyDefinitionCache(PropertyDefinition propertyDefinition)
void	clearPropertyDefinitionCache()
Authorizations	createAuthorizations(Authorizations auths, String... additionalAuthorizations) Creates an authorizations object combining auths and additionalAuthorizations.
protected void	deleteAllExtendedDataForElement(Element element, Authorizations authorizations)
abstract void	drop() Drops all tables.
void	dumpGraph()
void	ensurePropertyDefined(String name, Value value)
Iterable<String>	filterEdgeIdsByAuthorization(Iterable<String> edgeIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations) Filters a collection of edge ids by the authorizations of that edge, properties, etc.
Iterable<String>	filterVertexIdsByAuthorization(Iterable<String> vertexIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations) Filters a collection of vertex ids by the authorizations of that vertex, properties, etc.
Iterable<Path>	findPaths(FindPathOptions options, Authorizations authorizations) Finds all paths between two vertices.
protected void	findPathsRecursive(FindPathOptions options, List<Path> foundPaths, Vertex sourceVertex, Vertex destVertex, int hops, Set<String> seenVertices, Path currentPath, ProgressCallback progressCallback, Authorizations authorizations)
protected void	findPathsSetIntersection(FindPathOptions options, List<Path> foundPaths, Vertex sourceVertex, Vertex destVertex, ProgressCallback progressCallback, Authorizations authorizations)
protected void	fireGraphEvent(GraphEvent graphEvent)
abstract void	flush() Flushes any pending mutations to the graph.
protected Iterable<ExtendedDataRow>	getAllExtendedData(FetchHints fetchHints, Authorizations authorizations)
Iterable<ExtendedDataRow>	getExtendedData(Iterable<ExtendedDataRowId> idsIterable, 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.
protected abstract GraphMetadataStore	getGraphMetadataStore()
Iterable<GraphMetadataEntry>	getMetadata() Gets all metadata.
Object	getMetadata(String key) Gets metadata from the graph.
Iterable<GraphMetadataEntry>	getMetadataWithPrefix(String prefix) Gets all metadata with the given prefix.
GeMetricRegistry	getMetricsRegistry() Gets the metrics registry to record internal GraphEngine metrics
PropertyDefinition	getPropertyDefinition(String propertyName) Gets the property definition for the given name.
Collection<PropertyDefinition>	getPropertyDefinitions() Gets all property definitions.
abstract SearchIndexSecurityGranularity	getSearchIndexSecurityGranularity() Gets the granularity of the search index SearchIndexSecurityGranularity
protected Class<? extends Value>	getValueType(Value value)
protected boolean	hasEventListeners()
void	invalidatePropertyDefinition(String propertyName)
abstract boolean	isFieldBoostSupported() Determine if field boost is support.
boolean	isPropertyDefined(String propertyName) Determine if a property is already defined
boolean	isQuerySimilarToTextSupported() Returns true if this graph supports similar to text queries.
protected Iterable<ElementMutation>	orderMutations(Iterable<ElementMutation<? extends Element>> mutations)
abstract GraphQuery	query(Authorizations authorizations) Creates a query builder object used to query the graph.
abstract 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.
abstract void	reindex(Authorizations authorizations) Reindex all vertices and edges.
void	reloadMetadata() Force a reload of graph metadata.
void	removeGraphEventListener(GraphEventListener graphEventListener) Removes a graph event listener
void	removeMetadata(String key) Removes metadata from graph
void	removePropertyDefinition(String propertyName) Removes the property with the given name
Iterable<Element>	saveElementMutations(Iterable<ElementMutation<? extends Element>> mutations, Authorizations authorizations) Saves multiple mutations with a single call.
void	savePropertyDefinition(PropertyDefinition propertyDefinition) Save a pre-made property definition.
void	setMetadata(String key, Object value) Sets metadata on the graph.
abstract void	shutdown() Cleans up or disconnects from the underlying storage.

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

addEdge, addEdge, addEdge, addEdge, addVertex, addVertex, addVertices, createAuthorizations, createAuthorizations, createAuthorizations, defineProperty, deleteEdge, deleteEdge, deleteElement, deleteElements, deleteExtendedDataRow, deleteVertex, deleteVertex, doEdgesExist, doEdgesExist, doesEdgeExist, doesVertexExist, doVerticesExist, findPaths, findPaths, findPaths, findPaths, findRelatedEdgeIds, findRelatedEdgeIds, findRelatedEdgeIdsForVertices, findRelatedEdges, findRelatedEdges, findRelatedEdgeSummary, findRelatedEdgeSummary, findRelatedEdgeSummaryForVertices, getDefaultFetchHints, getEdge, getEdge, getEdge, getEdgeCount, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdgesInRange, getEdgesInRange, getEdgesInRange, getElement, getElement, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedDataForElements, getExtendedDataForElements, getExtendedDataForElements, getIdGenerator, getNameSubstitutionStrategy, getStreamingPropertyValueInputStreams, getVertex, getVertex, getVertex, getVertexCount, getVertexIds, getVertexPropertyCountByValue, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, getVerticesInOrder, getVerticesInOrder, getVerticesInRange, getVerticesInRange, getVerticesInRange, getVerticesWithPrefix, getVerticesWithPrefix, getVerticesWithPrefix, isVisibilityValid, markEdgeHidden, markEdgeVisible, markVertexHidden, markVertexVisible, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareVertex, prepareVertex, prepareVertex, prepareVertex, query, query, softDeleteEdge, softDeleteEdge, softDeleteEdge, softDeleteEdge, softDeleteVertex, softDeleteVertex, softDeleteVertex, softDeleteVertex, truncate, visit, visitEdges, visitElements, visitVertices

Field Detail

QUERY_LOGGER

protected static final GeLogger QUERY_LOGGER

METADATA_DEFINE_PROPERTY_PREFIX

public static final String METADATA_DEFINE_PROPERTY_PREFIX

See Also:

Constant Field Values

flushTimer

protected final Timer flushTimer

flushStackTraceTracker

protected final StackTraceTracker flushStackTraceTracker

Constructor Detail

GraphBase

protected GraphBase(boolean strictTyping,
                    GeMetricRegistry metricRegistry)

Method Detail

filterEdgeIdsByAuthorization

public Iterable<String> filterEdgeIdsByAuthorization(Iterable<String> edgeIds,
                                                     String authorizationToMatch,
                                                     EnumSet<ElementFilter> filters,
                                                     Authorizations authorizations)

Description copied from interface: Graph

Filters a collection of edge ids by the authorizations of that edge, properties, etc. If any of the filtered items match that edge id will be included.

Specified by:

filterEdgeIdsByAuthorization in interface Graph

Parameters:

edgeIds - The edge ids to filter on.

authorizationToMatch - The authorization to look for

filters - The parts of the edge to filter on

authorizations - The authorization to find the edges with

Returns:

The filtered down list of edge ids

filterVertexIdsByAuthorization

public Iterable<String> filterVertexIdsByAuthorization(Iterable<String> vertexIds,
                                                       String authorizationToMatch,
                                                       EnumSet<ElementFilter> filters,
                                                       Authorizations authorizations)

Description copied from interface: Graph

Filters a collection of vertex ids by the authorizations of that vertex, properties, etc. If any of the filtered items match that vertex id will be included.

Specified by:

filterVertexIdsByAuthorization in interface Graph

Parameters:

vertexIds - The vertex ids to filter on.

authorizationToMatch - The authorization to look for

filters - The parts of the edge to filter on

authorizations - The authorization to find the edges with

Returns:

The filtered down list of vertex ids

findPaths

public Iterable<Path> findPaths(FindPathOptions options,
                                Authorizations authorizations)

Description copied from interface: Graph

Finds all paths between two vertices.

Specified by:

findPaths in interface Graph

Parameters:

options - Find path options

authorizations - The authorizations required to load all edges and vertices.

Returns:

An Iterable of lists of paths.

findPathsSetIntersection

protected void findPathsSetIntersection(FindPathOptions options,
                                        List<Path> foundPaths,
                                        Vertex sourceVertex,
                                        Vertex destVertex,
                                        ProgressCallback progressCallback,
                                        Authorizations authorizations)

findPathsRecursive

protected void findPathsRecursive(FindPathOptions options,
                                  List<Path> foundPaths,
                                  Vertex sourceVertex,
                                  Vertex destVertex,
                                  int hops,
                                  Set<String> seenVertices,
                                  Path currentPath,
                                  ProgressCallback progressCallback,
                                  Authorizations authorizations)

getGraphMetadataStore

protected abstract GraphMetadataStore getGraphMetadataStore()

getMetadata

public Iterable<GraphMetadataEntry> getMetadata()

Description copied from interface: Graph

Gets all metadata.

Specified by:

getMetadata in interface Graph

Returns:

Iterable of all metadata.

setMetadata

public void setMetadata(String key,
                        Object value)

Description copied from interface: Graph

Sets metadata on the graph.

Specified by:

setMetadata in interface Graph

Parameters:

key - The key to the metadata.

value - The value to set.

removeMetadata

public void removeMetadata(String key)

Description copied from interface: Graph

Removes metadata from graph

Specified by:

removeMetadata in interface Graph

getMetadata

public Object getMetadata(String key)

Description copied from interface: Graph

Gets metadata from the graph.

Specified by:

getMetadata in interface Graph

Parameters:

key - The key to the metadata.

Returns:

The metadata value, or null.

reloadMetadata

public void reloadMetadata()

Description copied from interface: Graph

Force a reload of graph metadata.

Specified by:

reloadMetadata in interface Graph

getMetadataWithPrefix

public Iterable<GraphMetadataEntry> getMetadataWithPrefix(String prefix)

Description copied from interface: Graph

Gets all metadata with the given prefix.

Specified by:

getMetadataWithPrefix in interface Graph

query

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

Parameters:

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

query

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

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.

reindex

public abstract void reindex(Authorizations authorizations)

Description copied from interface: Graph

Reindex all vertices and edges.

Specified by:

reindex in interface Graph

Parameters:

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

flush

public abstract void flush()

Description copied from interface: Graph

Flushes any pending mutations to the graph.

Specified by:

flush in interface Graph

shutdown

public abstract void shutdown()

Description copied from interface: Graph

Cleans up or disconnects from the underlying storage.

Specified by:

shutdown in interface Graph

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

isFieldBoostSupported

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

getSearchIndexSecurityGranularity

public abstract SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()

Description copied from interface: Graph

Gets the granularity of the search index SearchIndexSecurityGranularity

Specified by:

getSearchIndexSecurityGranularity in interface Graph

addGraphEventListener

public void addGraphEventListener(GraphEventListener graphEventListener)

Description copied from interface: Graph

Adds a graph event listener that will be called when graph events occur.

Specified by:

addGraphEventListener in interface Graph

removeGraphEventListener

public void removeGraphEventListener(GraphEventListener graphEventListener)

Description copied from interface: Graph

Removes a graph event listener

Specified by:

removeGraphEventListener in interface Graph

Parameters:

graphEventListener - The listener to remove

hasEventListeners

protected boolean hasEventListeners()

fireGraphEvent

protected void fireGraphEvent(GraphEvent graphEvent)

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

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

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.

createAuthorizations

public Authorizations createAuthorizations(Authorizations auths,
                                           String... additionalAuthorizations)

Description copied from interface: Graph

Creates an authorizations object combining auths and additionalAuthorizations.

Specified by:

createAuthorizations in interface Graph

Parameters:

auths - The authorizations granted.

additionalAuthorizations - additional authorizations

Returns:

A new authorizations object

addToPropertyDefinitionCache

protected void addToPropertyDefinitionCache(PropertyDefinition propertyDefinition)

clearPropertyDefinitionCache

public void clearPropertyDefinitionCache()

invalidatePropertyDefinition

public void invalidatePropertyDefinition(String propertyName)

savePropertyDefinition

public void savePropertyDefinition(PropertyDefinition propertyDefinition)

Description copied from interface: Graph

Save a pre-made property definition.

Specified by:

savePropertyDefinition in interface Graph

Parameters:

propertyDefinition - the property definition to save.

getPropertyDefinition

public PropertyDefinition getPropertyDefinition(String propertyName)

Description copied from interface: Graph

Gets the property definition for the given name.

Specified by:

getPropertyDefinition in interface Graph

Parameters:

propertyName - name of the property

Returns:

the property definition if found. null otherwise.

removePropertyDefinition

public void removePropertyDefinition(String propertyName)

Description copied from interface: Graph

Removes the property with the given name

Specified by:

removePropertyDefinition in interface Graph

getPropertyDefinitions

public Collection<PropertyDefinition> getPropertyDefinitions()

Description copied from interface: Graph

Gets all property definitions.

Specified by:

getPropertyDefinitions in interface Graph

Returns:

all property definitions.

isPropertyDefined

public boolean isPropertyDefined(String propertyName)

Description copied from interface: Graph

Determine if a property is already defined

Specified by:

isPropertyDefined in interface Graph

ensurePropertyDefined

public void ensurePropertyDefined(String name,
                                  Value value)

Specified by:

ensurePropertyDefined in interface Graph

getValueType

protected Class<? extends Value> getValueType(Value value)

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

Parameters:

mutations - the mutations to save

authorizations - the authorizations used during save

Returns:

the elements which were saved

orderMutations

protected Iterable<ElementMutation> orderMutations(Iterable<ElementMutation<? extends Element>> mutations)

getExtendedData

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

Description copied from interface: Graph

Gets the specified extended data rows.

Specified by:

getExtendedData in interface Graph

Parameters:

idsIterable - The ids of the rows to get.

authorizations - The authorizations used to get the rows

Returns:

Rows

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

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

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.

getAllExtendedData

protected Iterable<ExtendedDataRow> getAllExtendedData(FetchHints fetchHints,
                                                       Authorizations authorizations)

deleteAllExtendedDataForElement

protected void deleteAllExtendedDataForElement(Element element,
                                               Authorizations authorizations)

dumpGraph

public void dumpGraph()

Specified by:

dumpGraph in interface Graph

getMetricsRegistry

public GeMetricRegistry getMetricsRegistry()

Description copied from interface: Graph

Gets the metrics registry to record internal GraphEngine metrics

Specified by:

getMetricsRegistry in interface Graph