Module com.github.moaxcp.graphs.core

Package com.github.moaxcp.graphs

Interface Graph.Vertex<ID>

Type Parameters:

ID - type of identifier

All Known Implementing Classes:

AbstractGraph.SimpleVertex

Enclosing interface:

Graph<ID>

public static interface Graph.Vertex<ID>

Vertex of graph. A vertex must have an identifier unique to all vertices in the graph.

Method Summary

Modifier and Type	Method	Description
Set<Graph.Edge<ID>>	adjacentEdges()	Returns the set of all edges connecting to this vertex.
Graph.Vertex<ID>	connectsFrom(ID from)	Ensures this vertex connects to the vertex with an 'id' property equal to the 'from' parameter.
Graph.Vertex<ID>	connectsTo(ID to)	Ensures this vertex connects to the vertex with an 'id' property equal to the 'to' parameter.
ID	getId()	returns identifier of vertex.
Optional<Object>	getProperty(String name)	Returns Optional of a property.
Graph.Vertex<ID>	id(ID id)	sets identifier of this vertex.
Set<Graph.Edge<ID>>	inEdges()	Returns the set of edges connecting to this vertex where 'to' is the 'id' of this vertex
Map<String,Object>	inherited()	Returns an unmodifiable map of inherited properties
Map<String,Object>	local()	Returns an unmodifiable map of local properties
Set<Graph.Edge<ID>>	outEdges()	Returns the set of edges connecting to this vertex where 'from' is the 'id' of this vertex
Graph.Vertex<ID>	property(String name, Object value)	Sets the value of a local property returning this vertex.
Graph.Vertex<ID>	removeProperty(String name)	Removes property from local properties returning this vertex.
void	setId(ID id)	sets identifier of vertex.
void	setProperty(String name, Object value)	Sets the value of a local property.

Method Detail

getId

ID getId()

returns identifier of vertex.

Returns:

identifier of vertex

setId

void setId(ID id)

sets identifier of vertex.

Parameters:

id - identifier of vertex

Throws:

NullPointerException - if id is null

IllegalArgumentException - if a vertex with id already exists in the graph

id

Graph.Vertex<ID> id(ID id)

sets identifier of this vertex. This vertex is returned.

Parameters:

id - identifier of vertex.

Returns:

this vertex

Throws:

NullPointerException - if id is null

IllegalArgumentException - if a vertex with id already exists in the graph

connectsTo

Graph.Vertex<ID> connectsTo(ID to)

Ensures this vertex connects to the vertex with an 'id' property equal to the 'to' parameter. The edge or vertex is created if needed. This vertex is returned.

If a vertex is created its 'id' property will be set to the 'to' parameter. If an edge is created the 'from' property is set to the 'id' of this vertex and the 'to' property is set to the 'id' of the 'to' vertex.

If this graph is undirected and contains an edge connecting this vertex with 'to' the edge will not be created. Undirected graphs ignore 'from'/'to' order in edges.

Parameters:

to - vertex id

Returns:

this vertex

Throws:

NullPointerException - if to is null

connectsFrom

Graph.Vertex<ID> connectsFrom(ID from)

Ensures this vertex connects to the vertex with an 'id' property equal to the 'from' parameter. The edge or vertex is created if needed. This vertex is returned.

If a vertex is created its 'id' property will be set to the 'from' parameter. If an edge is created the 'from' property is set to the 'id' of the 'from' vertex and the 'to' property is set to the 'id' of this vertex.

If this graph is undirected and contains an edge connecting this vertex with 'from' the edge will not be created. Undirected graphs ignore 'from'/'to' order in edges.

Parameters:

from - vertex id

Returns:

this vertex

Throws:

NullPointerException - if from is null

adjacentEdges

Set<Graph.Edge<ID>> adjacentEdges()

Returns the set of all edges connecting to this vertex.

Returns:

set of adjacent edges

inEdges

Set<Graph.Edge<ID>> inEdges()

Returns the set of edges connecting to this vertex where 'to' is the 'id' of this vertex

Returns:

incoming edges

outEdges

Set<Graph.Edge<ID>> outEdges()

Returns the set of edges connecting to this vertex where 'from' is the 'id' of this vertex

Returns:

outgoing edges

getProperty

Optional<Object> getProperty(String name)

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

A property is resolved by first checking properties set on this vertex. If the local property does not exist vertexProperties in the graph are checked.

Parameters:

name - of property

Returns:

optional of named property

Throws:

NullPointerException - if name is null

setProperty

void setProperty(String name,
                 Object value)

Sets the value of a local property.

Parameters:

name - of property

value - of property

Throws:

NullPointerException - if name or value is null

property

Graph.Vertex<ID> property(String name,
                          Object value)

Sets the value of a local property returning this vertex.

Parameters:

name - of property

value - of property

Returns:

this vertex

Throws:

NullPointerException - if name or value is null

removeProperty

Graph.Vertex<ID> removeProperty(String name)

Removes property from local properties returning this vertex.

Parameters:

name - of property

Returns:

this vertex

Throws:

NullPointerException - if name is null

inherited

Map<String,Object> inherited()

Returns an unmodifiable map of inherited properties

Returns:

map of inherited properties

local

Map<String,Object> local()

Returns an unmodifiable map of local properties

Returns:

map of local properties