/*
 * 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.Entity;
import org.drugis.addis.entities.Indication;
import org.drugis.addis.entities.OutcomeMeasure;
import org.drugis.addis.entities.Study;
import org.drugis.addis.entities.TypeWithName;
import org.drugis.addis.entities.treatment.TreatmentDefinition;
import org.drugis.mtc.summary.MultivariateNormalSummary;

public interface MetaAnalysis extends Entity, Comparable<MetaAnalysis>, TypeWithName {
	public static final String PROPERTY_TYPE = "type";
	public String getType();
	
	public static final String PROPERTY_INDICATION = "indication";
	public Indication getIndication();

	public static final String PROPERTY_OUTCOME_MEASURE = "outcomeMeasure";
	public OutcomeMeasure getOutcomeMeasure();
	
	public static final String PROPERTY_SAMPLE_SIZE = "sampleSize";
	public int getSampleSize();

	public static final String PROPERTY_ALTERNATIVES = "alternatives";
	public List<TreatmentDefinition> getAlternatives();
	
	public static final String PROPERTY_INCLUDED_STUDIES = "includedStudies";
	public List<Study> getIncludedStudies();
	
	/**
	 * Return a multivariate summary of the effects for all treatments relative to the baseline. 
	 * The order in which the relative effects are given is based on the natural ordering of the
	 * treatments. The first treatment is used as the baseline.  
	 * 
	 * @see getIncludedDrugs() for the ordered list of treatments
	 * @return A multivariate summary of all the relative effects. 
	 */
	public MultivariateNormalSummary getRelativeEffectsSummary();
}