votorola.a.count

Class Count

java.lang.Object

Count

All Implemented Interfaces:

Serializable

@ThreadSafe
public class Count
extends Object
implements Serializable

The tallied results of a poll.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Count.VoteServerScope API for all counts within the scope of a vote-server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Count(Count count) Constructs a count as a copy of another.
(package private)	Count(String pollName, ReadyDirectory readyDirectory, long _baseCandidateCount, long _candidateCount, long _castVolume, long _rankCount) Partially constructs a Count, for init to finish.

Method Summary

Methods

Modifier and Type	Method and Description
long	baseCandidateCount() The number of base candidate nodes.
long	candidateCount() The number of candidate nodes.
long	castVolume() The total volume of votes cast.
CountTable	countTable() The relational store of count nodes that (in part) backs this count, if known.
CountTable.PollView	countTablePV() The poll view of the count table, if known.
long	holdVolume() The total volume of votes held.
(package private) void	init(CountTable countTable) Completes the construction of a new Count.
(package private) boolean	isObjectReadFromSerialFile(ReadyDirectory newReadyDirectory) Returns true if this count is probably in sync with the serial file of the specified ready directory; false if that file has since been modified or deleted.
long	msEndSnap() The time at which the snapshot of voter input was complete, in milliseconds since the 'epoch'; or Long.MAX_VALUE if the time is unknown.
long	msStartSnap() The time at which the snapshot of voter input commenced, in milliseconds since the 'epoch'; or zero if the time is unknown.
String	pollName() The poll identifier for this count.
long	rankCount() The total number of ranks.
(package private) static Count	readObjectFromSerialFile(String pollName, ReadyDirectory readyDirectory)
ReadyDirectory	readyDirectory() The file part of the backing for this count.
(package private) void	writeObjectToSerialFile()

Methods inherited from class java.lang.Object

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

Constructor Detail

Count

Count(String pollName,
     ReadyDirectory readyDirectory,
     long _baseCandidateCount,
     long _candidateCount,
     long _castVolume,
     long _rankCount)
throws IOException

Partially constructs a Count, for init to finish.

Throws:

IOException

See Also:

candidateCount(), rankCount(), castVolume()

Count

protected Count(Count count)

Constructs a count as a copy of another.

Method Detail

init

@ThreadRestricted(value="constructor")
final void init(CountTable countTable)

Completes the construction of a new Count.

See Also:

countTable()

isObjectReadFromSerialFile

final boolean isObjectReadFromSerialFile(ReadyDirectory newReadyDirectory)

Returns true if this count is probably in sync with the serial file of the specified ready directory; false if that file has since been modified or deleted. Always returns false if the count was never originally deserialized from that file path.

See Also:

readObjectFromSerialFile(String,ReadyDirectory)

readObjectFromSerialFile

static Count readObjectFromSerialFile(String pollName,
                             ReadyDirectory readyDirectory)
                               throws IOException

Throws:

FileNotFoundException - if the count does not include the named poll.

IOException

writeObjectToSerialFile

final void writeObjectToSerialFile()
                            throws IOException

Throws:

IOException

baseCandidateCount

public final long baseCandidateCount()

The number of base candidate nodes.

candidateCount

public final long candidateCount()

The number of candidate nodes.

castVolume

public long castVolume()

The total volume of votes cast. This is equal to the total volume held.

See Also:

CountNodeW.castVolume()

countTable

public final CountTable countTable()

The relational store of count nodes that (in part) backs this count, if known. It is a table named "SCHEMA_NAME.YYYY-MD-S-count_node-S", stored in the count database.

Returns:

reference to relational store, or null if the count was not initialized with a reference.

See Also:

VoteServer.Run.database(), init(CountTable)

countTablePV

public final CountTable.PollView countTablePV()

The poll view of the count table, if known.

Returns:

the poll view, or null if the count was not initialized with a count table.

See Also:

init(CountTable)

holdVolume

public final long holdVolume()

The total volume of votes held. This is equal to the total volume cast.

See Also:

CountNodeW.holdVolume()

msEndSnap

public long msEndSnap()

The time at which the snapshot of voter input was complete, in milliseconds since the 'epoch'; or Long.MAX_VALUE if the time is unknown.

See Also:

System.currentTimeMillis()

msStartSnap

public long msStartSnap()

The time at which the snapshot of voter input commenced, in milliseconds since the 'epoch'; or zero if the time is unknown.

See Also:

System.currentTimeMillis()

pollName

public final String pollName()

The poll identifier for this count.

rankCount

public final long rankCount()

The total number of ranks.

Returns:

count of 1 or larger, or 0 if there are no nodes at all.

readyDirectory

public final ReadyDirectory readyDirectory()

The file part of the backing for this count.