ch.sahits.game.openpatrician.engine.player

Class BasePlayerTradeStrategy

java.lang.Object

ch.sahits.game.openpatrician.engine.player.BasePlayerTradeStrategy

All Implemented Interfaces:

ch.sahits.game.openpatrician.model.player.IAITradeStrategy

Direct Known Subclasses:

CheapProductionTradeStrategy, ProductionChainTradeStrategy, SupplyHometownAIStrategy, TradeRouteTradeStrategy

public abstract class BasePlayerTradeStrategy
extends Object
implements ch.sahits.game.openpatrician.model.player.IAITradeStrategy

Base implementation of the trading strategy. The base strategy maintains a list of TradeSteps, that are executed in order. Once the list is empty the next steps need to be defined. It might be that the last executed step complets a trade cycle and the next step would be the repetition of the first.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BasePlayerTradeStrategy.WareNeedComparator

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.context.ApplicationContext	context
private org.apache.logging.log4j.Logger	logger
private ch.sahits.game.openpatrician.model.map.IMap	map
private MapService	mapService
protected ch.sahits.game.openpatrician.model.player.IAITradeStrategyType	tradeStrategyType

Constructor Summary

Constructors

Constructor and Description
BasePlayerTradeStrategy()

Method Summary

Modifier and Type	Method and Description
void	append(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.product.ITradeStep step) Add a new trade step for a player.
protected void	clearRemainingTradeSteps(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.IAIPlayer player) Remove any remaining trade steps.
protected AggregatedBuyTradeStep	createAggregatedBuyTradeStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity city, List<ch.sahits.game.openpatrician.model.product.IWare> waresToBuy)
protected AggregatesDumpTradeStep	createAggregatedDumpStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity city, List<ch.sahits.game.openpatrician.model.product.IWare> waresToSell)
protected AggregatesSellTradeStep	createAggregatedSellStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity city, List<ch.sahits.game.openpatrician.model.product.IWare> waresToSell)
protected TakeLoanTradeStep	createCheckAndTakeLoanStep(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.city.ICity city) Create a new instance of the TakeLoan trade step.
protected CheckForRepairTradeStep	createCheckRepairStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity city) Create the trade step to check for repairs.
protected HireSailorsStep	createHireSailorStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity city) Create a new instance forthe hire sailor step.
protected TravelToTradeStep	createTravelToStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.city.ICity travelToCity) Create the travel step to a different city.
boolean	executeTradeSteps(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel) The implementation of the execute trade steps makes the following assumptions: When called there is at least one trade step defined Typically the trade steps are defined up to the travel step.
protected ch.sahits.game.openpatrician.model.city.ICity	findNextStop(ch.sahits.game.openpatrician.model.city.ICity baseTown, ch.sahits.game.openpatrician.model.player.IProductionConsumptionKnowledge knowledge, List<ch.sahits.game.openpatrician.model.product.IWare> waresOfInterest, ch.sahits.game.openpatrician.model.city.ICity exclude) Figure out what the next stop should be to supply the ware in the list waresOfInterest.
protected ArrayList<ch.sahits.game.openpatrician.model.product.IWare>	findWaresOfInterest(List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>> sortedNeeds)
protected List<ch.sahits.game.openpatrician.model.product.IWare>	getLoadedWares(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel) Find all wares that are loaded on the ship.
List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>>	getMostNeededWares(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge) Figure out the ware that are most needed in the city.
List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>>	getMostNeededWares(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel) Figure out the ware that are most needed in the city.
ch.sahits.game.openpatrician.model.product.ITradeStep	getNextStep(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel) Retrieve the next trade step that should be executed and remove it from the list of an AI player.
protected List<ch.sahits.game.openpatrician.model.product.IWare>	getWaresNeedIn(ch.sahits.game.openpatrician.model.player.IProductionConsumptionKnowledge knowledge, ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledgeCurrentTown, ch.sahits.game.openpatrician.model.city.ICity nextStop) Figure out what wares are needed in nextStop, that can be provided in the current town.
void	handleHireSailors(HireSailorEvent event) Andling the hiring of sailors.
void	handleRepairFinished(RepairFinishedEvent event) Handle the event of the ship coming back from repair and the trade steps have to be picked up again.
boolean	hasMoreTradeSteps(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel) Check whether the AI player has more trade steps
void	inject(ch.sahits.game.openpatrician.model.IAIPlayer player, ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.model.product.ITradeStep step) Add a new trade step to the begining of the list.
protected boolean	isMatchingTradeStrategy(ch.sahits.game.openpatrician.model.IAIPlayer player)
boolean	isNeeded(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge, ch.sahits.game.openpatrician.model.product.IWare ware) Check if the ware is needed in a city.

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.player.IAITradeStrategy

