Package io.molr.mole.core.tree

Class TreeStructure

java.lang.Object

io.molr.mole.core.tree.TreeStructure

public class TreeStructure
extends Object

TODO #1 consider merging with MissionRepresentation

Constructor Summary

Constructors

Constructor	Description
TreeStructure(MissionRepresentation representation, Set<Block> parallelBlocks, Map<Block,Integer> maxConcurrency)

Method Summary

Modifier and Type	Method	Description
Set<Block>	allBlocks()
List<Block>	childrenOf(Block block)
boolean	contains(Block block)
boolean	equals(Object o)
int	hashCode()
boolean	isDescendantOf(Block target, Block source)	Determines whether or not the target is a descendant of the source block in this structure.
boolean	isLeaf(Block block)
boolean	isParallel(Block block)
int	maxConcurrency(Block block)
MissionRepresentation	missionRepresentation()
Optional<Block>	nextBlock(Block actualBlock)	Optionally returns the next block in the tree structure of the specified parameter.
Set<Block>	parallelBlocks()
Optional<Block>	parentOf(Block block)
static String	print(TreeStructure structure)
Block	rootBlock()
TreeStructure	substructure(Block block)	Returns a new TreeStructure with the specified Block as root.
TreeStructure	substructure(Block block, String postfix)

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeStructure

public TreeStructure(MissionRepresentation representation,
                     Set<Block> parallelBlocks,
                     Map<Block,Integer> maxConcurrency)

Method Detail

substructure

public TreeStructure substructure(Block block)

Returns a new TreeStructure with the specified Block as root. It will not return a view of this structure but a completely new one.

NOTE: The current implementation is not optimized for performance...

Parameters:

block - the block which shall be the root of the new tree structure

Returns:

a new tree structure, with the given block as root.

substructure

public TreeStructure substructure(Block block,
                                  String postfix)

nextBlock

public Optional<Block> nextBlock(Block actualBlock)

Optionally returns the next block in the tree structure of the specified parameter. Since this method does not know the history of the movements, it will not return as next block a children of the parameter. On the contrary, if the parameter is the last child of a sequence, it will automatically resolve the sibling of the parent as the next block. An empty Optional indicates that there is no next block and the tree navigation can be considered finished

Parameters:

actualBlock - the actual block for which to retrieve the next

Returns:

an optional containing the next block to navigate to or an empty optional, if there is no next block.

childrenOf

public List<Block> childrenOf(Block block)

isParallel

public boolean isParallel(Block block)

maxConcurrency

public int maxConcurrency(Block block)

isLeaf

public boolean isLeaf(Block block)

rootBlock

public Block rootBlock()

allBlocks

public Set<Block> allBlocks()

parallelBlocks

public Set<Block> parallelBlocks()

contains

public boolean contains(Block block)

missionRepresentation

public MissionRepresentation missionRepresentation()

isDescendantOf

public boolean isDescendantOf(Block target,
                              Block source)

Determines whether or not the target is a descendant of the source block in this structure.

NOTE: The current implementation is not optimized for performance...

Parameters:

target - the target, for which to check if it is a descendant of the source

source - the source for which to check if the target is a descendant of it

Returns:

true if the given target is a descendant of the given source, false otherwise.

parentOf

public Optional<Block> parentOf(Block block)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

print

public static String print(TreeStructure structure)