cz.auderis.tools.collection.topo

Interface TopoNode<K,V>

Type Parameters:

K - type of key (usually identifier) of the sorted item

V - type of sorted item

All Known Implementing Classes:

BasicTopoNode

public interface TopoNode<K,V>

Encapsulates all information about one sorted item needed by topological sorting algorithm.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Method Summary

Modifier and Type	Method and Description
Set<K>	getRemainingTopoDependencies() Obtains a set of keys that represent prerequisite items that this item depends on.
K	getTopoKey() Obtains the key of sorted item represented by this node.
V	getValue() Obtains the sorted item that is represented by this node.

Method Detail

getTopoKey

K getTopoKey()

Obtains the key of sorted item represented by this node.

Returns:

key of sorted item

getValue

V getValue()

Obtains the sorted item that is represented by this node.

Returns:

sorted item

getRemainingTopoDependencies

Set<K> getRemainingTopoDependencies()

Obtains a set of keys that represent prerequisite items that this item depends on.

Provided that the sorted item represented by this node depends on nodes A, B, C, that have their respective keys Ak, Bk, Ck, this method initially returs a set of (Ak, Bk, Ck).

During processing of topological sorting algorithm, the returned set will be modified; unless a cycle is detected, at the end of the algorithm this set will be empty.

Notice that the returned set must be mutable. This implies that an instance of TopoNode may not be used in two invocations of topological sorting.

Returns:

mutable set of dependencies of the sorted item that were not yet processed