handleShipArrivesInPort, initialzeTradeCycle

Field Detail

logger

private final org.apache.logging.log4j.Logger logger

context

@Autowired
private org.springframework.context.ApplicationContext context

map

@Autowired
private ch.sahits.game.openpatrician.model.map.IMap map

mapService

@Autowired
private MapService mapService

tradeStrategyType

protected ch.sahits.game.openpatrician.model.player.IAITradeStrategyType tradeStrategyType

Constructor Detail

BasePlayerTradeStrategy

public BasePlayerTradeStrategy()

Method Detail

isMatchingTradeStrategy

protected boolean isMatchingTradeStrategy(ch.sahits.game.openpatrician.model.IAIPlayer player)

getNextStep

public ch.sahits.game.openpatrician.model.product.ITradeStep getNextStep(ch.sahits.game.openpatrician.model.IAIPlayer player,
                                                                         ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel)

Retrieve the next trade step that should be executed and remove it from the list of an AI player.

Parameters:

player - on witch to retrieve the next task

Returns:

hasMoreTradeSteps

public boolean hasMoreTradeSteps(ch.sahits.game.openpatrician.model.IAIPlayer player,
                                 ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel)

Check whether the AI player has more trade steps

Parameters:

player - on which to check

Returns:

append

public void append(ch.sahits.game.openpatrician.model.IAIPlayer player,
                   ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                   ch.sahits.game.openpatrician.model.product.ITradeStep step)

Add a new trade step for a player.

Parameters:

player - for which to add the trade step

step - to be added.

inject

public void inject(ch.sahits.game.openpatrician.model.IAIPlayer player,
                   ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                   ch.sahits.game.openpatrician.model.product.ITradeStep step)

Add a new trade step to the begining of the list.

Parameters:

player - for which to add the trade step

step - to be added.

vessel -

getMostNeededWares

public List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>> getMostNeededWares(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge)

Figure out the ware that are most needed in the city. The need is calculated upon the knowledge of the production, consumption and sotred amount. If a ware is not consumed at all it is not needed at all, compared to wares that have more consumption than stored + produced.

Parameters:

knowledge - base knowledge

Returns:

sorted list Pair of wares and their importants. The lower the number the more important.

isNeeded

public boolean isNeeded(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge,
                        ch.sahits.game.openpatrician.model.product.IWare ware)

Check if the ware is needed in a city.

Parameters:

knowledge - of the city that should be checked.

ware - for which should be checked.

Returns:

true if there is not much of the ware around.

getMostNeededWares

public List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>> getMostNeededWares(ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledge,
                                                                                                          ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel)

Figure out the ware that are most needed in the city. The need is calculated upon the knowledge of the production, consumption and sotred amount. If a ware is not consumed at all it is not needed at all, compared to wares that have more consumption than stored + produced. Also consider the amount of that ware that is loaded on the vessel. That ware is treated the same way as if it stored in the city, with the effect that on the first call the most needed ware might be BEER, but once an amount is bought the most needed ware might change.

Parameters:

knowledge - base knowledge

vessel - on which the wares are loaded.

Returns:

sorted list Pair of wares and their importants. The lower the number the more important.

getWaresNeedIn

protected List<ch.sahits.game.openpatrician.model.product.IWare> getWaresNeedIn(ch.sahits.game.openpatrician.model.player.IProductionConsumptionKnowledge knowledge,
                                                                                ch.sahits.game.openpatrician.model.player.ICityProductionConsumptionKnowledge knowledgeCurrentTown,
                                                                                ch.sahits.game.openpatrician.model.city.ICity nextStop)

Figure out what wares are needed in nextStop, that can be provided in the current town.

Parameters:

knowledge - base knowledge

knowledgeCurrentTown - knowledge of the current town

nextStop - stop of the next city.

Returns:

list of wares that can be delivered from the current city to the nextStop

findNextStop

