votorola.a.trust

Class NetworkTrace

java.lang.Object

NetworkTrace

All Implemented Interfaces:

Serializable

@ThreadSafe
public final class NetworkTrace
extends Object
implements Serializable

A completed trace of a neigbourhood trust network, which also serves as a residential voter register and (till we start aggregating multiple registers) a simple voter list. To query for a registrant's membership in electoral districts and other divisions:

     Set divisionSet = trace.membershipTable().divisionSet(
       registrant.email() );

Other registration properties are lumped together in a single trace node, one per registrant. To obtain the registrant's trace node:

     TraceNode traceNode = trace.traceNodeTable().getOrCreate( registrant );

Most of the registration properties are set by intermediation of the local administrator's votrace.js script.

See Also:

Working example of votrace.js, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkTrace.VoteServerScope API for all traces of trust networks within the scope of a vote-server.

Constructor Summary

Constructors

Constructor and Description
NetworkTrace(ReadyDirectory _readyDirectory) Partially constructs a NetworkTrace.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	init(Membership.Table _membershipTable, TraceNodeW.Table _traceNodeTable) Completes the construction of a new VoterList.
(package private) boolean	isObjectReadFromSerialFile(ReadyDirectory newReadyDirectory) Returns true if this trace is probably in sync with the serial file of the specified ready directory; false if that file has since been modified or deleted.
Membership.Table	membershipTable() The relational store of memberships that (in part) backs this trace, if known.
static NetworkTrace	readObjectFromSerialFile(ReadyDirectory readyDirectory)
ReadyDirectory	readyDirectory() The file part of the backing for this trace.
TraceNodeW.Table	traceNodeTable() The relational store of trace nodes that (in part) backs this trace, if known.
(package private) void	writeObjectToSerialFile()

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkTrace

NetworkTrace(ReadyDirectory _readyDirectory)

Partially constructs a NetworkTrace.

See Also:

init(Membership.Table,TraceNodeW.Table)

Method Detail

init

@ThreadRestricted(value="constructor")
void init(Membership.Table _membershipTable,
                              TraceNodeW.Table _traceNodeTable)

Completes the construction of a new VoterList.

isObjectReadFromSerialFile

boolean isObjectReadFromSerialFile(ReadyDirectory newReadyDirectory)

Returns true if this trace 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 trace was never originally deserialized from that file path.

See Also:

readObjectFromSerialFile(ReadyDirectory)

readObjectFromSerialFile

public static NetworkTrace readObjectFromSerialFile(ReadyDirectory readyDirectory)

writeObjectToSerialFile

final void writeObjectToSerialFile()
                            throws IOException

Throws:

IOException

membershipTable

public Membership.Table membershipTable()

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

Returns:

reference to relational store; or null, if the trace was not initialized with a reference

See Also:

VoteServer.Run.database(), init(Membership.Table,TraceNodeW.Table)

traceNodeTable

public TraceNodeW.Table traceNodeTable()

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

Returns:

reference to relational store; or null, if the trace was not initialized with a reference

See Also:

VoteServer.Run.database(), init(Membership.Table,TraceNodeW.Table)

readyDirectory

public ReadyDirectory readyDirectory()

The file part of the backing for this trace.