votorola.a.count

Class PollService

java.lang.Object

VoterService

PollService

All Implemented Interfaces:

Comparable<PollService>, Poll, InputStore

@ThreadRestricted(value="holds lock()")
public final class PollService
extends VoterService
implements Comparable<PollService>, InputStore, Poll

A poll provided as a voter service.

See Also:

manual.xht#Polls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PollService.ConstructionContext A context for configuring the construction of a PollService.
static class	PollService.VoteServerScope API for all polls within the scope of a vote-server.

Nested classes/interfaces inherited from class VoterService

VoterService.IllegalNameException, VoterService.NoSuchServiceException

Nested classes/interfaces inherited from interface InputStore

InputStore.U

Nested classes/interfaces inherited from interface Poll

Poll.U

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	POLL_NAME_PATTERN The allowable pattern of a poll name.

Fields inherited from class VoterService

constructionContext, lock, name, NAME_MAX_LENGTH, NAME_PATTERN, vsRun

Fields inherited from interface Poll

NOT_A_POLL, TEST_POLL_NAME

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PollService p) Compares based on caseless short name, cased short name, caseless full name, and finally cased full name.
(package private) JavaScriptIncluder	configurationScript() The compiled configuration script for the poll.
Count	countToReport() The current count to report, or null if there is none.
Count	countToReportT() Siezes the thread-access lock and returns the current count to report, or null if there is none.
Exception	dispatch(String[] argArray, CommandResponder.Session commandSession) Looks up the responder of the specified command, and sends the command to it.
String	displayTitle() An informal, descriptive title for the poll in wiki-style title case, or null if there is none.
Set<String>	divisionalComponents() The set of divisions whose members are exclusively eligible to vote in this poll.
String	divisionPageName() The polling division, specified by its pollwiki pagename.
String	divisionSmallMapPageName() A small map of the polling division, specified by its pollwiki pagename.
String	issueType() The issue type of the poll, specified by the short name of its page in the pollwiki, i.e. without the namespace.
ActivityEvent	newChangeEventOrNull(Vote oldVote, Vote newVote) Either constructs an event to record the change that occured between oldVote and newVote; or returns null, if no significant change occured.
static StringBuilder	pollNameToXMLColonName(StringBuilder b) Converts a poll name to an XML name by replacing all instances of slashes '/' with colons ':'.
long	populationSize() The estimated number of eligible voters for this poll.
String	populationSizeExplanation() An explanation of the population size.
String	shortName() The short name of this poll, which is the part after the last slash '/' character.
File	startupConfigurationFile() The startup configuration file for this service.
String	summaryDescription() A short description that summarizes this service.
String	title() The title of this service in wiki-style title case.
InputTable	voterInputTable() The relational store of voter input for this service.
String	wgLogoImageLocation() The wiki logo (wgLogo) image location for this poll, or null if none is specified.
String	wgLogoLinkTarget() The wiki logo (wgLogo) link target for this poll.
static StringBuilder	xmlColonNameToPollName(StringBuilder b) Converts an XML name to a poll name by replacing all instances of colons ':' with slashes '/'.

Methods inherited from class VoterService

dispatch, equals, help, helpA_1, helpA_2, helpA_3, helpA, helpB, helpC, init, isNonPoll, lock, name, responderByClassName, responderForCommand, responders, serviceDirectory, toString, vsRun

Methods inherited from class java.lang.Object

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

Methods inherited from interface Poll

name

Field Detail

POLL_NAME_PATTERN

public static final Pattern POLL_NAME_PATTERN

The allowable pattern of a poll name. This imposes a further restriction on the basic name pattern of voter services, in that the first character must be an uppercase letter.

See Also:

VoterService.name(), VoterService.NAME_PATTERN, zelea.com/w/Category:Poll

Method Detail

configurationScript

@Warning(value="thread restricted object")
JavaScriptIncluder configurationScript()

The compiled configuration script for the poll.

See Also:

PollService.VoteServerScope.configurationFile()

countToReport

public Count countToReport()
                    throws IOException,
                           SQLException

The current count to report, or null if there is none.

Throws:

IOException

SQLException

See Also:

Count.VoteServerScope.readyToReportLink()

countToReportT

@ThreadSafe
public Count countToReportT()
                     throws IOException,
                            SQLException

Siezes the thread-access lock and returns the current count to report, or null if there is none. This is just a thread safe wrapper that automatically siezes and releases the lock.

Throws:

IOException

SQLException

divisionalComponents

@ThreadSafe
public Set<String> divisionalComponents()

The set of divisions whose members are exclusively eligible to vote in this poll. If the set is empty, then divisional membership is not an eligibility criterion. Divisions of the local pollwiki are specified by page name, while all others are specified by URL.

Returns:

unmodifiable set of zero or more pollwiki pagenames and/or URLs.

See Also:

PollService.ConstructionContext.addDivisionalComponent(String), zelea.com/w/Property:Division#Divisions

divisionPageName

@ThreadSafe
public String divisionPageName()

The polling division, specified by its pollwiki pagename.

Returns:

