Module com.github.moaxcp.graphs.core

Package com.github.moaxcp.graphs

Interface PropertyGraph<ID>

Type Parameters:

ID - type of all identifiers in graph

All Known Subinterfaces:

EventPropertyGraph<ID>

All Known Implementing Classes:

AbstractPropertyGraph, DirectedPropertyGraph, UndirectedPropertyGraph

public interface PropertyGraph<ID>

A graph is composed of vertices and edges. A vertex is able to connect to other vertices through edges. Edges connect two vertices. A graph can be directed or undirected.

Vertices have an id which uniquely identifies the vertex within the graph. Edges have a source and target property which are the ids of the vertex endpoints. Edges are optionally identified.

At all times the graph is valid event when removing connected vertices.

Undirected graphs ignore source/target order in edges.

Once a vertex or edge is removed it can no longer modify the graph or be modified.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PropertyGraph.Edge<ID>	An edge between two vertices in a graph.
static interface	PropertyGraph.Vertex<ID>	Vertex of graph.

Method Summary

Modifier and Type	Method	Description
default Iterator<PropertyGraph.Vertex<ID>>	breadthFirstIterator(ID... start)	Returns a breadth-first Iterator of every PropertyGraph.Vertex in this graph starting at the provided vertices.
default Stream<PropertyGraph.Vertex<ID>>	breadthFirstStream(ID... start)	Returns a breadth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.
default boolean	connected(ID source, ID target)	Returns true if source and target vertices are connected.
PropertyGraph<ID>	edge(ID source, ID target)	Ensures an edge exists between source and target vertices.
PropertyGraph<ID>	edge(ID source, ID target, String name, Object value)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9)
PropertyGraph<ID>	edge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9, String name10, Object value10)
PropertyGraph<ID>	edge(ID source, ID target, Map<String,Object> properties)
PropertyGraph<ID>	edgeProperty(String name, Object value)	Sets edge property returning this graph
PropertyGraph<ID>	edgeProperty(Map<String,Object> properties)
Optional<PropertyGraph.Edge<ID>>	findEdge(ID id)	finds edge with given id.
Optional<PropertyGraph.Edge<ID>>	findEdge(ID source, ID target)	Finds edge connecting source and target vertex.
<T> Optional<T>	findEdgeProperty(String name)	Returns Optional of an edge property.
<T> Optional<T>	findProperty(String name)	Returns Optional of a property.
Optional<PropertyGraph.Vertex<ID>>	findVertex(ID id)	Finds vertex with given id.
<T> Optional<T>	findVertexProperty(String name)	Returns Optional of a vertex property.
PropertyGraph.Edge<ID>	getEdge(ID source, ID target)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name, Object value)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9, String name10, Object value10)
PropertyGraph.Edge<ID>	getEdge(ID source, ID target, Map<String,Object> properties)
Map<ID,PropertyGraph.Edge<ID>>	getEdgeIds()	Returns a map of edge ids to edges.
Map<String,Object>	getEdgeProperties()	Returns an unmodifiable map of edge properties.
<T> T	getEdgeProperty(String name)	Returns an edge property.
Collection<PropertyGraph.Edge<ID>>	getEdges()	Returns an ordered collection of all edges in this graph.
Optional<ID>	getId()	Returns the id of this graph.
Map<String,Object>	getProperties()	Returns an unmodifiable map of properties for this graph.
<T> T	getProperty(String name)	Returns a property.
PropertyGraph.Vertex<ID>	getVertex(ID id)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name, Object value)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9)
PropertyGraph.Vertex<ID>	getVertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9, String name10, Object value10)
PropertyGraph.Vertex<ID>	getVertex(ID id, Map<String,Object> properties)
Map<String,Object>	getVertexProperties()	Retruns an unmodifiable map of vertex properties.
<T> T	getVertexProperty(String name)	Returns a vertex property.
Map<ID,PropertyGraph.Vertex<ID>>	getVertices()	Returns an ordered map of all vertices in this graph.
PropertyGraph<ID>	id(ID id)	Sets the id of this graph
boolean	isDirected()	Returns true if this graph is directed.
default boolean	isEmpty()	Returns true if this graph is empty.
default Iterator<PropertyGraph.Vertex<ID>>	postOrderIterator(ID... start)	Returns a post-order depth-first Iterator which returns every PropertyGraph.Vertex in this graph starting at the provided vertices.
default Stream<PropertyGraph.Vertex<ID>>	postOrderStream(ID... start)	Returns a post-order depth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.
default Iterator<PropertyGraph.Vertex<ID>>	preOrderIterator(ID... start)	Returns a pre-order depth-first Iterator of every PropertyGraph.Vertex in this graph starting at the provided vertices.
default Stream<PropertyGraph.Vertex<ID>>	preOrderStream(ID... start)	Returns a pre-order depth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.
PropertyGraph<ID>	property(String name, Object value)	Sets property on this graph returning this graph
PropertyGraph<ID>	property(Map<String,Object> properties)
void	removeEdge(ID id)	Removes edge with given id
void	removeEdge(ID source, ID target)	Removes edge with given from and to.
PropertyGraph<ID>	removeEdgeProperty(String name)	Removes edge property returning this graph
PropertyGraph<ID>	removeProperty(String name)	Removes property on this graph returning this graph
void	removeVertex(ID id)	Removes vertex with given id.
PropertyGraph<ID>	removeVertexProperty(String name)	Removes vertex property returning this graph
void	setEdgeProperty(String name, Object value)	Sets edge property.
void	setId(ID id)	Sets the id of this graph.
void	setProperty(String name, Object value)	Sets property on this graph
void	setVertexProperty(String name, Object value)	Sets vertex property.
PropertyGraph<ID>	vertex(ID id)	Ensure a vertex exists with id and returns the vertex.
PropertyGraph<ID>	vertex(ID id, String name, Object value)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9)
PropertyGraph<ID>	vertex(ID id, String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6, String name7, Object value7, String name8, Object value8, String name9, Object value9, String name10, Object value10)
PropertyGraph<ID>	vertex(ID id, Map<String,Object> properties)
PropertyGraph<ID>	vertexProperty(String name, Object value)	Sets vertex property returning this graph
PropertyGraph<ID>	vertexProperty(Map<String,Object> properties)

