/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.server.ai;
import java.util.logging.Logger;
import org.freecolandroid.xml.stream.XMLStreamException;
import org.freecolandroid.xml.stream.XMLStreamWriter;
import net.sf.freecol.common.model.ColonyTile;
import net.sf.freecol.common.model.GoodsType;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.UnitType;
import net.sf.freecol.common.model.WorkLocation;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* Objects of this class contains AI-information for a single {@link
* net.sf.freecol.common.model.WorkLocation}.
*/
public class WorkLocationPlan extends ValuedAIObject {
@SuppressWarnings("unused")
private static final Logger logger = Logger.getLogger(WorkLocationPlan.class.getName());
/**
* The FreeColGameObject this AIObject contains AI-information for.
*/
private WorkLocation workLocation;
private int priority;
private GoodsType goodsType;
/**
* Creates a new <code>WorkLocationPlan</code>.
*
* @param aiMain The main AI-object.
* @param workLocation The <code>WorkLocation</code> to create
* a plan for.
* @param goodsType The goodsType to be produced on the
* <code>workLocation</code> using this plan.
*/
public WorkLocationPlan(AIMain aiMain, WorkLocation workLocation, GoodsType goodsType) {
super(aiMain);
this.workLocation = workLocation;
this.goodsType = goodsType;
setValue(getProductionOf(goodsType));
}
/**
* Creates a new <code>WorkLocationPlan</code>.
*
* @param aiMain The main AI-object.
* @param element An <code>Element</code> containing an
* XML-representation of this object.
*/
public WorkLocationPlan(AIMain aiMain, Element element) {
super(aiMain);
readFromXMLElement(element);
setValue(getProductionOf(goodsType));
}
/**
* Gets the <code>WorkLocation</code> this
* <code>WorkLocationPlan</code> controls.
*
* @return The <code>WorkLocation</code>.
*/
public WorkLocation getWorkLocation() {
return workLocation;
}
/**
* Gets the production of the given type of goods according to
* this <code>WorkLocationPlan</code>. The plan has been created
* for either a {@link net.sf.freecol.common.model.ColonyTile} or
* a {@link net.sf.freecol.common.model.Building}. If this is a
* plan for a <code>ColonyTile</code> then the maximum possible
* production of the tile gets returned, while the
* <code>Building</code>-plans only returns a number used for
* identifying the value of the goods produced.
*
* @param goodsType The type of goods to get the production for.
* @return The production.
*/
public int getProductionOf(GoodsType goodsType) {
if (goodsType == null || goodsType != this.goodsType) {
return 0;
}
if (workLocation instanceof ColonyTile) {
if (!goodsType.isFarmed()) {
return 0;
}
ColonyTile ct = (ColonyTile) workLocation;
Tile t = ct.getWorkTile();
UnitType expertUnitType = getSpecification().getExpertForProducing(goodsType);
int base = t.getMaximumPotential(goodsType, expertUnitType);
if (t.isLand() && base != 0) {
base++;
}
/**
* What's this supposed to be? Are we checking for the
* possible production bonus granted by Henry Hudson? If
* so, we should check all possible production bonuses instead.
*
* return expertUnitType.getProductionFor(goodsType, base) * ((goodsType == Goods.FURS) ? 2 : 1);
*/
if (base == 0) {
return 0;
}
base = (int) expertUnitType.getFeatureContainer().applyModifier(base, goodsType.getId());
return Math.max(base, 1);
} else {
if (goodsType.isFarmed()) {
return 0;
} else {
/* These values are not really the production, but are
being used while sorting the WorkLocationPlans:
*/
if (goodsType == getSpecification().getGoodsType("model.goods.hammers")) {
return 16;
} else if (goodsType == getSpecification().getGoodsType("model.goods.bells")) {
return 12;
} else if (goodsType == getSpecification().getGoodsType("model.goods.crosses")) {
return 10;
} else {
return workLocation.getColony().getOwner().getMarket().getSalePrice(goodsType, 1);
}
}
}
}
/**
* Gets the type of goods which should be produced at the <code>WorkLocation</code>.
*
* @return The type of goods.
* @see net.sf.freecol.common.model.Goods
* @see net.sf.freecol.common.model.WorkLocation
*/
public GoodsType getGoodsType() {
return goodsType;
}
/**
* Sets the type of goods to be produced at the <code>WorkLocation</code>.
*
* @param goodsType The type of goods.
* @see net.sf.freecol.common.model.Goods
* @see net.sf.freecol.common.model.WorkLocation
*/
public void setGoodsType(GoodsType goodsType) {
this.goodsType = goodsType;
setValue(getProductionOf(goodsType));
}
protected void toXMLImpl(XMLStreamWriter out) throws XMLStreamException {
// do nothing
}
/**
* Creates an XML-representation of this object.
* @param document The <code>Document</code> in which
* the XML-representation should be created.
* @return The XML-representation.
*/
public Element toXMLElement(Document document) {
Element element = document.createElement(getXMLElementTagName());
element.setAttribute(ID_ATTRIBUTE, workLocation.getId());
element.setAttribute("priority", Integer.toString(priority));
element.setAttribute("goodsType", goodsType.getId());
return element;
}
/**
* Updates this object from an XML-representation of
* a <code>WorkLocationPlan</code>.
*
* @param element The XML-representation.
*/
public void readFromXMLElement(Element element) {
workLocation = (WorkLocation) getAIMain().getFreeColGameObject(element.getAttribute(ID_ATTRIBUTE));
priority = Integer.parseInt(element.getAttribute("priority"));
goodsType = getSpecification().getGoodsType(element.getAttribute("goodsType"));
}
/**
* Returns the tag name of the root element representing this object.
*
* @return "workLocationPlan"
*/
public static String getXMLElementTagName() {
return "workLocationPlan";
}
}