org.spectrumauctions.sats.core.model

Class World

java.lang.Object

org.spectrumauctions.sats.core.model.World

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BMWorld, CATSWorld, GSVMWorld, LSVMWorld, MRVMWorld, SRVMWorld

public abstract class World
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	id
protected String	modelName

Constructor Summary

Constructors

Constructor and Description
World(String modelName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getId()
abstract Set<? extends Good>	getLicenses()
String	getModelName()
abstract int	getNumberOfGoods()
int	hashCode()
protected long	openNewPopulation()
abstract void	refreshFieldBackReferences() Some of the members of the World (e.g.
protected <T extends Bidder<?>> Collection<T>	restorePopulation(Class<T> type, long populationId)
<T extends Bidder<?>> Collection<T>	restorePopulation(Class<T> type, long populationId, InstanceHandler storageHandler) Advanced way to restore serialized Bidder instances, allowing to specify a custom InstanceHandler For most use cases, it's recommended to use BMWorld.restorePopulation(long).
abstract Collection<? extends Bidder<?>>	restorePopulation(long populationId) Restore serialized Bidder instances via population id
protected void	store()

Methods inherited from class java.lang.Object

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

Field Detail

modelName

protected final String modelName

id

protected final long id

Constructor Detail

World

public World(String modelName)

Method Detail

getModelName

public String getModelName()

getId

public long getId()

getNumberOfGoods

public abstract int getNumberOfGoods()

getLicenses

public abstract Set<? extends Good> getLicenses()

store

protected void store()

openNewPopulation

protected long openNewPopulation()

restorePopulation

public abstract Collection<? extends Bidder<?>> restorePopulation(long populationId)

Restore serialized Bidder instances via population id

Parameters:

populationId - the population id

Returns:

the deserialized bidders

restorePopulation

public <T extends Bidder<?>> Collection<T> restorePopulation(Class<T> type,
                                                             long populationId,
                                                             InstanceHandler storageHandler)

Advanced way to restore serialized Bidder instances, allowing to specify a custom InstanceHandler
For most use cases, it's recommended to use BMWorld.restorePopulation(long).

Note: Bidders and World must have been serialized before, either during construction (by having set InstanceHandler.setDefaultHandler(InstanceHandler) to an appropriate handler or by manually storing them with an InstanceHandler afterwards. Restoring (deserialization) has to be done with the same type of InstanceHandler as the serialization.

Parameters:

type - the bidder type

populationId - the population id

storageHandler - the instance handler

Returns:

the deserialized bidders

restorePopulation

protected <T extends Bidder<?>> Collection<T> restorePopulation(Class<T> type,
                                                                long populationId)

refreshFieldBackReferences

public abstract void refreshFieldBackReferences()

Some of the members of the World (e.g. licenses) have circular references back to the world.
As the used gsonSerializer cannot handle this yet, the circular references are not serialized and have to be restored after deserialization by calling this method.

This method will be removed in a later version and the problem be solved during deserialization.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object