genius.core.config

Class MultilateralTournamentConfiguration

java.lang.Object

genius.core.config.MultilateralTournamentConfiguration

All Implemented Interfaces:

MultilateralTournamentConfigurationInterface

public class MultilateralTournamentConfiguration
extends java.lang.Object
implements MultilateralTournamentConfigurationInterface

Implementation of MultilateralTournamentConfigurationInterface. This stores all information for a multilateral tournament. Can load(File) and #save(File) to XML. Immutable. This object can also be deserialized. Therefore we set default values in optional fields

Constructor Summary

Constructors

Constructor and Description

MultilateralTournamentConfiguration(MultiPartyProtocolRepItem protocol, Deadline deadline2, PartyRepItem mediator, java.util.List<ParticipantRepItem> parties, java.util.List<ProfileRepItem> profiles, java.util.List<ParticipantRepItem> partiesB, java.util.List<ProfileRepItem> profilesB, int nrepeats, int nparties, boolean repeatParties, boolean isRandomSessionOrder, PersistentDataType type, boolean enablePrint)

Method Summary

Modifier and Type	Method and Description
Deadline	getDeadline()
PartyRepItem	getMediator()
int	getNumPartiesPerSession()
java.util.List<ParticipantRepItem>	getPartyBItems()
java.util.List<ParticipantRepItem>	getPartyItems() read-only list of party repository items.
PersistentDataType	getPersistentDataType()
java.util.List<ProfileRepItem>	getProfileBItems()
java.util.List<ProfileRepItem>	getProfileItems() Gets read-only list of profiles used by the parties.
MultiPartyProtocolRepItem	getProtocolItem() Gets the protocol to run
int	getRepeats() Gets the number of times to run the tournament.
boolean	isPrintEnabled()
boolean	isRandomSessionOrder()
boolean	isRepetitionAllowed() Gets whether repetition is allowed when generating combinations of agents.
static MultilateralTournamentConfiguration	load(java.io.File file) Load a new MultilateralTournamentConfiguration from file.
void	save(java.io.OutputStream outstream) Save this to output

Methods inherited from class java.lang.Object

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

Constructor Detail

MultilateralTournamentConfiguration

public MultilateralTournamentConfiguration(MultiPartyProtocolRepItem protocol,
                                           Deadline deadline2,
                                           PartyRepItem mediator,
                                           java.util.List<ParticipantRepItem> parties,
                                           java.util.List<ProfileRepItem> profiles,
                                           java.util.List<ParticipantRepItem> partiesB,
                                           java.util.List<ProfileRepItem> profilesB,
                                           int nrepeats,
                                           int nparties,
                                           boolean repeatParties,
                                           boolean isRandomSessionOrder,
                                           PersistentDataType type,
                                           boolean enablePrint)

Method Detail

getProtocolItem

public MultiPartyProtocolRepItem getProtocolItem()

Description copied from interface: MultilateralTournamentConfigurationInterface

Gets the protocol to run

Specified by:

getProtocolItem in interface MultilateralTournamentConfigurationInterface

Returns:

the protocol to run

getMediator

public PartyRepItem getMediator()

Specified by:

getMediator in interface MultilateralTournamentConfigurationInterface

Returns:

The mediator in use. ignored if protocol does not use mediator. Must be non-null if protocol needs mediator.

getDeadline

public Deadline getDeadline()

Specified by:

getDeadline in interface MultilateralTournamentConfigurationInterface

Returns:

Deadline for all sessions.

getPartyItems

public java.util.List<ParticipantRepItem> getPartyItems()

Description copied from interface: MultilateralTournamentConfigurationInterface

read-only list of party repository items. This may include mediator(s)

Specified by:

getPartyItems in interface MultilateralTournamentConfigurationInterface

Returns:

a list of all chosen parties. Only a sub-set of the non-mediators will be used in each session, see also MultilateralTournamentConfigurationInterface.getNumPartiesPerSession()

getProfileItems

public java.util.List<ProfileRepItem> getProfileItems()

Description copied from interface: MultilateralTournamentConfigurationInterface

Gets read-only list of profiles used by the parties. These protocols are used to generate the sessions. The number of available items determines the maximum number of parties in one session.

Specified by:

getProfileItems in interface MultilateralTournamentConfigurationInterface

Returns:

list of profiles used by the parties

getPartyBItems

public java.util.List<ParticipantRepItem> getPartyBItems()

Specified by:

getPartyBItems in interface MultilateralTournamentConfigurationInterface

Returns:

a pool of parties for side B . This is only used if not empty and if MultilateralTournamentConfigurationInterface.getNumPartiesPerSession() =2.

getProfileBItems

public java.util.List<ProfileRepItem> getProfileBItems()

Specified by:

getProfileBItems in interface MultilateralTournamentConfigurationInterface

Returns:

a pool of profiles for side B. Must be non empty if MultilateralTournamentConfigurationInterface.getPartyBItems() is not empty.

getRepeats

public int getRepeats()

Description copied from interface: MultilateralTournamentConfigurationInterface

Gets the number of times to run the tournament.

Specified by:

getRepeats in interface MultilateralTournamentConfigurationInterface

Returns:

the number of tournaments

getNumPartiesPerSession

public int getNumPartiesPerSession()

Specified by:

getNumPartiesPerSession in interface MultilateralTournamentConfigurationInterface

Returns:

the number of parties (excluding mediators) per session. This can be smaller than size of MultilateralTournamentConfigurationInterface.getPartyItems(), then subsets of the party items will be used in each session.

isRepetitionAllowed

public boolean isRepetitionAllowed()

Description copied from interface: MultilateralTournamentConfigurationInterface

Gets whether repetition is allowed when generating combinations of agents.

Specified by:

isRepetitionAllowed in interface MultilateralTournamentConfigurationInterface

Returns:

true if allowed

isRandomSessionOrder

public boolean isRandomSessionOrder()

Specified by:

isRandomSessionOrder in interface MultilateralTournamentConfigurationInterface

Returns:

true if the sessions inside a tournament must be randomized.

load

public static MultilateralTournamentConfiguration load(java.io.File file)
                                                throws javax.xml.bind.JAXBException

Load a new MultilateralTournamentConfiguration from file.

Parameters:

file - the file to load from

Returns:

the new MultilateralTournamentConfiguration.

Throws:

javax.xml.bind.JAXBException

save

public void save(java.io.OutputStream outstream)

Save this to output

Parameters:

outstream - the outputstream to write to

getPersistentDataType

public PersistentDataType getPersistentDataType()

Specified by:

getPersistentDataType in interface MultilateralTournamentConfigurationInterface

Returns:

the persistent data setting for this tournament.

isPrintEnabled

public boolean isPrintEnabled()

Specified by:

isPrintEnabled in interface MultilateralTournamentConfigurationInterface

Returns:

true iff print (using System.out.println) is enabled. If not, it is suppressed.