ch.sahits.game.openpatrician.model.impl

Class WareHolding

java.lang.Object

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

Direct Known Subclasses:

City, TradingOffice

public abstract class WareHolding
extends Object

This class represents an entity that can hold wares which can be moved

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Dec 17, 2011

Property Summary

Type	Property and Description
javafx.beans.property.IntegerProperty	occupiedSpace Space occupied by some tenant

Field Summary

Fields

Modifier and Type	Field and Description
private AmountableProvider	amountableProvider
protected ComputablePriceV2	computablePrice
private javafx.beans.property.IntegerProperty	occupiedSpace Space occupied by some tenant
private LateIntegerBinding	storedAmountBinding Binding representing the current load.
(package private) NonReplacableMap<IWare,AmountablePrice<IWare>>	wares Store the amount of wares in the city in the ware specific sizes

Constructor Summary

Constructors

Constructor and Description
WareHolding()

Method Summary

Modifier and Type	Method and Description
protected void	addNewWare(IWare ware, int amount) Add a new ware to the wares list
protected void	bindStoredAmount(javafx.beans.property.ReadOnlyIntegerProperty amountProperty)
protected int	computeAVGPrice(IWare ware, int amount) Compute the average price for ware that is to be purchased in the specified amount.
protected boolean	containsWare(IWare ware) Check if there is an amountable object for this ware
int	getOccupiedSpace() Gets the value of the property occupiedSpace.
AmountablePrice<IWare>	getWare(IWare ware) Retrieve the AmountablePrice of the ware as it is stored in the holding
private int	internalStoredAmountCalculation() Calculate the stored amount.
int	move(IWare ware, int amount, ICitizen player) Move ware into this holding.
javafx.beans.property.IntegerProperty	occupiedSpaceProperty() Space occupied by some tenant
void	setOccupiedSpace(int occupiedSpace) Sets the value of the property occupiedSpace.
LateIntegerBinding	storedAmountBinding()
protected void	unbindAllAmounts()

Methods inherited from class java.lang.Object

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

Property Detail

occupiedSpace

public javafx.beans.property.IntegerProperty occupiedSpaceProperty

Space occupied by some tenant

See Also:

getOccupiedSpace(), setOccupiedSpace(int)

Field Detail

wares

final NonReplacableMap<IWare,AmountablePrice<IWare>> wares

Store the amount of wares in the city in the ware specific sizes

occupiedSpace

private final javafx.beans.property.IntegerProperty occupiedSpace

Space occupied by some tenant

computablePrice

@Autowired
protected ComputablePriceV2 computablePrice

amountableProvider

@Autowired
private AmountableProvider amountableProvider

storedAmountBinding

private LateIntegerBinding storedAmountBinding

Binding representing the current load.

Constructor Detail

WareHolding

public WareHolding()

Method Detail

addNewWare

protected void addNewWare(IWare ware,
                          int amount)

Add a new ware to the wares list

Parameters:

ware -

bindStoredAmount

protected void bindStoredAmount(javafx.beans.property.ReadOnlyIntegerProperty amountProperty)

unbindAllAmounts

protected void unbindAllAmounts()

getWare

public AmountablePrice<IWare> getWare(IWare ware)

Retrieve the AmountablePrice of the ware as it is stored in the holding

Parameters:

ware - to be retrieved

Returns:

AmountablePrice object

move

public int move(IWare ware,
                int amount,
                ICitizen 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.

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.

containsWare

protected final boolean containsWare(IWare ware)

Check if there is an amountable object for this ware

Parameters:

ware -

Returns:

computeAVGPrice

protected int computeAVGPrice(IWare ware,
                              int amount)

Compute the average price for ware that is to be purchased in the specified amount. The additional variable of the available amount is supplied by getWare(IWare). Subclasses may override this method.

Parameters:

ware - for which the average price is to be computed

amount - amount that is bought

Returns:

internalStoredAmountCalculation

private int internalStoredAmountCalculation()

Calculate the stored amount.

Returns:

storedAmountBinding

public LateIntegerBinding storedAmountBinding()

occupiedSpaceProperty

public javafx.beans.property.IntegerProperty occupiedSpaceProperty()

Space occupied by some tenant

See Also:

getOccupiedSpace(), setOccupiedSpace(int)

getOccupiedSpace

public int getOccupiedSpace()

Gets the value of the property occupiedSpace.

setOccupiedSpace

public void setOccupiedSpace(int occupiedSpace)

Sets the value of the property occupiedSpace.