MortgageValuator.java

/*  Copyright (C) 2010 - 2011  Fabian Neundorf, Philip Caroli,
 *  Maximilian Madlung,	Usman Ghani Ahmed, Jeremias Mechler
 *
 *  This program 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 3 of the License, or
 *  (at your option) any later version.
 *  
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.ojim.client.ai.valuation;

import java.util.logging.Level;

import org.ojim.logic.state.fields.BuyableField;
import org.ojim.logic.state.fields.Field;

/**
 * 
 * @author Jeremias Mechler
 * 
 */
public final class MortgageValuator extends ValuationFunction {

	/**
	 * Default constructor
	 */
	protected MortgageValuator() {
	}

	/**
	 * This is a singleton object!
	 * 
	 * @return An instance
	 */
	public static ValuationFunction getInstance() {
		return MortgageValuator.getInstance(false, MortgageValuator.class);
	}

	/**
	 * {@inheritDoc}
	 */
	public double returnValuation(int playerID, int position) {
		getLogger();
		double result = 0;
		if (position == -1) {
			position = getGameState().getPlayerById(playerID).getPosition();
		}
		assert (position != -1);
		Field field = getGameState().getFieldAt(position);
		assert (field != null);
		if (field instanceof BuyableField) {
			if (((BuyableField) field).isMortgaged() && !((BuyableField) field).getSelected()) {
				result = parameters.getMortgageFactor() * ((BuyableField) field).getPrice();
				logger.log(Level.FINE, "Mortgaged!");
			} else if (((BuyableField) field).isMortgaged()) {
				result = 1;
			}
		}
		logger.log(Level.FINE, "Result = " + result);
		return result;
	}
}