Method Details

getVertices

Map<ID,PropertyGraph.Vertex<ID>> getVertices()

Returns an ordered map of all vertices in this graph. The key is the vertex id. Ordering is determined by implementing class.

Returns:

ordered map of all vertices in this graph

getEdges

Collection<PropertyGraph.Edge<ID>> getEdges()

Returns an ordered collection of all edges in this graph.

Returns:

ordered collection of all edges

getEdgeIds

Map<ID,PropertyGraph.Edge<ID>> getEdgeIds()

Returns a map of edge ids to edges.

Returns:

map of edge ids to edges

findVertex

Optional<PropertyGraph.Vertex<ID>> findVertex(ID id)

Finds vertex with given id. If vertex is not in this graph the optional is empty.

Parameters:

id - of vertex

Returns:

optional of vertex

Throws:

NullPointerException - if id is null

vertex

PropertyGraph<ID> vertex(ID id)

Ensure a vertex exists with id and returns the vertex. If the vertex does not exist it is created.

Parameters:

id - of vertex

Returns:

created or existing vertex

Throws:

NullPointerException - if id is null

vertex

PropertyGraph<ID> vertex(ID id,
 String name,
 Object value)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9)

vertex

PropertyGraph<ID> vertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9,
 String name10,
 Object value10)

vertex

PropertyGraph<ID> vertex(ID id,
 Map<String,Object> properties)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name,
 Object value)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9,
 String name10,
 Object value10)

getVertex

PropertyGraph.Vertex<ID> getVertex(ID id,
 Map<String,Object> properties)

removeVertex

void removeVertex(ID id)

Removes vertex with given id. If edges connect to the vertex they are removed first.

