Module com.github.moaxcp.graphs.core

Package com.github.moaxcp.graphs

Interface Graph.Edge<ID>

Type Parameters:

ID - type of identifier

All Known Implementing Classes:

AbstractGraph.SimpleEdge

Enclosing interface:

Graph<ID>

public static interface Graph.Edge<ID>

An edge between two vertices in a graph. Edge direction depends on graph type. If the graph is directed isDirected() will return true.

Method Summary

Modifier and Type	Method	Description
List<ID>	endpoints()	Returns ordered pair of endpoint ids.
<T> Optional<T>	findProperty(String name)	Returns Optional of a property.
ID	from()	Returns vertex id of 'from' endpoint.
Graph.Edge<ID>	from(ID from)	Sets vertex id of 'from' endpoint.
Graph.Vertex<ID>	fromVertex()	Returns 'from' vertex
ID	getFrom()	Returns vertex id of 'from' endpoint.
Optional<ID>	getId()	Returns optional identifier of this edge.
default ID	getOppositeEndpoint(ID id)	Returns the opposite endpoint of this edge
<T> T	getProperty(String name)	Returns a property.
ID	getTo()	Returns vertex id of 'to' endpoint.
Graph.Edge<ID>	id(ID id)	Sets identifier of this edge.
Map<String,Object>	inherited()	Returns an unmodifiable map of inherited properties
boolean	isDirected()	Returns true if this edge is directed.
Map<String,Object>	local()	Returns an unmodifiable map of local properties
Graph.Edge<ID>	property(String name, Object value)	Sets the value of a local property returning this edge.
Graph.Edge<ID>	property(String name1, Object value1, String name2, Object value2)	Sets the value of 2 local properties returning this edge.
Graph.Edge<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3)
Graph.Edge<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
Graph.Edge<ID>	property(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
Graph.Edge<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.Edge<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.Edge<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.Edge<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.Edge<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.Edge<ID>	property(Map<String,Object> properties)
Graph.Edge<ID>	remove()	Removes this edge from the graph.
Graph.Edge<ID>	removeProperty(String name)	Removes property from local properties returning this edge.
void	setFrom(ID from)	Sets vertex id of 'from' endpoint.
void	setId(ID id)	Sets identifier of this edge.
void	setProperty(String name, Object value)	Sets the value of a local property.
void	setTo(ID to)	Sets vertex id of 'to' endpoint.
ID	to()	Returns vertex id of 'to' endpoint.
Graph.Edge<ID>	to(ID to)	Sets vertex id of 'to' endpoint.
Graph.Vertex<ID>	toVertex()	Returns 'to' vertex

Method Details

getId

Optional<ID> getId()

Returns optional identifier of this edge.

Returns:

optional identifier

setId

void setId(ID id)

Sets identifier of this edge.

Parameters:

id - of edge

Throws:

NullPointerException - if id is null

id

Graph.Edge<ID> id(ID id)

Sets identifier of this edge.

Parameters:

id - of edge

Returns:

this edge

Throws:

NullPointerException - if id is null

getFrom

ID getFrom()

Returns vertex id of 'from' endpoint.

Returns:

id of 'from' endpoint

setFrom

void setFrom(ID from)

Sets vertex id of 'from' endpoint. If vertex does not exist it is created.

Parameters:

from - endpoint

Throws:

NullPointerException - if from is null

from

ID from()

Returns vertex id of 'from' endpoint.

Returns:

id of 'from' endpoint

from

Graph.Edge<ID> from(ID from)

Sets vertex id of 'from' endpoint. If vertex does not exist it is created.

Parameters:

from - endpoint

Returns:

this edge

Throws:

NullPointerException - if from is null

getTo

ID getTo()

Returns vertex id of 'to' endpoint.

Returns:

id of 'to' endpoint

setTo

void setTo(ID to)

Sets vertex id of 'to' endpoint. If vertex does not exist it is created.

Parameters:

to - endpoint

Throws:

NullPointerException - if to is null

to

ID to()

Returns vertex id of 'to' endpoint.

Returns:

id of 'to' endpoint

to

Graph.Edge<ID> to(ID to)

Sets vertex id of 'to' endpoint. If vertex does not exist it is created.

Parameters:

to - endpoint

Returns:

this edge

endpoints

List<ID> endpoints()

Returns ordered pair of endpoint ids. 'from' endpoint id is always first followed by 'to' endpoint id.

Returns:

order pair of endpoints

getOppositeEndpoint

default ID getOppositeEndpoint(@NonNull
 ID id)

Returns the opposite endpoint of this edge

Parameters:

id - of one endpoint

Returns:

Throws:

NullPointerException - if id is null

IllegalArgumentException - if id is not one of the endpoints of this edge

fromVertex

Graph.Vertex<ID> fromVertex()

Returns 'from' vertex

Returns:

'from' vertex

toVertex

Graph.Vertex<ID> toVertex()

Returns 'to' vertex

Returns:

'to' vertex

isDirected

boolean isDirected()

Returns true if this edge is directed. This edge is always directed if the parent graph is directed.

Returns:

true if this edge is directed

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 edge. If the local property does not exist edgeProperties 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 edge. If the local proeprty does not exist edgeProperties 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

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

Sets the value of a local property returning this edge.

Parameters:

name - of property

value - of property

Returns:

this edge

Throws:

NullPointerException - if name or value is null

property

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

Sets the value of 2 local properties returning this edge. Properties are added in order.

Parameters:

name1 - of first property

value1 - of first property

name2 - of second property

value2 - of second property

Returns:

this edge

Throws:

NullPointerException - if name or value is null for any of the properties

property

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

property

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

property

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

property

Graph.Edge<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

Graph.Edge<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

Graph.Edge<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

Graph.Edge<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

Graph.Edge<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

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

removeProperty

Graph.Edge<ID> removeProperty(String name)

Removes property from local properties returning this edge.

Parameters:

name - of property

Returns:

this edge

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

Graph.Edge<ID> remove()

Removes this edge from the graph.

Returns:

this edge