votorola.a.register
Class ListIndexingContext

java.lang.Object
  ListIndexingContext

public class ListIndexingContext
extends Object

A script context for configuring the indexing of a voter list that is currently being compiled. Indexing is the penultimate step in compiling the list. It involves constructing instances of this context, one for each list node, and passing them to the register's list script. The list

Constructor Summary

ListIndexingContext()
Partially constructs a ListIndexingContext.

ListIndexingContext(ListNodeC listNode)
Constructs a ListIndexingContext.

Method Summary

ListNodeC	listNode() The voter's node in the list.
(package private) ListIndexingContext	set(ListNodeC listNode) Sets the fields of this context, for reusing it repeatedly.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListIndexingContext

ListIndexingContext()

Partially constructs a ListIndexingContext.

See Also:

set(ListNodeC)

ListIndexingContext

public ListIndexingContext(ListNodeC listNode)

Constructs a ListIndexingContext.

Parameters:

listNode - the list node to be indexed - its configurable fields will be set to default values, per listNode()

Method Detail

listNode

public ListNodeC listNode()

The voter's node in the list. It is fully defined, except for its:

1. bar - The bar is set to a default that bars the voter owing to a misconfiguration error. You must explicity overwrite this default, or clear it by setting it to null.
2. neighbourhoodPath - The path is set to a default of "" (root leaf). You must set this to a non-empty path, or the voter will automatically be barred from the list.
3. doubterCount - The count is not guaranteed to be accurate at this point.

set

ListIndexingContext set(ListNodeC listNode)

Sets the fields of this context, for reusing it repeatedly.

Parameters:

listNode - the list node to be indexed - its configurable fields will be set to default values, per listNode()

Returns:

this context