com.agenarisk.api.model.interfaces

Interface Networked<N extends Networked>

Type Parameters:

N - specific class implementing Networked, e.g. Network or Node

All Known Implementing Classes:

Network, Node

public interface Networked<N extends Networked>

An interface for objects that can be connected into a network of objects (e.g. Nodes can be connected within a Network, or Networks can be connected within a Model).

Author:

Eugene Dementiev

Method Summary

Modifier and Type	Method and Description
Set<N>	getChildren() Builds and returns a set of children, which is valid at the time of request.
List<Link>	getLinksIn() Returns a copy of the list of incoming Links.
List<Link>	getLinksOut() Returns a copy of the list of outgoing Links.
Set<N>	getParents() Builds and returns a set of parents, which is valid at the time of request.
default boolean	hasAncestor(N ancestor) Checks recursively whether any of the links are incoming from the provided ancestor.
default boolean	hasDescendant(N descendant) Checks recursively whether any of the links are outgoing to the provided descendant.
boolean	unlink(N networked) Breaks the Link between this Networked object and the one provided, regardless of which one is the parent and which is the child.

Method Detail

hasAncestor

default boolean hasAncestor(N ancestor)

Checks recursively whether any of the links are incoming from the provided ancestor.

Parameters:

ancestor - ancestor object to look for

Returns:

true if ancestor is direct parent or a recursive ancestor

hasDescendant

default boolean hasDescendant(N descendant)

Checks recursively whether any of the links are outgoing to the provided descendant.

Parameters:

descendant - descendant object to look for

Returns:

true if descendant is direct child or a recursive descendant

getParents

Set<N> getParents()

Builds and returns a set of parents, which is valid at the time of request. This set will not reflect any membership changes made afterwards.

Returns:

a set of Networked parents

getChildren

Set<N> getChildren()

Builds and returns a set of children, which is valid at the time of request. This set will not reflect any membership changes made afterwards.

Returns:

a set of Networked children

getLinksIn

List<Link> getLinksIn()

Returns a copy of the list of incoming Links. The membership is only guaranteed to be valid at the time of request and is not maintained.

Returns:

list of incoming Links

getLinksOut

List<Link> getLinksOut()

Returns a copy of the list of outgoing Links. The membership is only guaranteed to be valid at the time of request and is not maintained.

Returns:

list of outgoing Links

unlink

boolean unlink(N networked)

Breaks the Link between this Networked object and the one provided, regardless of which one is the parent and which is the child.

Parameters:

networked - the Networked object to break a link with

Returns:

true if the Link was actually removed and false if there was no such Link to begin with