MrTreeMap

java.lang.Object
- mr.robotto.engine.collections.MrTreeMap<K,V>

All Implemented Interfaces:

java.lang.Iterable<V>

Direct Known Subclasses:

MrSceneTreeData
```
public class MrTreeMap<K,V>
extends java.lang.Object
implements java.lang.Iterable<V>
```
Tree Structure. This tree can saves nodes in a hierarchically way. Moreover finding an element is done in O(1) because all ellements are hashed using a MrMapFuncion

Field Summary

Fields
Modifier and Type Field and Description

static int BREADTH_TRAVERSAL
Breadth first traversal mode

static int DEPTH_TRAVERSAL
Depth first traversal mode

Fields
Modifier and Type	Field and Description
`static int`	`BREADTH_TRAVERSAL` Breadth first traversal mode
`static int`	`DEPTH_TRAVERSAL` Depth first traversal mode

Constructor Summary

Constructors
Constructor and Description
`MrTreeMap(MrMapFunction<K,V> mapFunction)` Creates an empty MrTreeMap
`MrTreeMap(V root, MrMapFunction<K,V> mapFunction)` Creates a MrTreeMap with a root element

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addChild(V parent, V data)` Adds a child to the node
`boolean`	`addChildByKey(K parentKey, V data)` Adds a child to the node
`java.util.Iterator<V>`	`breadthTraversal()`
`java.util.Iterator<V>`	`breadthTraversal(V data)`
`java.util.Iterator<V>`	`breadthTraversalByKey(K key)`
`void`	`clear()` Clears all elements
`boolean`	`contains(V data)` Checks if the key returned by map-function is in inside the tree
`boolean`	`containsKey(K key)` Checks if key exists
`java.util.Iterator<V>`	`depthTraversal()`
`java.util.Iterator<V>`	`depthTraversal(V data)`
`java.util.Iterator<V>`	`depthTraversalByKey(K key)`
`V`	`findByKey(K key)` Finds an object in this tree using its key
`java.util.List<V>`	`getChildrenOf(V data)` Gets the children of an element
`java.util.List<V>`	`getChildrenOfByKey(K key)` Gets the children of an object using its key
`MrMapFunction<K,V>`	`getMapFunction()` Gets the current map function of this tree
`V`	`getParentOf(V data)` Returns the parent of the element
`V`	`getParentOfByKey(K key)` Gets the parent of an element using its key
`V`	`getRoot()` Gets the root object of this tree
`MrTreeMap<K,V>`	`getSubTree(V data)` Gets the subtree from key element
`MrTreeMap<K,V>`	`getSubTreeByKey(K key)` Gets the subtree from key element using key
`int`	`getTraversalMode()` Gets the current traversal mode
`java.util.Iterator<V>`	`iterator()`
`java.util.Collection<K>`	`keys()` Gets the keys collection
`java.util.Iterator<java.util.Map.Entry<K,V>>`	`parentKeyChildValueTraversal()`
`java.util.Iterator<java.util.Map.Entry<K,V>>`	`parentKeyChildValueTraversal(V data)`
`java.util.Iterator<java.util.Map.Entry<K,V>>`	`parentKeyChildValueTraversalByKey(K key)`
`java.util.Iterator<V>`	`parentTraversal(V data)`
`java.util.Iterator<V>`	`parentTraversalByKey(K key)`
`boolean`	`remove(V data)` Removes a certain element from this tree
`boolean`	`removeByKey(K key)` Removes a certain element in this tree
`void`	`setTraversalMode(int traversalMode)` Sets the current traversal mode
`int`	`size()` Number of elements in this tree

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - BREADTH_TRAVERSAL
```
public static final int BREADTH_TRAVERSAL
```
    Breadth first traversal mode
    
    See Also:
    
    Constant Field Values
  - DEPTH_TRAVERSAL
```
public static final int DEPTH_TRAVERSAL
```
    Depth first traversal mode
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MrTreeMap
```
public MrTreeMap(MrMapFunction<K,V> mapFunction)
```
    Creates an empty MrTreeMap
    
    Parameters:
    
    mapFunction - map-function used for this tree
  - MrTreeMap
```
public MrTreeMap(V root,
                 MrMapFunction<K,V> mapFunction)