Parameters:

id - of vertex

Throws:

NullPointerException - if id is null

findEdge

Optional<PropertyGraph.Edge<ID>> findEdge(ID source,
 ID target)

Finds edge connecting source and target vertex. If edge is not in this graph the optional is empty. The order of source and target does not matter in undirected implementations. However, if the graph is directed source and target must match source and target of the edge exactly.

Parameters:

source - of edge

target - of edge

Returns:

optional of edge

Throws:

NullPointerException - if source or target is null

findEdge

Optional<PropertyGraph.Edge<ID>> findEdge(ID id)

finds edge with given id. If edge is not in this graph the optional is empty.

Parameters:

id - of edge

Returns:

optional of edge

Throws:

NullPointerException - if id is null

edge

PropertyGraph<ID> edge(ID source,
 ID target)

Ensures an edge exists between source and target vertices. If an edge does not exist it is created. If any of the vertices do not exist they are created.

If this graph is undirected and contains an edge connecting source and target the edge will not be created. Undirected graphs ignore source/target order in edges.

Parameters:

source - of edge

target - of edge

Returns:

created or existing edge

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name,
 Object value)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9,
 String name10,
 Object value10)

edge

PropertyGraph<ID> edge(ID source,
 ID target,
 Map<String,Object> properties)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name,
 Object value)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6,
 String name7,
 Object value7,
 String name8,
 Object value8,
 String name9,
 Object value9,
 String name10,
 Object value10)

getEdge

PropertyGraph.Edge<ID> getEdge(ID source,
 ID target,
 Map<String,Object> properties)

removeEdge

void removeEdge(ID source,
 ID target)

Removes edge with given from and to.

Parameters:

source - of edge

target - of edge

Throws:

NullPointerException - if source or target is null

IllegalArgumentException - if edge does not exist

removeEdge

void removeEdge(ID id)

Removes edge with given id

Parameters:

id - of edge

Throws:

NullPointerException - if id is null

IllegalArgumentException - if edge with id does not exist

getId

Optional<ID> getId()

Returns the id of this graph. If the id is not set and empty optional is returned.

Returns:

optional of id

setId

void setId(ID id)

Sets the id of this graph.

Parameters:

id - of graph

Throws:

NullPointerException - if id is null

id

PropertyGraph<ID> id(ID id)

Sets the id of this graph

Parameters:

id - of graph

Returns:

this graph

Throws:

NullPointerException - if id is null

isDirected

boolean isDirected()

Returns true if this graph is directed.

Returns:

if this graph is directed

getProperties

Map<String,Object> getProperties()

Returns an unmodifiable map of properties for this graph.

Returns:

an unmodifiable map of properties for this graph

findProperty

<T> Optional<T> findProperty(String name)

Returns Optional of a property. If the property does not exist the returned Optional is empty.

Parameters:

name - of property

Returns:

optional of named proeprty

Throws:

NullPointerException - if name is null

getProperty

<T> T getProperty(String name)

Returns a property. If the property does not exist null is returned.

Type Parameters:

T - return type of property

Parameters:

name - of property

Returns:

value of named property

Throws:

NullPointerException - if name is null

setProperty

void setProperty(String name,
 Object value)

Sets property on this graph

Parameters:

name - of property

value - of property

Throws:

NullPointerException - if name or value is null

property

PropertyGraph<ID> property(String name,
 Object value)

Sets property on this graph returning this graph

Parameters:

name - of property

value - of property

Returns:

this graph

Throws:

NullPointerException - if name or value is null

property

PropertyGraph<ID> property(Map<String,Object> properties)

removeProperty

PropertyGraph<ID> removeProperty(String name)

Removes property on this graph returning this graph

Parameters:

name - of property

Returns:

this graph

Throws:

NullPointerException - if name is null

getEdgeProperties

Map<String,Object> getEdgeProperties()

Returns an unmodifiable map of edge properties.

Returns:

an unmodifiable map of edge properties

