com.allanbank.mongodb.bson.io

Class StringDecoder.Node

java.lang.Object

com.allanbank.mongodb.bson.io.StringDecoder.Node

Enclosing class:

StringDecoder

protected static class StringDecoder.Node
extends Object

Node provides a single node in the trie.

Each node holds its value and several pointers:

• The myNext and myPrevious values are the pointers to the next and previous elements in the recent linked list.
• The myParent is the parent of this node. For the root nodes this is null.
• myChildren is a two dimension array for the children of this node. We use a 2 dimension array to reduce the memory footprint of the trie by taking advantage of the clustering within the encoding of languages. The first dimension of the array we refer to as the zone and represents the first/high nibble of the value for the child node. The second dimension of the array is the second/low nibble.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
StringDecoder.Node(StringDecoder.Node parent, byte value) Creates a new Node.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAfter(StringDecoder.Node node) Add a node after the provided node.
void	addChild(StringDecoder.Node child) Adds a child node to this node.
StringDecoder.Node	child(byte value) Returns the child node with the specified value.
String	getDecoded() Returns the node's decoded value.
StringDecoder.Node	getNext() Returns the next node in the recent list.
StringDecoder.Node	getPrevious() Returns the previous node in the recent list.
byte	getValue() Returns the node's value.
int	remove() Removes the node and its children from the trie.
void	removeFromList() Removes the node from the recent linked list.
void	setDecoded(String decoded) Sets the decoded value for the node.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringDecoder.Node

public StringDecoder.Node(StringDecoder.Node parent,
                  byte value)

Creates a new Node.

Parameters:

parent - The parent node. May be null.

value - The value for the node.

Method Detail

addAfter

public void addAfter(StringDecoder.Node node)

Add a node after the provided node.

Parameters:

node - The head node.

addChild

public void addChild(StringDecoder.Node child)

Adds a child node to this node.

Parameters:

child - The child node to add.

child

public StringDecoder.Node child(byte value)

Returns the child node with the specified value.

Parameters:

value - The value for the child to find.

Returns:

The child node for the value or null if there is node child with that value.

getDecoded

public String getDecoded()

Returns the node's decoded value.

Returns:

The node's decoded value.

getNext

public StringDecoder.Node getNext()

Returns the next node in the recent list.

Returns:

The next node in the recent list.

getPrevious

public StringDecoder.Node getPrevious()

Returns the previous node in the recent list.

Returns:

The previous node in the recent list.

getValue

public byte getValue()

Returns the node's value.

Returns:

The node's value.

remove

public int remove()

Removes the node and its children from the trie.

Returns:

The number of nodes removed.

removeFromList

public void removeFromList()

Removes the node from the recent linked list.

setDecoded

public void setDecoded(String decoded)

Sets the decoded value for the node.

Parameters:

decoded - The decoded value for the node.