TrieNode (InstaTrie 1.5 API)

java.lang.Object
- com.illucit.instatrie.trie.TrieNode<T>

Type Parameters:

T - payload data type

All Implemented Interfaces:

Serializable
```
public class TrieNode<T extends Serializable>
extends Object
implements Serializable
```
Node inside a Trie. The nodes are organized horizontal (each node can get the next brother node) and vertical (each node can get the first son).

This node structure is not threadsafe, so simultanious access by multiple concurrent threads is not permitted, if one of them makes modifications to the node structure.

Author:

Christian Simon

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TrieNode.TrieNodeBrothersIterable<T extends Serializable>` Iterable to iterate over a node and all its next brothers.
`static class`	`TrieNode.TrieNodeDescendantsIterable<T extends Serializable>` Iterable to iterate over a node and all its descendants (all children and children's children).
`static interface`	`TrieNode.TrieNodeIterable<T extends Serializable>` Interface for itable classes with stream support for `TrieNode`s.

Constructor Summary

Constructors
Constructor and Description
`TrieNode(char[] chars, TrieNode<T> brother, TrieNode<T> son, T data, boolean inserted)` Create new trie node.
`TrieNode(String chars, TrieNode<T> brother, TrieNode<T> son, T data, boolean inserted)` Create new trie node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TrieNode.TrieNodeIterable<T>`	`brothers()` Get iterable (for use in foreach loop) to iterate over this node and all of its next brothers.
`TrieNode.TrieNodeIterable<T>`	`children()` Get iterable (for use in foreach loop) to iterate over all children of this node.
`TrieNode.TrieNodeIterable<T>`	`descendants()` Get iterable (for use in foreach loop) to iterate over the node and all of its descendants (its children and their children and so on).
`char[]`	`getChars()` Get the characters leading from the parent ot this node.
`T`	`getData()` Get payload data of the node.
`int`	`getDepth()` Calculate the depth of the tree starting from this node.
`char`	`getFirstChar()` Get the first character of the characters loading from the parent to this node.
`TrieNode<T>`	`getFirstSon()` Get the first son of this node.
`TrieNode<T>`	`getNextBrother()` Get the next brother of this node.
`boolean`	`hasBrothers()` Check if a node has next brothers.
`boolean`	`hasChildren()` Check if a node has children.
`boolean`	`hasData()` Check if a node has data attached to it.
`boolean`	`isInserted()` Get flag if node represents an inserted string in the trie.
`void`	`setChars(char[] chars)` Set the characters leading from the parent ot this node.
`void`	`setData(T data)` Set payload data of the node.
`void`	`setFirstSon(TrieNode<T> firstSon)` Set the first son of this node.
`void`	`setInserted(boolean inserted)` Set flag if node represents an inserted string in the trie.
`void`	`setNextBrother(TrieNode<T> nextBrother)` Set the next brother of this node.
`String`	`toString()` Render the tree starting from this node as String.
`String`	`toString(String indentation)`

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

- Constructor Detail
  - TrieNode
```
public TrieNode(char[] chars,
                TrieNode<T> brother,
                TrieNode<T> son,
                T data,
                boolean inserted)
```
    Create new trie node.
    
    Parameters:
    
    chars - chars containing the path leading from the parent node to this node
    
    brother - next brother (optional)
    
    son - first son (optional)
    
    data - playload data (optional)
    
    inserted - true if the node was introduced as leaf of an insert operation
  - TrieNode
```
public TrieNode(String chars,
                TrieNode<T> brother,
                TrieNode<T> son,
                T data,
                boolean inserted)
```
    Create new trie node.
    
    Parameters:
    
    chars - String containing the path leading from the parent node to this node
    
    brother - next brother (optional)
    
    son - first son (optional)
    
    data - playload data (optional)
    
    inserted - true if the node was introduced as leaf of an insert operation
- Method Detail
  - getChars
```
public char[] getChars()
```
    Get the characters leading from the parent ot this node.
    
    Returns:
    
    character array
  - setChars
```
public void setChars(char[] chars)
```
    Set the characters leading from the parent ot this node.
    
    Parameters:
    
    chars - character array
  - getFirstSon
```
public TrieNode<T> getFirstSon()
```
    Get the first son of this node.
    
    Returns:
    
    trie node or null
  - setFirstSon
```
public void setFirstSon(TrieNode<T> firstSon)
```
    Set the first son of this node.
    
    Parameters:
    
    firstSon - trie node or null
  - getNextBrother
```
public TrieNode<T> getNextBrother()
```
    Get the next brother of this node.
    
    Returns:
    
    trie node or null
  - setNextBrother
```
public void setNextBrother(TrieNode<T> nextBrother)
```
    Set the next brother of this node.
    
    Parameters:
    
    nextBrother - trie node or null
  - getData
```
public T getData()
```
    Get payload data of the node.
    
    Returns:
    
    playload data or null
  - setData
```
public void setData(T data)
```
    Set payload data of the node.
    
    Parameters:
    
    data - playload data or null
  - isInserted
```
public boolean isInserted()
```
    Get flag if node represents an inserted string in the trie.
    
    Returns:
    
    true if node represents an inserted string
  - setInserted
```
public void setInserted(boolean inserted)
```
    Set flag if node represents an inserted string in the trie.
    
    Parameters:
    
    inserted - true if node represents an inserted string
  - hasChildren
```
public boolean hasChildren()
```
    Check if a node has children.
    
    Returns:
    
    true if at least one son exists
  - hasBrothers
```
public boolean hasBrothers()
```
    Check if a node has next brothers.
    
    Returns:
    
    true if at least one next brother exists
  - hasData
```
public boolean hasData()
```
    Check if a node has data attached to it.
    
    Returns:
    
    true if data is attached to the node
  - getFirstChar
```
public char getFirstChar()
```
    Get the first character of the characters loading from the parent to this node.
    
    Returns:
    
    first character
  - getDepth
```
public int getDepth()
```
    Calculate the depth of the tree starting from this node.
    
    Returns:
    
    depth
  - brothers
```
public TrieNode.TrieNodeIterable<T> brothers()
```
    Get iterable (for use in foreach loop) to iterate over this node and all of its next brothers.
    
    Note, that the returned iterable is still attached to the node structure, so concurrent modifications while the iterable is processed are not permitted.
    
    Returns:
    
    iterable of trie nodes
  - children
```
public TrieNode.TrieNodeIterable<T> children()
```
    Get iterable (for use in foreach loop) to iterate over all children of this node.
    
    Note, that the returned iterable is still attached to the node structure, so concurrent modifications while the iterable is processed are not permitted.
    
    Returns:
    
    iterable of trie nodes
  - descendants
```
public TrieNode.TrieNodeIterable<T> descendants()
```
    Get iterable (for use in foreach loop) to iterate over the node and all of its descendants (its children and their children and so on).
    
    Note, that the returned iterable is still attached to the node structure, so concurrent modifications while the iterable is processed are not permitted.
    
    Returns:
    
    iterable of trie nodes
  - toString
```
public String toString()
```
    Render the tree starting from this node as String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the tree at this node
  - toString
```
public String toString(String indentation)
```

Class TrieNode<T extends Serializable>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrieNode

TrieNode

Method Detail

getChars

setChars

getFirstSon

setFirstSon

getNextBrother

setNextBrother

getData

setData

isInserted

setInserted

hasChildren

hasBrothers

hasData

getFirstChar

getDepth

brothers

children

descendants

toString

toString