votorola.a.trust

Class Registration

java.lang.Object

Registration

All Implemented Interfaces:

Serializable, TraceNode

@ThreadRestricted(value="single writer, readers touch")
public final class Registration
extends Object
implements TraceNode

A snapshot of a registrant's input to the voter registry, as transferred from the streetwiki. It is a precursor to a trace node, which it partially implements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Registration.SnapshotContext A context for taking a snapshot of a registration.

Constructor Summary

Constructors

Constructor and Description
Registration(IDPair _registrant) Creates a Registration with all variable items at default values.
Registration(XMLStreamReader r) Constructs a Registration from its XML serialization.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDivision(String div) Adds a division.
void	addTruster(IDPair newTruster) Adds a new trust source, if not already present.
void	addTrusterByUsername(String u) Adds a new trust source by username, if not already present.
Set<String>	divisions() The set of divisions of which the registrant is a member.
String	getArea() The registrant's local area of residence, or null if unspecified.
String	getCountryCode() The registrant's country of residence in ISO_3166-1 alpha-2 form, or null if unspecified.
String	getGeohandle() The normalized, geo-locatable address string for the registrant's primary residential address.
String	getOtherProperties() Other registration properties.
int	primaryTrustEdgeCount() Throws UnsupportedOperationException.
IDPair	registrant() The registrant.
void	removeTruster(IDPair oldTruster) Removes a trust source, if found.
void	setArea(String newArea)
void	setCountryCode(String newCountryCode)
void	setGeohandle(String newGeohandle)
void	setOtherProperties(String newOtherProperties) Sets the other registration properties.
(package private) static void	toCommonXMLAttributes(TraceNode node, VoterInputTable.XMLColumnAppender aC) Serializes the common attributes of a registration in XML format.
(package private) static void	toCommonXMLElements(Set<String> divisions, VoterInputTable.XMLColumnAppender aC) Serializes the common elements of a registration in XML format.
String	toString() Returns the registrant's username.
void	toXML(VoterInputTable.XMLColumnAppender aC) Serializes this registration in XML format.
List<IDPair>	trusters() The list of trust sources for the registrant (destination).
int	trustLevel() Throws UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Constructor Detail

Registration

public Registration(IDPair _registrant)

Creates a Registration with all variable items at default values.

Registration

Registration(XMLStreamReader r)
       throws AddressException,
              XMLStreamException

Constructs a Registration from its XML serialization.

Parameters:

r - the reader having just read the 'in' start element.

Throws:

AddressException

XMLStreamException

See Also:

toXML(votorola.a.VoterInputTable.XMLColumnAppender)

Method Detail

divisions

public Set<String> divisions()

The set of divisions of which the registrant is a member. The divisions that are defined in the local wiki are specified by page name, while others are specicified by remote URL.

Returns:

unmodifiable set of zero or more wiki pagenames and/or URLs

See Also:

addDivision(String), zelea.com/w/Property:Division

addDivision

@ThreadRestricted(value="constructor")
public void addDivision(String div)

Adds a division.

See Also:

divisions()

toCommonXMLAttributes

@ThreadSafe
static void toCommonXMLAttributes(TraceNode node,
                                    VoterInputTable.XMLColumnAppender aC)
                           throws IOException

Serializes the common attributes of a registration in XML format. These are the attributes that are identical for serializing both snapshot input and mounted output.

Throws:

BadInputException

IOException

toCommonXMLElements

@ThreadSafe
static void toCommonXMLElements(Set<String> divisions,
                                  VoterInputTable.XMLColumnAppender aC)
                         throws IOException

Serializes the common elements of a registration in XML format. These are the attributes that are identical for serializing both snapshot input and mounted output.

Throws:

BadInputException

IOException

toXML

public void toXML(VoterInputTable.XMLColumnAppender aC)
           throws IOException

Serializes this registration in XML format.

Throws:

BadInputException

IOException

trusters

public List<IDPair> trusters()

The list of trust sources for the registrant (destination). When the trust network is traced, a trust edge will be extended from each source.

See Also:

TrustEdge

addTruster

public void addTruster(IDPair newTruster)

Adds a new trust source, if not already present.

Parameters:

newTruster - the trust source.

See Also:

trusters()

addTrusterByUsername

public void addTrusterByUsername(String u)
                          throws AddressException

Adds a new trust source by username, if not already present. This is a convenience method.

Throws:

AddressException

See Also:

addTruster(IDPair)

removeTruster

public void removeTruster(IDPair oldTruster)

Removes a trust source, if found.

Parameters:

oldTruster - the trust source.

See Also:

trusters()

getArea

public final String getArea()

Description copied from interface: TraceNode

The registrant's local area of residence, or null if unspecified. This is used only for multi-area streetwikis.

Specified by:

getArea in interface TraceNode

See Also:

setArea(String)

setArea

public final void setArea(String newArea)

See Also:

getArea()

getCountryCode

public final String getCountryCode()

Description copied from interface: TraceNode

The registrant's country of residence in ISO_3166-1 alpha-2 form, or null if unspecified.

Specified by:

getCountryCode in interface TraceNode

See Also:

setCountryCode(String)

setCountryCode

public final void setCountryCode(String newCountryCode)

See Also:

getCountryCode()

getGeohandle

public final String getGeohandle()

Description copied from interface: TraceNode

The normalized, geo-locatable address string for the registrant's primary residential address.

Specified by:

getGeohandle in interface TraceNode

Returns:

geohandle, or null if unknown.

See Also:

setGeohandle(String)

setGeohandle

public final void setGeohandle(String newGeohandle)

See Also:

getGeohandle()

getOtherProperties

public final String getOtherProperties()

Description copied from interface: TraceNode

Other registration properties. These are formatted as an XML element named 'other', which may have any content. The content is set by intermediation of the local administrator's votrace.js script.

Specified by:

getOtherProperties in interface TraceNode

Returns:

XML element named 'other'; or null, if there are no other properties

See Also:

setOtherProperties(String)

setOtherProperties

public final void setOtherProperties(String newOtherProperties)

Sets the other registration properties. Owing to how value is serialized, it must not contain a double quote (") character.

See Also:

getOtherProperties()

primaryTrustEdgeCount

public final int primaryTrustEdgeCount()

Throws UnsupportedOperationException.

Specified by:

primaryTrustEdgeCount in interface TraceNode

registrant

public IDPair registrant()

Description copied from interface: TraceNode

The registrant.

Specified by:

registrant in interface TraceNode

trustLevel

public final int trustLevel()

Throws UnsupportedOperationException.

Specified by:

trustLevel in interface TraceNode

toString

public final String toString()

Returns the registrant's username.

Overrides:

toString in class Object