org.neolumin.vertexium

Interface Graph

All Known Implementing Classes:

GraphBase, GraphBaseWithSearchIndex

public interface Graph

Method Summary

Methods

Modifier and Type	Method and Description
Edge	addEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations) Adds an edge between two vertices.
Edge	addEdge(String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations) Adds an edge between two vertices.
Edge	addEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations) Adds an edge between two vertices.
Edge	addEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations) Adds an edge between two vertices.
void	addGraphEventListener(GraphEventListener graphEventListener) Adds a graph event listener that will be called when graph events occur.
Vertex	addVertex(String vertexId, Visibility visibility, Authorizations authorizations) Adds a vertex to the graph.
Vertex	addVertex(Visibility visibility, Authorizations authorizations) Adds a vertex to the graph.
Iterable<Vertex>	addVertices(Iterable<ElementBuilder<Vertex>> vertices, Authorizations authorizations) Adds the vertices to the graph.
void	clearData() Clears all data from the graph.
Authorizations	createAuthorizations(String... auths) Creates an authorizations object.
DefinePropertyBuilder	defineProperty(String propertyName) Creates a defines property builder.
Map<String,Boolean>	doEdgesExist(List<String> ids, Authorizations authorizations) Tests the existence of edges with the given authorizations.
boolean	doesEdgeExist(String edgeId, Authorizations authorizations) Tests the existence of a edge with the given authorizations.
boolean	doesVertexExist(String vertexId, Authorizations authorizations) Tests the existence of a vertex with the given authorizations.
Map<String,Boolean>	doVerticesExist(List<String> ids, Authorizations authorizations) Tests the existence of vertices with the given authorizations.
Iterable<Path>	findPaths(String sourceVertexId, String destVertexId, int maxHops, Authorizations authorizations) Finds all paths between two vertices.
Iterable<Path>	findPaths(String sourceVertexId, String destVertexId, int maxHops, ProgressCallback progressCallback, Authorizations authorizations) Finds all paths between two vertices.
Iterable<Path>	findPaths(Vertex sourceVertex, Vertex destVertex, int maxHops, Authorizations authorizations) Finds all paths between two vertices.
Iterable<Path>	findPaths(Vertex sourceVertex, Vertex destVertex, int maxHops, ProgressCallback progressCallback, Authorizations authorizations) Finds all paths between two vertices.
Iterable<String>	findRelatedEdges(Iterable<String> vertexIds, Authorizations authorizations) Given a list of vertex ids, find all the edge ids that connect them.
void	flush() Flushes any pending mutations to the graph.
Edge	getEdge(String edgeId, Authorizations authorizations) Get an edge from the graph.
Edge	getEdge(String edgeId, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Get an edge from the graph.
Iterable<Edge>	getEdges(Authorizations authorizations) Gets all edges on the graph.
Iterable<Edge>	getEdges(EnumSet<FetchHint> fetchHints, Authorizations authorizations) Gets all edges on the graph.
Iterable<Edge>	getEdges(Iterable<String> ids, Authorizations authorizations) Gets all edges on the graph matching the given ids.
Iterable<Edge>	getEdges(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Gets all edges on the graph matching the given ids.
IdGenerator	getIdGenerator() Gets the id generator used by this graph to create ids.
Iterable<GraphMetadataEntry>	getMetadata() Gets all metadata.
Object	getMetadata(String key) Gets metadata from the graph.
SearchIndexSecurityGranularity	getSearchIndexSecurityGranularity() Gets the granularity of the search index SearchIndexSecurityGranularity
Vertex	getVertex(String vertexId, Authorizations authorizations) Get a vertex from the graph.
Vertex	getVertex(String vertexId, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Get a vertex from the graph.
Iterable<Vertex>	getVertices(Authorizations authorizations) Gets all vertices on the graph.
Iterable<Vertex>	getVertices(EnumSet<FetchHint> fetchHints, Authorizations authorizations) Gets all vertices on the graph.
Iterable<Vertex>	getVertices(Iterable<String> ids, Authorizations authorizations) Gets all vertices matching the given ids on the graph.
Iterable<Vertex>	getVertices(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Gets all vertices matching the given ids on the graph.
List<Vertex>	getVerticesInOrder(Iterable<String> ids, Authorizations authorizations) Gets all vertices matching the given ids on the graph.
List<Vertex>	getVerticesInOrder(Iterable<String> ids, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Gets all vertices matching the given ids on the graph.
boolean	isFieldBoostSupported() Determine if field boost is support.
boolean	isQuerySimilarToTextSupported()
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	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.
EdgeBuilderByVertexId	prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility) Prepare an edge to be added to the graph.
EdgeBuilderByVertexId	prepareEdge(String outVertexId, String inVertexId, String label, Visibility visibility) Prepare an edge to be added to the graph.
EdgeBuilder	prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility) Prepare an edge to be added to the graph.
EdgeBuilder	prepareEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility) Prepare an edge to be added to the graph.
VertexBuilder	prepareVertex(String vertexId, Visibility visibility) Prepare a vertex to be added to the graph.
VertexBuilder	prepareVertex(Visibility visibility) Prepare a vertex to be added to the graph.
GraphQuery	query(Authorizations authorizations) Creates a query builder object used to query the graph.
GraphQuery	query(String queryString, Authorizations authorizations) Creates a query builder object used to query the graph.
SimilarToGraphQuery	querySimilarTo(String[] fields, String text, Authorizations authorizations)
void	reindex(Authorizations authorizations) Reindex all vertices and edges.
void	removeEdge(Edge edge, Authorizations authorizations) Removes an edge from the graph.
void	removeEdge(String edgeId, Authorizations authorizations) Removes an edge from the graph.
void	removeVertex(Vertex vertex, Authorizations authorizations) Removes a vertex from the graph.
void	setMetadata(String key, Object value) Sets metadata on the graph.
void	shutdown() Cleans up or disconnects from the underlying storage.

Method Detail

addVertex

Vertex addVertex(Visibility visibility,
               Authorizations authorizations)

Adds a vertex to the graph. The id of the new vertex will be generated using an IdGenerator.

Parameters:

visibility - The visibility to assign to the new vertex.

authorizations - The authorizations required to add and retrieve the new vertex.

Returns:

The newly added vertex.

addVertex

Vertex addVertex(String vertexId,
               Visibility visibility,
               Authorizations authorizations)

Adds a vertex to the graph.

Parameters:

vertexId - The id to assign the new vertex.

visibility - The visibility to assign to the new vertex.

authorizations - The authorizations required to add and retrieve the new vertex.

Returns:

The newly added vertex.

addVertices

Iterable<Vertex> addVertices(Iterable<ElementBuilder<Vertex>> vertices,
                           Authorizations authorizations)

Adds the vertices to the graph.

Parameters:

vertices - The vertices to add.

authorizations - The authorizations required to add and retrieve the new vertex.

Returns:

The vertices.

prepareVertex

VertexBuilder prepareVertex(Visibility visibility)

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.

Parameters:

visibility - The visibility to assign to the new vertex.

Returns:

The vertex builder.

prepareVertex

VertexBuilder prepareVertex(String vertexId,
                          Visibility visibility)

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.

Parameters:

vertexId - The id to assign the new vertex.

visibility - The visibility to assign to the new vertex.

Returns:

The vertex builder.

doesVertexExist

boolean doesVertexExist(String vertexId,
                      Authorizations authorizations)

Tests the existence of a vertex with the given authorizations.

Parameters:

vertexId - The vertex id to check existence of.

authorizations - The authorizations required to load the vertex.

Returns:

True if vertex exists.

getVertex

Vertex getVertex(String vertexId,
               Authorizations authorizations)

Get a vertex from the graph.

Parameters:

vertexId - The vertex id to retrieve from the graph.

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.

getVertex

Vertex getVertex(String vertexId,
               EnumSet<FetchHint> fetchHints,
               Authorizations authorizations)

Get a vertex from the graph.

Parameters:

vertexId - The vertex id to retrieve from the graph.

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

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.

getVertices

Iterable<Vertex> getVertices(Authorizations authorizations)

Gets all vertices on the graph.

Parameters:

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

getVertices

Iterable<Vertex> getVertices(EnumSet<FetchHint> fetchHints,
                           Authorizations authorizations)

Gets all vertices on the graph.

Parameters:

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

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

doVerticesExist

Map<String,Boolean> doVerticesExist(List<String> ids,
                                  Authorizations authorizations)

Tests the existence of vertices with the given authorizations.

Parameters:

ids - The vertex ids to check existence of.

authorizations - The authorizations required to load the vertices.

Returns:

Map of ids to exists status.

getVertices

Iterable<Vertex> getVertices(Iterable<String> ids,
                           Authorizations authorizations)

Gets all vertices matching the given ids on the graph. The order of the returned vertices is not guaranteed getVerticesInOrder(Iterable, Authorizations). Vertices are not kept in memory during the iteration.

Parameters:

ids - The ids of the vertices to get.

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

getVertices

Iterable<Vertex> getVertices(Iterable<String> ids,
                           EnumSet<FetchHint> fetchHints,
                           Authorizations authorizations)

Gets all vertices matching the given ids on the graph. The order of the returned vertices is not guaranteed getVerticesInOrder(Iterable, Authorizations). Vertices are not kept in memory during the iteration.

Parameters:

ids - The ids of the vertices to get.

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

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

getVerticesInOrder

List<Vertex> getVerticesInOrder(Iterable<String> ids,
                              Authorizations authorizations)

Gets all vertices matching the given ids on the graph. This method is similar to getVertices(Iterable, Authorizations) but returns the vertices in the order that you passed in the ids. This requires loading all the vertices in memory to sort them.

Parameters:

ids - The ids of the vertices to get.

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

getVerticesInOrder

List<Vertex> getVerticesInOrder(Iterable<String> ids,
                              EnumSet<FetchHint> fetchHints,
                              Authorizations authorizations)

Gets all vertices matching the given ids on the graph. This method is similar to getVertices(Iterable, Authorizations) but returns the vertices in the order that you passed in the ids. This requires loading all the vertices in memory to sort them.

Parameters:

ids - The ids of the vertices to get.

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

authorizations - The authorizations required to load the vertex.

Returns:

An iterable of all the vertices.

removeVertex

void removeVertex(Vertex vertex,
                Authorizations authorizations)

Removes a vertex from the graph.

Parameters:

vertex - The vertex to remove.

authorizations - The authorizations required to remove the vertex.

addEdge

Edge addEdge(Vertex outVertex,
           Vertex inVertex,
           String label,
           Visibility visibility,
           Authorizations authorizations)

Adds an edge between two vertices. The id of the new vertex will be generated using an IdGenerator.

Parameters:

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.

visibility - The visibility to assign to the new edge.

authorizations - The authorizations required to add and retrieve the new edge.

Returns:

The newly created edge.

addEdge

Edge addEdge(String edgeId,
           Vertex outVertex,
           Vertex inVertex,
           String label,
           Visibility visibility,
           Authorizations authorizations)

Adds an edge between two vertices.

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.

visibility - The visibility to assign to the new edge.

authorizations - The authorizations required to add and retrieve the new edge.

Returns:

The newly created edge.

addEdge

Edge addEdge(String outVertexId,
           String inVertexId,
           String label,
           Visibility visibility,
           Authorizations authorizations)

Adds an edge between two vertices.

Parameters:

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.

visibility - The visibility to assign to the new edge.

authorizations - The authorizations required to add and retrieve the new edge.

Returns:

The newly created edge.

addEdge

Edge addEdge(String edgeId,
           String outVertexId,
           String inVertexId,
           String label,
           Visibility visibility,
           Authorizations authorizations)

Adds an edge between two vertices.

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.

visibility - The visibility to assign to the new edge.

authorizations - The authorizations required to add and retrieve the new edge.

Returns:

The newly created edge.

prepareEdge

EdgeBuilder prepareEdge(Vertex outVertex,
                      Vertex inVertex,
                      String label,
                      Visibility visibility)

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. The id of the new edge will be generated using an IdGenerator.

Parameters:

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.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

prepareEdge

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

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.

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.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

prepareEdge

EdgeBuilderByVertexId prepareEdge(String outVertexId,
                                String inVertexId,
                                String label,
                                Visibility visibility)

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.

Parameters:

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.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

prepareEdge

EdgeBuilderByVertexId prepareEdge(String edgeId,
                                String outVertexId,
                                String inVertexId,
                                String label,
                                Visibility visibility)

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.

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.

visibility - The visibility to assign to the new edge.

Returns:

The edge builder.

doesEdgeExist

boolean doesEdgeExist(String edgeId,
                    Authorizations authorizations)

Tests the existence of a edge with the given authorizations.

Parameters:

edgeId - The edge id to check existence of.

authorizations - The authorizations required to load the edge.

Returns:

True if edge exists.

getEdge

Edge getEdge(String edgeId,
           Authorizations authorizations)

Get an edge from the graph.

Parameters:

edgeId - The edge id to retrieve from the graph.

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.

getEdge

Edge getEdge(String edgeId,
           EnumSet<FetchHint> fetchHints,
           Authorizations authorizations)

Get an edge from the graph.

Parameters:

edgeId - The edge id to retrieve from the graph.

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

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

Iterable<Edge> getEdges(Authorizations authorizations)

Gets all edges on the graph.

Parameters:

authorizations - The authorizations required to load the edge.

Returns:

An iterable of all the edges.

getEdges

Iterable<Edge> getEdges(EnumSet<FetchHint> fetchHints,
                      Authorizations authorizations)

Gets all edges on the graph.

Parameters:

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

authorizations - The authorizations required to load the edge.

Returns:

An iterable of all the edges.

doEdgesExist

Map<String,Boolean> doEdgesExist(List<String> ids,
                               Authorizations authorizations)

Tests the existence of edges with the given authorizations.

Parameters:

ids - The edge ids to check existence of.

authorizations - The authorizations required to load the edges.

Returns:

Maps of ids to exists status.

getEdges

Iterable<Edge> getEdges(Iterable<String> ids,
                      Authorizations authorizations)

Gets all edges on the graph matching the given ids.

Parameters:

ids - The ids of the edges to get.

authorizations - The authorizations required to load the edge.

Returns:

An iterable of all the edges.

getEdges

Iterable<Edge> getEdges(Iterable<String> ids,
                      EnumSet<FetchHint> fetchHints,
                      Authorizations authorizations)

Gets all edges on the graph matching the given ids.

Parameters:

ids - The ids of the edges to get.

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

authorizations - The authorizations required to load the edge.

Returns:

An iterable of all the edges.

findRelatedEdges

Iterable<String> findRelatedEdges(Iterable<String> vertexIds,
                                Authorizations authorizations)

Given a list of vertex ids, find all the edge ids that connect them.

Parameters:

vertexIds - The list of vertex ids.

authorizations - The authorizations required to load the edges.

Returns:

An iterable of all the edge ids between any two vertices.

removeEdge

void removeEdge(Edge edge,
              Authorizations authorizations)

Removes an edge from the graph.

Parameters:

edge - The edge to remove.

authorizations - The authorizations required to remove the edge.

removeEdge

void removeEdge(String edgeId,
              Authorizations authorizations)

Removes an edge from the graph.

Parameters:

edgeId - The edge id of the vertex to remove from the graph.

authorizations - The authorizations required to remove the edge.

query

GraphQuery query(String queryString,
               Authorizations authorizations)

Creates a query builder object used to query the 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.

query

GraphQuery query(Authorizations authorizations)

Creates a query builder object used to query the graph.

Parameters:

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

isQuerySimilarToTextSupported

boolean isQuerySimilarToTextSupported()

querySimilarTo

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

flush

void flush()

Flushes any pending mutations to the graph.

shutdown

void shutdown()

Cleans up or disconnects from the underlying storage.

findPaths

Iterable<Path> findPaths(Vertex sourceVertex,
                       Vertex destVertex,
                       int maxHops,
                       Authorizations authorizations)

Finds all paths between two vertices.

Parameters:

sourceVertex - The source vertex to start the search from.

destVertex - The destination vertex to get to.

maxHops - The maximum number of hops to make before giving up.

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

Returns:

An Iterable of lists of paths.

findPaths

Iterable<Path> findPaths(String sourceVertexId,
                       String destVertexId,
                       int maxHops,
                       Authorizations authorizations)

Finds all paths between two vertices.

Parameters:

sourceVertexId - The source vertex id to start the search from.

destVertexId - The destination vertex id to get to.

maxHops - The maximum number of hops to make before giving up.

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

Returns:

An Iterable of lists of paths.

findPaths

Iterable<Path> findPaths(Vertex sourceVertex,
                       Vertex destVertex,
                       int maxHops,
                       ProgressCallback progressCallback,
                       Authorizations authorizations)

Finds all paths between two vertices.

Parameters:

sourceVertex - The source vertex to start the search from.

destVertex - The destination vertex to get to.

maxHops - The maximum number of hops to make before giving up.

progressCallback - Callback used to report progress.

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

Returns:

An Iterable of lists of paths.

findPaths

Iterable<Path> findPaths(String sourceVertexId,
                       String destVertexId,
                       int maxHops,
                       ProgressCallback progressCallback,
                       Authorizations authorizations)

Finds all paths between two vertices.

Parameters:

sourceVertexId - The source vertex id to start the search from.

destVertexId - The destination vertex id to get to.

maxHops - The maximum number of hops to make before giving up.

progressCallback - Callback used to report progress.

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

Returns:

An Iterable of lists of paths.

getIdGenerator

IdGenerator getIdGenerator()

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

Returns:

the id generator.

isVisibilityValid

boolean isVisibilityValid(Visibility visibility,
                        Authorizations authorizations)

Given an authorization is the visibility object valid.

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.

reindex

void reindex(Authorizations authorizations)

Reindex all vertices and edges.

Parameters:

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

defineProperty

DefinePropertyBuilder defineProperty(String propertyName)

Creates a defines property builder. This is typically used by the indexer to give it hints on how it should index a property.

Parameters:

propertyName - The name of the property to define.

setMetadata

void setMetadata(String key,
               Object value)

Sets metadata on the graph.

Parameters:

key - The key to the metadata.

value - The value to set.

getMetadata

Object getMetadata(String key)

Gets metadata from the graph.

Parameters:

key - The key to the metadata.

Returns:

The metadata value, or null.

getMetadata

Iterable<GraphMetadataEntry> getMetadata()

Gets all metadata.

Returns:

Iterable of all metadata.

isFieldBoostSupported

boolean isFieldBoostSupported()

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

clearData

void clearData()

Clears all data from the graph.

getSearchIndexSecurityGranularity

SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()

Gets the granularity of the search index SearchIndexSecurityGranularity

addGraphEventListener

void addGraphEventListener(GraphEventListener graphEventListener)

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

markVertexHidden

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

Marks a vertex as hidden for a given visibility.

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

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

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

Parameters:

vertex - The vertex to mark visible.

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

authorizations - The authorizations used.

markEdgeHidden

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

Marks an edge as hidden for a given visibility.

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

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

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

Parameters:

edge - The edge to mark visible.

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

authorizations - The authorizations used.

createAuthorizations

Authorizations createAuthorizations(String... auths)

Creates an authorizations object.

Parameters:

auths - The authorizations granted.

Returns:

A new authorizations object