findEdgeProperty

<T> Optional<T> findEdgeProperty(String name)

Returns Optional of an edge property. If the property does not exist the returned Optional is empty.

Parameters:

name - of property

Returns:

optional of property

Throws:

NullPointerException - if name is null

getEdgeProperty

<T> T getEdgeProperty(String name)

Returns an edge property. If the property does not exist null is returned.

Parameters:

name - of property

Returns:

property value

Throws:

NullPointerException - if name is null

setEdgeProperty

void setEdgeProperty(String name,
 Object value)

Sets edge property.

Parameters:

name - of property

value - of property

Throws:

NullPointerException - if name or value is null

edgeProperty

PropertyGraph<ID> edgeProperty(String name,
 Object value)

Sets edge property returning this graph

Parameters:

name - of edge property

value - of edge property

Returns:

this graph

Throws:

NullPointerException - if name or value is null

edgeProperty

PropertyGraph<ID> edgeProperty(Map<String,Object> properties)

removeEdgeProperty

PropertyGraph<ID> removeEdgeProperty(String name)

Removes edge property returning this graph

Parameters:

name - of property

Returns:

this graph

Throws:

NullPointerException - if name is null

getVertexProperties

Map<String,Object> getVertexProperties()

Retruns an unmodifiable map of vertex properties.

Returns:

an unmodifiable map of vertex properties

findVertexProperty

<T> Optional<T> findVertexProperty(String name)

Returns Optional of a vertex property. If the property does not exist the returned Optional is empty.

Parameters:

name - of property

Returns:

optional of property

Throws:

NullPointerException - if name is null

getVertexProperty

<T> T getVertexProperty(String name)

Returns a vertex property. If the property does not exist null is returned.

Parameters:

name - of property

Returns:

property value

Throws:

NullPointerException - if name is null

setVertexProperty

void setVertexProperty(String name,
 Object value)

Sets vertex property.

Parameters:

name - of property

value - of property

Throws:

NullPointerException - if name or value is null

vertexProperty

PropertyGraph<ID> vertexProperty(String name,
 Object value)

Sets vertex property returning this graph

Parameters:

name - of property

value - of property

Returns:

created or existing edge

Throws:

NullPointerException - if name or value is null

vertexProperty

PropertyGraph<ID> vertexProperty(Map<String,Object> properties)

removeVertexProperty

PropertyGraph<ID> removeVertexProperty(String name)

Removes vertex property returning this graph

Parameters:

name - of property

Returns:

this graph

Throws:

NullPointerException - if name is null

connected

default boolean connected(@NonNull
 ID source,
 @NonNull
 ID target)

Returns true if source and target vertices are connected.

Parameters:

source - id of vertex

target - id of vertex

Returns:

true if the two vertices are connected

postOrderIterator

default Iterator<PropertyGraph.Vertex<ID>> postOrderIterator(ID... start)

Returns a post-order depth-first Iterator which returns every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

postOrderStream

default Stream<PropertyGraph.Vertex<ID>> postOrderStream(ID... start)

Returns a post-order depth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

preOrderIterator

default Iterator<PropertyGraph.Vertex<ID>> preOrderIterator(ID... start)

Returns a pre-order depth-first Iterator of every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

preOrderStream

default Stream<PropertyGraph.Vertex<ID>> preOrderStream(ID... start)

Returns a pre-order depth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

breadthFirstIterator

default Iterator<PropertyGraph.Vertex<ID>> breadthFirstIterator(ID... start)

Returns a breadth-first Iterator of every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

breadthFirstStream

default Stream<PropertyGraph.Vertex<ID>> breadthFirstStream(ID... start)

Returns a breadth-first Stream of every PropertyGraph.Vertex in this graph starting at the provided vertices.

Parameters:

start - ids of traversal

Returns:

Throws:

NullPointerException - if start is null or any id in start

IllegalArgumentException - if start contains ids that are not in the graph

isEmpty

default boolean isEmpty()

Returns true if this graph is empty.

Returns: