votorola.a.count

Class Vote

java.lang.Object

Vote

All Implemented Interfaces:

Serializable, Cloneable

@ThreadRestricted(value="touch")
public final class Vote
extends Object
implements Cloneable, Serializable

A voter's input to a poll backed by a row of the input table.

See Also:

InputTable, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Vote.CastEvent An event that records the casting of a vote.
static class	Vote.VotingEvent An event that records the casting or withdrawal of a vote.
static class	Vote.WithdrawalEvent An event that records the withdrawal of a vote.

Constructor Summary

Constructors

Constructor and Description
Vote(IDPair _voter) Constructs a Vote with default initial data.
Vote(IDPair voter, String xml) Constructs a Vote from the specified initial data.
Vote(IDPair _voter, VoterInputTable<?> voterInputTable) Constructs a Vote from an ID pair, reading the initial state from the input table.
Vote(String voterEmail) Constructs a Vote with default initial data.
Vote(String voterEmail, String xml) Constructs a Vote from the specified initial data.
Vote(String voterEmail, VoterInputTable<?> _voterInputTable) Constructs a Vote from an email address, reading the initial state from the input table.

Method Summary

Methods

Modifier and Type	Method and Description
Vote	clone()
IDPair	getCandidate() The candidate for whom the voter is voting, or NOBODY if the voter's vote is currently uncast.
String	getCandidateEmail() Identifies the candidate for whom the voter is voting.
byte	getDartSector() Returns the dart sector that was last assigned by a count, if any.
long	getTime() Specifies the time at which the voter last altered this vote.
void	resetTime() Sets the time at which the voter last altered this vote to the current clock time.
void	setCandidate(IDPair newCandidate) Changes the candidate for whom the voter is voting, and resets the timestamp.
void	setCandidateEmail(String newCandidateEmail) Changes the candidate for whom the voter is voting, and resets the timestamp.
void	setDartSector(int _newSector) Sets the dart sector.
void	setTime(long newTime) Sets the time at which the voter last altered this vote.
IDPair	voter() The voter.
String	voterEmail() Identifies the voter.
(package private) void	write(VoterInputTable<?> voterInputTable, ServiceSession userSession) Writes this vote to the table if it has unwritten changes, or deletes the vote if it's at default.
void	write(VoterInputTable<?> voterInputTable, ServiceSession userSession, boolean toForce) Writes this vote to the table, or deletes the vote if it's at default.

Methods inherited from class java.lang.Object

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

Constructor Detail

Vote

public Vote(IDPair _voter,
    VoterInputTable<?> voterInputTable)
     throws SQLException

Constructs a Vote from an ID pair, reading the initial state from the input table.

Throws:

SQLException

Vote

public Vote(String voterEmail,
    VoterInputTable<?> _voterInputTable)
     throws SQLException

Constructs a Vote from an email address, reading the initial state from the input table.

Throws:

SQLException

Vote

Vote(IDPair voter,
    String xml)
throws XMLStreamException

Constructs a Vote from the specified initial data.

Parameters:

xml - the initial data from the 'xml' column of the input table, or null to use defaults.

Throws:

XMLStreamException

Vote

public Vote(String voterEmail,
    String xml)
     throws XMLStreamException

Constructs a Vote from the specified initial data.

Parameters:

xml - the initial data from the 'xml' column of the input table, or null to use defaults.

Throws:

XMLStreamException

Vote

public Vote(IDPair _voter)

Constructs a Vote with default initial data.

Vote

public Vote(String voterEmail)

Constructs a Vote with default initial data.

Method Detail

getCandidate

public IDPair getCandidate()

The candidate for whom the voter is voting, or NOBODY if the voter's vote is currently uncast.

See Also:

setCandidate(IDPair)

setCandidate

public void setCandidate(IDPair newCandidate)

Changes the candidate for whom the voter is voting, and resets the timestamp.

See Also:

getCandidate(), resetTime()

getCandidateEmail

public String getCandidateEmail()

Identifies the candidate for whom the voter is voting. This method is provided for backward compatibility and will soon be deprecated.

Returns:

the canonical email address of the candidate, or null if the vote is currently uncast.

setCandidateEmail

public void setCandidateEmail(String newCandidateEmail)

Changes the candidate for whom the voter is voting, and resets the timestamp. This method is provided for backward compatibility, and will soon be deprecated.

getDartSector

public byte getDartSector()

Returns the dart sector that was last assigned by a count, if any.

Returns:

a dart sector of 1 to 20, or zero if no dart sector has been assigned.

See Also:

setDartSector(int), CountNode.dartSector()

setDartSector

public void setDartSector(int _newSector)

Sets the dart sector.

See Also:

getDartSector()

getTime

public long getTime()

Specifies the time at which the voter last altered this vote.

Returns:

the time in milliseconds since the Epoch, or 0L if the time is unknown, or if this vote has never been altered by the voter.

See Also:

getCandidateEmail(), setTime(long)

resetTime

public void resetTime()

Sets the time at which the voter last altered this vote to the current clock time.

See Also:

getTime()

setTime

public void setTime(long newTime)

Sets the time at which the voter last altered this vote.

See Also:

getTime()

voter

public IDPair voter()

The voter.

voterEmail

public String voterEmail()

Identifies the voter. This method is provided for backward compatibility, and will soon be deprecated.

Returns:

the canonical email address.

See Also:

InternetAddressX.canonicalAddress(String)

write

void write(VoterInputTable<?> voterInputTable,
         ServiceSession userSession)
     throws SQLException,
            VoterInputTable.BadInputException

Writes this vote to the table if it has unwritten changes, or deletes the vote if it's at default.

Parameters:

userSession - the session of the user requesting the change, or null if the change is not user requested.

Throws:

SQLException

VoterInputTable.BadInputException

write

public void write(VoterInputTable<?> voterInputTable,
         ServiceSession userSession,
         boolean toForce)
           throws SQLException,
                  VoterInputTable.BadInputException

Writes this vote to the table, or deletes the vote if it's at default.

Parameters:

toForce - false to write only if changes were made; true to force the write regardless.

userSession - the session of the user requesting the change, or null if the change is not user requested.

Throws:

SQLException

VoterInputTable.BadInputException

clone

public final Vote clone()

Overrides:

clone in class Object