```
    Creates a MrTreeMap with a root element
    
    Parameters:
    
    root - root element of tree
    
    mapFunction - map-function used for this tree
- Method Detail
  - getTraversalMode
```
public int getTraversalMode()
```
    Gets the current traversal mode
    
    Returns:
  - setTraversalMode
```
public void setTraversalMode(int traversalMode)
```
    Sets the current traversal mode
    
    Parameters:
    
    traversalMode -
  - getMapFunction
```
public MrMapFunction<K,V> getMapFunction()
```
    Gets the current map function of this tree
    
    Returns:
  - getRoot
```
public V getRoot()
```
    Gets the root object of this tree
    
    Returns:
    
    root object or null if the tree is empty
  - findByKey
```
public V findByKey(K key)
```
    Finds an object in this tree using its key
    
    Parameters:
    
    key - object key, this is the result of tree's map-function
    
    Returns:
    
    object or null if the key does not exists
  - containsKey
```
public boolean containsKey(K key)
```
    Checks if key exists
    
    Parameters:
    
    key -
    
    Returns:
    
    true if the key exists, if it does not, false
  - contains
```
public boolean contains(V data)
```
    Checks if the key returned by map-function is in inside the tree
    
    Parameters:
    
    data -
    
    Returns:
  - clear
```
public void clear()
```
    Clears all elements
  - keys
```
public java.util.Collection<K> keys()
```
    Gets the keys collection
    
    Returns:
    
    All keys already in use in this tree
  - size
```
public int size()
```
    Number of elements in this tree
    
    Returns:
    
    number of elements
  - addChildByKey
```
public boolean addChildByKey(K parentKey,
                             V data)
```
    Adds a child to the node
    
    Parameters:
    
    parentKey - parent node key
    
    data - data to be used as a child
    
    Returns:
    
    true if the insertion has been done, false otherwise
  - addChild
```
public boolean addChild(V parent,
                        V data)
```
    Adds a child to the node
    
    Parameters:
    
    parent - parent object
    
    data - child object to be inserted
    
    Returns:
    
    true if the insertion has been done, false otherwise
  - removeByKey
```
public boolean removeByKey(K key)
```
    Removes a certain element in this tree
    
    Parameters:
    
    key - of the element
    
    Returns:
  - remove
```
public boolean remove(V data)
```
    Removes a certain element from this tree
    
    Parameters:
    
    data - data object to be removed
    
    Returns:
    
    true if the deletion has been done, false otherwise
  - getChildrenOfByKey
```
public java.util.List<V> getChildrenOfByKey(K key)
```
    Gets the children of an object using its key
    
    Parameters:
    
    key - node
    
    Returns:
    
    the children of node
  - getParentOf
```
public V getParentOf(V data)
```
    Returns the parent of the element
    
    Parameters:
    
    data - element
    
    Returns:
    
    the parent of the element, null if it has no parent
  - getParentOfByKey
```
public V getParentOfByKey(K key)
```
    Gets the parent of an element using its key
    
    Parameters:
    
    key - key of the element
    
    Returns:
    
    the parent of the current element
  - getChildrenOf
```
public java.util.List<V> getChildrenOf(V data)
```
    Gets the children of an element
    
    Parameters:
    
    data - the object
    
    Returns:
    
    the children of passed object
  - getSubTreeByKey
```
public MrTreeMap<K,V> getSubTreeByKey(K key)
```
    Gets the subtree from key element using key
    
    Parameters:
    
    key - key of object
    
    Returns:
  - getSubTree
```
public MrTreeMap<K,V> getSubTree(V data)
```
    Gets the subtree from key element
    
    Parameters:
    
    data - object
    
    Returns:
  - parentTraversalByKey
```
public java.util.Iterator<V> parentTraversalByKey(K key)
```
  - breadthTraversalByKey
```
public java.util.Iterator<V> breadthTraversalByKey(K key)
```
  - depthTraversalByKey
```
public java.util.Iterator<V> depthTraversalByKey(K key)
```
  - parentKeyChildValueTraversalByKey
```
public java.util.Iterator<java.util.Map.Entry<K,V>> parentKeyChildValueTraversalByKey(K key)
```
  - parentTraversal
```
public java.util.Iterator<V> parentTraversal(V data)
```
  - breadthTraversal
```
public java.util.Iterator<V> breadthTraversal(V data)
```
  - depthTraversal
```
public java.util.Iterator<V> depthTraversal(V data)
```
  - parentKeyChildValueTraversal
```
public java.util.Iterator<java.util.Map.Entry<K,V>> parentKeyChildValueTraversal(V data)
```
  - breadthTraversal
```
public java.util.Iterator<V> breadthTraversal()
```
  - depthTraversal
```
public java.util.Iterator<V> depthTraversal()
```
  - parentKeyChildValueTraversal
```
public java.util.Iterator<java.util.Map.Entry<K,V>> parentKeyChildValueTraversal()
```
  - iterator
```
public java.util.Iterator<V> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<V>

Class MrTreeMap<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

BREADTH_TRAVERSAL

DEPTH_TRAVERSAL

Constructor Detail

MrTreeMap

MrTreeMap

Method Detail

getTraversalMode

setTraversalMode

getMapFunction

getRoot

findByKey

containsKey

contains

clear

keys

size

addChildByKey

addChild

removeByKey

remove

getChildrenOfByKey

getParentOf

getParentOfByKey

getChildrenOf

getSubTreeByKey

getSubTree

parentTraversalByKey

breadthTraversalByKey

depthTraversalByKey

parentKeyChildValueTraversalByKey

parentTraversal

breadthTraversal

depthTraversal

parentKeyChildValueTraversal

breadthTraversal

depthTraversal

parentKeyChildValueTraversal

iterator