protected ch.sahits.game.openpatrician.model.city.ICity findNextStop(ch.sahits.game.openpatrician.model.city.ICity baseTown,
                                                                     ch.sahits.game.openpatrician.model.player.IProductionConsumptionKnowledge knowledge,
                                                                     List<ch.sahits.game.openpatrician.model.product.IWare> waresOfInterest,
                                                                     ch.sahits.game.openpatrician.model.city.ICity exclude)

Figure out what the next stop should be to supply the ware in the list waresOfInterest. This list is ordered so that wares in the front are more important.

Parameters:

baseTown - city from which the travel starts

knowledge - data

waresOfInterest - ordered list of needed wares

exclude - city to which should not be traveled.

Returns:

City that can provide at least some of the wares and is not to far away.

createTravelToStep

protected TravelToTradeStep createTravelToStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                               ch.sahits.game.openpatrician.model.city.ICity travelToCity)

Create the travel step to a different city.

Parameters:

vessel - that is travelling

travelToCity - destination city

Returns:

TravelToTradeStep

createCheckRepairStep

protected CheckForRepairTradeStep createCheckRepairStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                                        ch.sahits.game.openpatrician.model.city.ICity city)

Create the trade step to check for repairs.

Parameters:

vessel - that should be checked.

city - in which should be checked.

Returns:

CheckForRepairTradeStep

createHireSailorStep

protected HireSailorsStep createHireSailorStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                               ch.sahits.game.openpatrician.model.city.ICity city)

Create a new instance forthe hire sailor step.

Parameters:

vessel -

city -

Returns:

createCheckAndTakeLoanStep

protected TakeLoanTradeStep createCheckAndTakeLoanStep(ch.sahits.game.openpatrician.model.IAIPlayer player,
                                                       ch.sahits.game.openpatrician.model.city.ICity city)

Create a new instance of the TakeLoan trade step.

Parameters:

player - that takes a loan

city - in which the loan is taken

Returns:

createAggregatedBuyTradeStep

protected AggregatedBuyTradeStep createAggregatedBuyTradeStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                                              ch.sahits.game.openpatrician.model.city.ICity city,
                                                              List<ch.sahits.game.openpatrician.model.product.IWare> waresToBuy)

createAggregatedSellStep

protected AggregatesSellTradeStep createAggregatedSellStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                                           ch.sahits.game.openpatrician.model.city.ICity city,
                                                           List<ch.sahits.game.openpatrician.model.product.IWare> waresToSell)

createAggregatedDumpStep

protected AggregatesDumpTradeStep createAggregatedDumpStep(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                                           ch.sahits.game.openpatrician.model.city.ICity city,
                                                           List<ch.sahits.game.openpatrician.model.product.IWare> waresToSell)

executeTradeSteps

public boolean executeTradeSteps(ch.sahits.game.openpatrician.model.IAIPlayer player,
                                 ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel)

The implementation of the execute trade steps makes the following assumptions:

• When called there is at least one trade step defined

Typically the trade steps are defined up to the travel step. When the ship then reaches the port the next steps need to be defined.

Specified by:

executeTradeSteps in interface ch.sahits.game.openpatrician.model.player.IAITradeStrategy

Parameters:

player -

vessel -

Returns:

clearRemainingTradeSteps

protected void clearRemainingTradeSteps(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                        ch.sahits.game.openpatrician.model.IAIPlayer player)

Remove any remaining trade steps.

Parameters:

vessel - for which the trade steps should be checked

player - for which the trade steps should be checked.

handleRepairFinished

public void handleRepairFinished(RepairFinishedEvent event)

Handle the event of the ship coming back from repair and the trade steps have to be picked up again.

Parameters:

event -

handleHireSailors

public void handleHireSailors(HireSailorEvent event)

Andling the hiring of sailors. This event is fired when the last try to hire sailors failed to insufficient amount of sailors available.

Parameters:

event -

getLoadedWares

protected List<ch.sahits.game.openpatrician.model.product.IWare> getLoadedWares(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel)

Find all wares that are loaded on the ship.

Parameters:

vessel -

Returns:

findWaresOfInterest

protected ArrayList<ch.sahits.game.openpatrician.model.product.IWare> findWaresOfInterest(List<javafx.util.Pair<ch.sahits.game.openpatrician.model.product.IWare,Number>> sortedNeeds)