Module com.github.moaxcp.graphs.core

Package com.github.moaxcp.graphs

Class AbstractGraph.SimpleVertex

java.lang.Object

com.github.moaxcp.graphs.AbstractGraph.SimpleVertex

All Implemented Interfaces:

Graph.Vertex<ID>

Enclosing class:

AbstractGraph<ID>

public class AbstractGraph.SimpleVertex
extends Object
implements Graph.Vertex<ID>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleVertex(ID id, Map<String,Object> local, Map<String,Object> inherited)

Method Summary

Modifier and Type	Method	Description
Set<Graph.Edge<ID>>	adjacentEdges()	Returns the set of all edges connecting to this vertex.
boolean	connected(ID id)	Returns true if this vertex and 'id' vertex is connected.
Graph.Vertex<ID>	connectsFrom(ID s)	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.
final boolean	equals(Object o)
<T> Optional<T>	findProperty(String name)	Returns Optional of a property.
ID	getId()	returns identifier of vertex.
<T> T	getProperty(String name)	Returns a property.
final int	hashCode()
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>	property(String name1, Object value1, String name2, Object value2)
Graph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3)
Graph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
Graph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
Graph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5, String name6, Object value6)
Graph.Vertex<ID>	property(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)
Graph.Vertex<ID>	property(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)
Graph.Vertex<ID>	property(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)
Graph.Vertex<ID>	property(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)
Graph.Vertex<ID>	property(Map<String,Object> properties)
Graph.Vertex<ID>	remove()	Removes this vertex from the graph.
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleVertex

protected SimpleVertex(@NonNull
 ID id,
 Map<String,Object> local,
 Map<String,Object> inherited)

Method Details

inherited

public Map<String,Object> inherited()

Description copied from interface: Graph.Vertex

Returns an unmodifiable map of inherited properties

Specified by:

inherited in interface Graph.Vertex<ID>

Returns:

map of inherited properties

local

public Map<String,Object> local()

Description copied from interface: Graph.Vertex

Returns an unmodifiable map of local properties

Specified by:

local in interface Graph.Vertex<ID>

Returns:

map of local properties

getId

public ID getId()

Description copied from interface: Graph.Vertex

returns identifier of vertex.

Specified by:

getId in interface Graph.Vertex<ID>

Returns:

identifier of vertex

setId

public void setId(@NonNull
 ID id)

Description copied from interface: Graph.Vertex

sets identifier of vertex.

Specified by:

setId in interface Graph.Vertex<ID>

Parameters:

id - identifier of vertex

id

public Graph.Vertex<ID> id(ID id)

Description copied from interface: Graph.Vertex

sets identifier of this vertex. This vertex is returned.

Specified by:

id in interface Graph.Vertex<ID>

Parameters:

id - identifier of vertex.

Returns:

this vertex

findProperty

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

Description copied from interface: Graph.Vertex

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.

Specified by:

findProperty in interface Graph.Vertex<ID>

Parameters:

name - of property

Returns:

optional of named property

getProperty

public <T> T getProperty(String name)

Description copied from interface: Graph.Vertex

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

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

Specified by:

getProperty in interface Graph.Vertex<ID>

Type Parameters:

T - return type of property

Parameters:

name - of property

Returns:

value of named property

setProperty

public void setProperty(String name,
 Object value)

Description copied from interface: Graph.Vertex

Sets the value of a local property.

Specified by:

setProperty in interface Graph.Vertex<ID>

Parameters:

name - of property

value - of property

property

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

Description copied from interface: Graph.Vertex

Sets the value of a local property returning this vertex.

Specified by:

property in interface Graph.Vertex<ID>

Parameters:

name - of property

value - of property

Returns:

this vertex

property

public Graph.Vertex<ID> property(String name1,
 Object value1,
 String name2,
 Object value2)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5,
 String name6,
 Object value6)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(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)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(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)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(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)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(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)

Specified by:

property in interface Graph.Vertex<ID>

property

public Graph.Vertex<ID> property(Map<String,Object> properties)

Specified by:

property in interface Graph.Vertex<ID>

removeProperty

public Graph.Vertex<ID> removeProperty(String name)

Description copied from interface: Graph.Vertex

Removes property from local properties returning this vertex.

Specified by:

removeProperty in interface Graph.Vertex<ID>

Parameters:

name - of property

Returns:

this vertex

connectsTo

public Graph.Vertex<ID> connectsTo(ID to)

Description copied from interface: Graph.Vertex

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.

Specified by:

connectsTo in interface Graph.Vertex<ID>

Parameters:

to - vertex id

Returns:

this vertex

connectsFrom

public Graph.Vertex<ID> connectsFrom(ID s)

Description copied from interface: Graph.Vertex

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.

Specified by:

connectsFrom in interface Graph.Vertex<ID>

Parameters:

s - vertex id

Returns:

this vertex

adjacentEdges

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

Description copied from interface: Graph.Vertex

Returns the set of all edges connecting to this vertex.

Specified by:

adjacentEdges in interface Graph.Vertex<ID>

Returns:

set of adjacent edges

inEdges

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

Description copied from interface: Graph.Vertex

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

Specified by:

inEdges in interface Graph.Vertex<ID>

Returns:

incoming edges

outEdges

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

Description copied from interface: Graph.Vertex

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

Specified by:

outEdges in interface Graph.Vertex<ID>

Returns:

outgoing edges

remove

public Graph.Vertex<ID> remove()

Description copied from interface: Graph.Vertex

Removes this vertex from the graph.

Specified by:

remove in interface Graph.Vertex<ID>

Returns:

tis vertex

connected

public boolean connected(@NonNull
 ID id)

Description copied from interface: Graph.Vertex

Returns true if this vertex and 'id' vertex is connected.

Specified by:

connected in interface Graph.Vertex<ID>

Parameters:

id - of vertex

Returns:

true if the two vertices are connected

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object