votorola.s.gwt.scene.vote

Class DartScoping

java.lang.Object

DartScoping

All Implemented Interfaces:

Scoping

final class DartScoping
extends Object
implements Scoping

Position scoping based on dart sectors. A user's stance in regard to a particular issue is specified by reference to a poll name and a votepath of dart sectors. The scoping state is exposed in the 's' switch:

Switch	Controlled state	Default
s	The scoping state. Its form is s=poll-name*votepath. The vote path is optional. Examples are "s=Sys/p/sandbox" and "s=Sys/p/sandbox*9kc2".	None, which means all positions in all polls.

When the stage is ready to be initialized, this scoping model sets the actor and poll according to the 's' switch. It thereafter keeps itself and the stage in synchrony. At present it cannot synchonize to a change of actor on the stage, however, nor can it honour the configuration of a default actor; when these become necessary, please refer to the implementation plan in the code.

See Also:

Scoping, Category:Position, CountNode.dartSector()

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	DIGIT_ENCODER A string of encoded digits for use in translation from radix 10 to 21.

Constructor Summary

Constructors

Constructor and Description
DartScoping(Spool _spool) Constructs a DartScoping.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addHandler(ScopeChangeHandler handler) Registers a handler to receive change events fired from this scoping model.
(package private) static StringBuilder	appendSwitch(StringBuilder b, String pollName, String votepath) Appends a value for the 's' scoping switch to accord with the specified parameters.
(package private) byte	dartSector(int v) Decodes the dart sector for the specified offset along the votepath.
(package private) String	pollName() The name of the poll in which the user takes a position, or null if no poll is specified.
(package private) void	syncActorToStage(CountNodeJS nodeOnVotepath, String votepathFromNode) Prompts this scoping model to set the stage actor if that is wanted.
String	toString()
(package private) String	votepath() The path of a vote expressed as a sequence of count nodes, each node being identified by an encoded dart sector.

Methods inherited from class java.lang.Object

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

Field Detail

DIGIT_ENCODER

static final String DIGIT_ENCODER

A string of encoded digits for use in translation from radix 10 to 21. Usage:

     char radix21Digit = DIGIT_ENCODER[radix10DartSector];

See Also:

Constant Field Values

Constructor Detail

DartScoping

public DartScoping(Spool _spool)

Constructs a DartScoping.

Parameters:

_spool - the spool for the release of associated holds. When unwound it releases the holds of the instance and thereby disables it.

Throws:

IllegalStateException - if the stage is configured with a default actor, which is not currently supported.

Method Detail

appendSwitch

static StringBuilder appendSwitch(StringBuilder b,
                         String pollName,
                         String votepath)

Appends a value for the 's' scoping switch to accord with the specified parameters.

Returns:

the same string builder.

See Also:

pollName(), votepath()

dartSector

byte dartSector(int v)

Decodes the dart sector for the specified offset along the votepath.

Parameters:

v - the character offset along the votepath.

Returns:

a dart sector of 1 to 20.

See Also:

votepath(), CountNode.dartSector()

pollName

final String pollName()

The name of the poll in which the user takes a position, or null if no poll is specified. If no poll is specifed, then the votepath will be empty.

See Also:

Poll.name()

syncActorToStage

void syncActorToStage(CountNodeJS nodeOnVotepath,
                    String votepathFromNode)

Prompts this scoping model to set the stage actor if that is wanted. This is a temporary workaround for the difficult task of mapping votepaths to usernames. Instead we depend on VotespaceV to discover the information for its own purposes and then to send this prompt.

Parameters:

nodeOnVotepath - a node that is on the current votepath, or null if a missing node is detected.

votepathFromNode - the votepath from the node to the terminal candidate, which may be null if the node is null.

votepath

String votepath()

The path of a vote expressed as a sequence of count nodes, each node being identified by an encoded dart sector. The path extends from the voter node (index 0) through each candidate node that receives the vote. The dart sector of each node is encoded in radix 21 using the following ASCII characters as digits:

"0123456789bcdfghjkmnp"

Dart sectors are therefore encoded as single digits in the range 1 to p. For example, the path of encoded digits "9kc2" decodes to sector numbers (9, 17, 11, 2).

Returns:

the votepath which may be an empty string.

See Also:

dartSector(int), CountNode.dartSector()

toString

public String toString()

Overrides:

toString in class Object

addHandler

public HandlerRegistration addHandler(ScopeChangeHandler handler)

Description copied from interface: Scoping

Registers a handler to receive change events fired from this scoping model.

Specified by:

addHandler in interface Scoping

See Also:

ScopeChangeEvent.addHandler(ScopeChangeHandler)