ch.sahits.game.openpatrician.model.city.impl

Class City

java.lang.Object

ch.sahits.game.openpatrician.model.impl.WareHolding

ch.sahits.game.openpatrician.model.city.impl.City

All Implemented Interfaces:

ICity, ICreditor

public class City
extends WareHolding
implements ICity

Implementation of the city model. The model of the city should only be instanciated once. A city is unique. therefore equality can be tested by identity.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Jan 18, 2011

Property Summary

Properties inherited from class ch.sahits.game.openpatrician.model.impl.WareHolding

occupiedSpaceProperty

Field Summary

Fields

Modifier and Type	Field and Description
private List<IBuilding>	buildings Store the buildings in the city
private CityState	cityState
private javafx.geometry.Point2D	coordinates
private Date	date
private IWare[]	effectiveProduction
private IWare[]	ineffectiveProduction
private PlayerInteractionFactory	interactionFactory
private EKontorType	kontorType
private Locale	locale
private org.apache.log4j.Logger	logger
private org.springframework.context.MessageSource	messageSource
private Map<IWare,org.joda.time.DateTime>	missingWares
private String	name
private String	nameTemplate
private Map<IPlayer,Contributions>	playersContributions Store the contibutions of the players
private Map<EPopulationClass,javafx.beans.property.IntegerProperty>	population Holding the population split by population classes
private Map<IPlayer,IReputation>	reputation Map holding the reputation of the different players
private Random	rnd
private LateIntegerBinding	totalPopulation

Constructor Summary

Constructors

Constructor and Description
City(City city)
City(String configFileName) This Constructor is used by tests

Method Summary

Methods

Modifier and Type	Method and Description
void	build(IBuilding building) Add a new building to the city
private int	calculateInitialBeggarCount(int totalPopulation)
List<IBuilding>	getBuildings() Retrieve a list of all buildings in the city.
int	getContribution(IPlayer player, IWare ware) Check out what the player contributed to the ware
Map<IWare,org.joda.time.DateTime>	getMissingWares() Retrieve the missing wares along with their times
int	getPopulation(EPopulationClass popclass) Retrieve the population count for a class
javafx.beans.binding.IntegerBinding	getPopulationBinding() Retrieve the binding of the city's total population.
javafx.beans.property.IntegerProperty	getPopulationProperty(EPopulationClass popclass) Retrieve the population count for a class
IReputation	getReputation(IPlayer player) Retrieve the reputation of the player in the city
List<IPlayer>	getResidentPlayers() Retrieve all the players that have a office in this city.
ESocialRank	getSocialRank() Retrieve the social rank in this city
String	getUniqueID() Retrieve the unique ID of the city.
private void	init()
private void	initPopulation() Initialize the population of the different classes based on the properties
protected void	initWares() Init the amount of wares available in the city This method is protected so it can be overriden by subclasses for testing
private int	internalPopulationCount() Count the population.
int	move(IWare ware, int amount, IPlayer player) Move ware into this holding.
void	moveIn(IPlayer player) Add a player to the city
void	setPopulation(int population, EPopulationClass popClass) Set the population count for a apopulation class
void	tearDown(IBuilding building) Remove a building from the list of buildings in the city

Methods inherited from class ch.sahits.game.openpatrician.model.impl.WareHolding

addNewWare, computeAVGPrice, containsWare, getOccupiedSpace, getWare, occupiedSpaceProperty, setOccupiedSpace, storedAmountBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.sahits.game.openpatrician.model.city.ICity

getCityState, getCoordinates, getEffectiveProduction, getIneffectiveProduction, getKontorType, getName, getWare, setCityState

Field Detail

logger

private final org.apache.log4j.Logger logger

rnd

@Autowired
private Random rnd

effectiveProduction

private final IWare[] effectiveProduction

ineffectiveProduction

private final IWare[] ineffectiveProduction

name

private String name

nameTemplate

private final String nameTemplate

kontorType

private final EKontorType kontorType

interactionFactory

@Autowired
private PlayerInteractionFactory interactionFactory

locale

@Autowired
private Locale locale

messageSource

@Autowired
private org.springframework.context.MessageSource messageSource

coordinates

private final javafx.geometry.Point2D coordinates

missingWares

private final Map<IWare,org.joda.time.DateTime> missingWares

buildings

private List<IBuilding> buildings

Store the buildings in the city

