votorola.a.count.gwt

Class CountJS

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

CountJS

public final class CountJS
extends JavaScriptObject

A count implemented as a JavaScript overlay type. Instances of CountJS may be obtained from the count cache.

See Also:

Count

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CountJS.NodeRequestRecord A cached record of a node request.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CountJS()

Method Summary

Methods

Modifier and Type	Method and Description
JsArray<CountNodeJS>	baseCandidates() A sparse array of the dart sectored base candidates.
(package private) CountNodeJS	cachedOrWireNode(String username, JsMap<CountNodeJS> wiredNodes) Returns a count node for the specified user, either fetching it from the cache or initializing it from the server's response and then caching it.
(package private) void	init(String pollName) Initializes a count that was received on the wire.
static boolean	isNodeRequestComplete(CountJS.NodeRequestRecord r) Answers whether the node request is complete.
CountJS.NodeRequestRecord	nodeRequestRecord(String username) Returns a cached record of a node request, or null if no record is cached.
SacJS	nullSuperaccount() The superaccount for the null count.
String	pollName() Identifies the poll that was counted.
StringBuilder	requestNode_loc(String username, StringBuilder b) Appends the location for calls to requestNode and returns the string builder.
JsonpRequest<CountCache.WAPResponse>	requestNode(String loc, String username, AsyncCallback<CountNodeJS> callback) Requests a node and/or its direct voters from the remote count engine and caches them.
<S extends SacJS> S	superaccount(String countingMethodName, String accountName) Returns the superaccount for the specified counting method and account name; or null if no such superaccount exists.
<S extends SacJS> JsMap<CountingMethodJS<S>>	superaccounts() Resource superaccounts for the entire count, indexed first by the page name of the counting method, then by the account name.
String	uiString() A timestamped identifier based on count.
SacJS_v	voteSuperaccount() The vote superaccount.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

_delete, _get, _getBoolean, _getByte, _getChar, _getDouble, _getFloat, _getInt, _getShort, _getString, _hasOwnProperty, _hasProperty, _propertyIsEnumerable, _set, _setBoolean, _setByte, _setChar, _setDouble, _setFloat, _setInt, _setShort, _setString, cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CountJS

protected CountJS()

Method Detail

init

void init(String pollName)

Initializes a count that was received on the wire.

See Also:

pollName()

cachedOrWireNode

CountNodeJS cachedOrWireNode(String username,
                           JsMap<CountNodeJS> wiredNodes)

Returns a count node for the specified user, either fetching it from the cache or initializing it from the server's response and then caching it. This method serves to give precedence to any cached node, which is irreplaceable because of the possibility that it may already be referenced by a client.

Parameters:

wiredNodes - the "nodes" as received from CountWAP, including that of the specified user.

baseCandidates

public JsArray<CountNodeJS> baseCandidates()

A sparse array of the dart sectored base candidates. The array is indexed from zero with null elements for empty sectors.

See Also:

base candidate

isNodeRequestComplete

public static boolean isNodeRequestComplete(CountJS.NodeRequestRecord r)

Answers whether the node request is complete. Returns true iff a request was issued (record is non-null) that successfully fetched the node, but not its voters.

nodeRequestRecord

public CountJS.NodeRequestRecord nodeRequestRecord(String username)

Returns a cached record of a node request, or null if no record is cached.

nullSuperaccount

public SacJS nullSuperaccount()

The superaccount for the null count.

See Also:

http://reluk.ca/w/Wiki:Null count

pollName

public String pollName()

Identifies the poll that was counted.

requestNode

public JsonpRequest<CountCache.WAPResponse> requestNode(String loc,
                                               String username,
                                               AsyncCallback<CountNodeJS> callback)

Requests a node and/or its direct voters from the remote count engine and caches them. If the node itself is already in the cache, then the request serves only to fetch its voters.

Parameters:

username - the personal name of the node.

callback - a receiver for the processed response.

See Also:

requestNode_loc(String,StringBuilder)

requestNode_loc

public StringBuilder requestNode_loc(String username,
                            StringBuilder b)

Appends the location for calls to requestNode and returns the string builder.

superaccount

public <S extends SacJS> S superaccount(String countingMethodName,
                               String accountName)

Returns the superaccount for the specified counting method and account name; or null if no such superaccount exists.

superaccounts

public <S extends SacJS> JsMap<CountingMethodJS<S>> superaccounts()

Resource superaccounts for the entire count, indexed first by the page name of the counting method, then by the account name.

See Also:

CountWAP

uiString

public String uiString()

A timestamped identifier based on count.readyDirectory().toUIString().

See Also:

CountWAP

voteSuperaccount

public SacJS_v voteSuperaccount()

The vote superaccount.