pollwiki pagename of division, or null if unspecified.

See Also:

PollService.ConstructionContext.setDivisionPageName(String), zelea.com/w/Property:Division

divisionSmallMapPageName

@ThreadSafe
public String divisionSmallMapPageName()

A small map of the polling division, specified by its pollwiki pagename.

Returns:

pollwiki pagename of division map, or null if unspecified.

See Also:

PollService.ConstructionContext.setDivisionSmallMapPageName(String), zelea.com/w/Property:Small_map

newChangeEventOrNull

public ActivityEvent newChangeEventOrNull(Vote oldVote,
                                 Vote newVote)

Either constructs an event to record the change that occured between oldVote and newVote; or returns null, if no significant change occured.

pollNameToXMLColonName

public static StringBuilder pollNameToXMLColonName(StringBuilder b)

Converts a poll name to an XML name by replacing all instances of slashes '/' with colons ':'. The result is valid for use in ID type attributes, but not for element names, or anywhere else the colon is reserved for namespacing.

Returns:

the same b.

See Also:

xmlColonNameToPollName(StringBuilder)

populationSize

@ThreadSafe
public long populationSize()

The estimated number of eligible voters for this poll.

Returns:

number of eligible voters, or zero if unknown.

See Also:

PollService.ConstructionContext.setPopulationSize(long), zelea.com/w/Property:Population size

populationSizeExplanation

@ThreadSafe
public String populationSizeExplanation()

An explanation of the population size.

See Also:

PollService.ConstructionContext.setPopulationSizeExplanation(String), zelea.com/w/Property:Population size explanation

shortName

@ThreadSafe
public final String shortName()

The short name of this poll, which is the part after the last slash '/' character. If there is no slash character, or if the name ends with one, then the short name is identical to the full name.

See Also:

VoterService.name

wgLogoImageLocation

@ThreadSafe
public String wgLogoImageLocation()

The wiki logo (wgLogo) image location for this poll, or null if none is specified.

See Also:

PollService.ConstructionContext.setWGLogoImageLocation(String), www.mediawiki.org/wiki/Manual:$wgLogo

wgLogoLinkTarget

@ThreadSafe
public String wgLogoLinkTarget()

The wiki logo (wgLogo) link target for this poll.

See Also:

PollService.ConstructionContext.setWGLogoLinkTarget(String), www.mediawiki.org/wiki/Manual:$wgLogo

xmlColonNameToPollName

public static StringBuilder xmlColonNameToPollName(StringBuilder b)

Converts an XML name to a poll name by replacing all instances of colons ':' with slashes '/'.

Returns:

the same b.

See Also:

pollNameToXMLColonName(StringBuilder)

compareTo

@ThreadSafe
public int compareTo(PollService p)

Compares based on caseless short name, cased short name, caseless full name, and finally cased full name.

Specified by:

compareTo in interface Comparable<PollService>

See Also:

VoterService.name(), shortName()

voterInputTable

@ThreadSafe
public InputTable voterInputTable()

Description copied from interface: InputStore

The relational store of voter input for this service. It is a table named "in_something", located in the vote-server's voter-input database.

Specified by:

voterInputTable in interface InputStore

See Also:

VoteServer.Run.database()

displayTitle

@ThreadSafe
public String displayTitle()

Description copied from interface: Poll

An informal, descriptive title for the poll in wiki-style title case, or null if there is none.

Specified by:

displayTitle in interface Poll

See Also:

PollService.ConstructionContext.setDisplayTitle(String)

issueType

@ThreadSafe
public String issueType()

Description copied from interface: Poll

The issue type of the poll, specified by the short name of its page in the pollwiki, i.e. without the namespace.

Specified by:

issueType in interface Poll

See Also:

PollService.ConstructionContext.setIssueType(String)

dispatch

public Exception dispatch(String[] argArray,
                 CommandResponder.Session commandSession)

Description copied from class: VoterService

Looks up the responder of the specified command, and sends the command to it. Or, if the look-up fails, replies that the command is unrecognized.

Overrides:

dispatch in class VoterService

Parameters:

argArray - an array containing the command name and arguments, per CommandResponder.respond(argv,session).

Returns:

any soft exception, per CommandResponder.respond(argv,session); or null if none occured.

See Also:

CommandResponder.respond(String[],CommandResponder.Session)

startupConfigurationFile

@ThreadSafe
public File startupConfigurationFile()

Description copied from class: VoterService

The startup configuration file for this service. The language is JavaScript. There are restrictions on the character encoding.

Specified by:

startupConfigurationFile in class VoterService

See Also:

PollService.VoteServerScope.configurationFile()

summaryDescription

@ThreadSafe
public String summaryDescription()

Description copied from class: VoterService

A short description that summarizes this service.

Specified by:

summaryDescription in class VoterService

See Also:

PollService.ConstructionContext.setSummaryDescription(String)

title

@ThreadSafe
public String title()

The title of this service in wiki-style title case. In English, that typically means only the first letter of the leading word is capitalized. The title is constructed from a combination of the name and the display title, if any.

Specified by:

title in class VoterService