Module com.github.moaxcp.graphs.core

Package com.github.moaxcp.graphs

Interface PropertyGraph.Vertex<ID>

Type Parameters:

ID - type of identifier

All Known Implementing Classes:

AbstractPropertyGraph.SimpleVertex

Enclosing interface:

PropertyGraph<ID>

public static interface PropertyGraph.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<PropertyGraph.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.
PropertyGraph.Vertex<ID>	connectsFrom(ID source)	Ensures this vertex connects to the vertex with an id property equal to the source parameter.
PropertyGraph.Vertex<ID>	connectsTo(ID target)	Ensures this vertex connects to the vertex with an 'id' property equal to the target parameter.
<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.
PropertyGraph.Vertex<ID>	id(ID id)	sets identifier of this vertex.
Set<PropertyGraph.Edge<ID>>	inEdges()	Returns the set of edges connecting to this vertex where target 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<PropertyGraph.Edge<ID>>	outEdges()	Returns the set of edges connecting to this vertex where source is the id of this vertex
PropertyGraph.Vertex<ID>	property(String name, Object value)	Sets the value of a local property returning this vertex.
PropertyGraph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2)
PropertyGraph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3)
PropertyGraph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
PropertyGraph.Vertex<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
PropertyGraph.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)
PropertyGraph.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)
PropertyGraph.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)
PropertyGraph.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)
PropertyGraph.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)
PropertyGraph.Vertex<ID>	property(Map<String,Object> properties)
PropertyGraph.Vertex<ID>	remove()	Removes this vertex from the graph.
PropertyGraph.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 Details

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

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

PropertyGraph.Vertex<ID> connectsTo(ID target)

Ensures this vertex connects to the vertex with an 'id' property equal to the target 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 target parameter. If an edge is created the source property is set to the 'id' of this vertex and the target property is set to the 'id' of the target vertex.

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

Parameters:

target - vertex id

Returns:

this vertex

Throws:

NullPointerException - if target is null

connectsFrom

PropertyGraph.Vertex<ID> connectsFrom(ID source)

Ensures this vertex connects to the vertex with an id property equal to the source 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 source parameter. If an edge is created the target property is set to the id of the source vertex and the target property is set to the id of this vertex.

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

Parameters:

source - vertex id

Returns:

this vertex

Throws:

NullPointerException - if source is null

adjacentEdges

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

Returns the set of all edges connecting to this vertex.

Returns:

set of adjacent edges

inEdges

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

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

Returns:

incoming edges

outEdges

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

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

Returns:

outgoing edges

findProperty

<T> Optional<T> findProperty(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

getProperty

<T> T getProperty(String name)

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 property does not exist vertexProperties in the graph are checked.

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 the value of a local property.

Parameters:

name - of property

value - of property

Throws:

NullPointerException - if name or value is null

property

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

property

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

property

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

property

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

property

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

property

PropertyGraph.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)

property

PropertyGraph.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)

property

PropertyGraph.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)

property

PropertyGraph.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)

property

PropertyGraph.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)

property

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

removeProperty

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

remove

PropertyGraph.Vertex<ID> remove()

Removes this vertex from the graph.

Returns:

this vertex

connected

boolean connected(ID id)

Returns true if this vertex and id vertex is connected.

Parameters:

id - of vertex

Returns:

true if the two vertices are connected