reputation

private Map<IPlayer,IReputation> reputation

Map holding the reputation of the different players

playersContributions

private Map<IPlayer,Contributions> playersContributions

Store the contibutions of the players

population

private final Map<EPopulationClass,javafx.beans.property.IntegerProperty> population

Holding the population split by population classes

totalPopulation

private LateIntegerBinding totalPopulation

cityState

private CityState cityState

date

@Autowired
private Date date

Constructor Detail

City

public City(City city)

City

City(String configFileName)
throws IOException

This Constructor is used by tests

Throws:

IOException

Method Detail

init

@PostConstruct
private void init()

initWares

protected void initWares()

Init the amount of wares available in the city This method is protected so it can be overriden by subclasses for testing

initPopulation

private void initPopulation()

Initialize the population of the different classes based on the properties

calculateInitialBeggarCount

private int calculateInitialBeggarCount(int totalPopulation)

internalPopulationCount

private int internalPopulationCount()

Count the population.

Returns:

getPopulationBinding

public javafx.beans.binding.IntegerBinding getPopulationBinding()

Description copied from interface: ICity

Retrieve the binding of the city's total population.

Specified by:

getPopulationBinding in interface ICity

Returns:

setPopulation

public void setPopulation(int population,
                 EPopulationClass popClass)

Set the population count for a apopulation class

Specified by:

setPopulation in interface ICity

Parameters:

population - count

popClass - population class

getPopulation

public int getPopulation(EPopulationClass popclass)

Retrieve the population count for a class

Specified by:

getPopulation in interface ICity

Parameters:

popclass - population class

Returns:

getPopulationProperty

public javafx.beans.property.IntegerProperty getPopulationProperty(EPopulationClass popclass)

Description copied from interface: ICity

Retrieve the population count for a class

Specified by:

getPopulationProperty in interface ICity

Parameters:

popclass - population class

Returns:

getBuildings

public List<IBuilding> getBuildings()

Description copied from interface: ICity

Retrieve a list of all buildings in the city. The list is immutable

Specified by:

getBuildings in interface ICity

Returns:

build

public void build(IBuilding building)

Add a new building to the city

Specified by:

build in interface ICity

Parameters:

building -

tearDown

public void tearDown(IBuilding building)

Remove a building from the list of buildings in the city

Specified by:

tearDown in interface ICity

Parameters:

building -

getReputation

public IReputation getReputation(IPlayer player)

Description copied from interface: ICity

Retrieve the reputation of the player in the city

Specified by:

getReputation in interface ICity

Returns:

moveIn

public void moveIn(IPlayer player)

Description copied from interface: ICity

Add a player to the city

Specified by:

moveIn in interface ICity

getSocialRank

public ESocialRank getSocialRank()

Description copied from interface: ICity

Retrieve the social rank in this city

Specified by:

getSocialRank in interface ICity

Returns:

move

public int move(IWare ware,
       int amount,
       IPlayer player)

Move ware into this holding. The player may be null and is not used in this base implementation, but subclasses may be interested for statistical reasons. This method is thread save. Update the contributions as the ware is moved

Specified by:

move in interface ICity

Overrides:

move in class WareHolding

Parameters:

ware - to be moved

amount - of the ware that is moved

player - that initiates the moving, may be null, e.g. if the moving is initiated by a city

Returns:

the effective amount that was moved. The amount may be positive if something was added, negative if the ware was removed from the holding or zero if nothing was moved.

getContribution

public int getContribution(IPlayer player,
                  IWare ware)

Description copied from interface: ICity

Check out what the player contributed to the ware

Specified by:

getContribution in interface ICity

Parameters:

player - whose contribution is to be checked

ware - that is checked for contribution

Returns:

amount of the contribution may also be negative

getMissingWares

public Map<IWare,org.joda.time.DateTime> getMissingWares()

Description copied from interface: ICity

Retrieve the missing wares along with their times

Specified by:

getMissingWares in interface ICity

Returns:

getResidentPlayers

public List<IPlayer> getResidentPlayers()

Description copied from interface: ICity

Retrieve all the players that have a office in this city.

Specified by:

getResidentPlayers in interface ICity

Returns:

immutable list

getUniqueID

public String getUniqueID()

Description copied from interface: ICity

Retrieve the unique ID of the city.

Specified by:

getUniqueID in interface ICity

Returns: