/*
 * This file is part of ADDIS (Aggregate Data Drug Information System).
 * ADDIS is distributed from http://drugis.org/.
 * Copyright © 2009 Gert van Valkenhoef, Tommi Tervonen.
 * Copyright © 2010 Gert van Valkenhoef, Tommi Tervonen, Tijs Zwinkels,
 * Maarten Jacobs, Hanno Koeslag, Florin Schimbinschi, Ahmad Kamal, Daniel
 * Reid.
 * Copyright © 2011 Gert van Valkenhoef, Ahmad Kamal, Daniel Reid, Florin
 * Schimbinschi.
 * Copyright © 2012 Gert van Valkenhoef, Daniel Reid, Joël Kuiper, Wouter
 * Reckman.
 * Copyright © 2013 Gert van Valkenhoef, Joël Kuiper.
 *
 * 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.drugis.addis.entities.analysis;

import java.util.List;

import org.drugis.addis.entities.AbstractNamedEntity;
import org.drugis.addis.entities.Indication;
import org.drugis.addis.entities.OutcomeMeasure;
import org.drugis.addis.entities.relativeeffect.Distribution;

import com.jgoodies.binding.list.ObservableList;

public abstract class BenefitRiskAnalysis<Alternative> extends AbstractNamedEntity<BenefitRiskAnalysis<?>> {
	public static String PROPERTY_NAME = "name";
	public static String PROPERTY_INDICATION = "indication";
	public static String PROPERTY_CRITERIA = "criteria";
	public static String PROPERTY_ALTERNATIVES = "alternatives";
	public static String PROPERTY_ANALYSIS_TYPE = "analysisType";
	public static String PROPERTY_BASELINE = "baseline";
	public static String PROPERTY_DECISION_CONTEXT = "decisionContext";

	public BenefitRiskAnalysis(String name) {
		super(name);
	}

	public static enum AnalysisType { LyndOBrien, SMAA };
	
	public abstract AnalysisType getAnalysisType();
	
	public abstract Indication getIndication();

	public abstract List<OutcomeMeasure> getCriteria();

	public abstract ObservableList<Alternative> getAlternatives();
	
	public abstract List<Alternative> getNonBaselineAlternatives();
	
	public abstract Alternative getBaseline();

	public abstract Distribution getMeasurement(OutcomeMeasure criterion, Alternative a);
	
	public abstract Distribution getRelativeEffectDistribution(OutcomeMeasure criterion, Alternative subject);

	/**
	 * The MeasurementSource should fire an event when the measurements that are the input for the BR analysis change.
	 */
	public abstract MeasurementSource<Alternative> getMeasurementSource();
	
	public abstract DecisionContext getDecisionContext();

	@Override
	public boolean equals(Object obj) {
		if (obj != null && obj instanceof BenefitRiskAnalysis) {
			BenefitRiskAnalysis<?> other = (BenefitRiskAnalysis<?>) obj;
			return getName().equals(other.getName());
		}
		return false;
	}
}