FrequencyMeasurement.java

/*
 * 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;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.drugis.common.EqualsUtil;

public class FrequencyMeasurement extends BasicMeasurement {
	private Map<String, Integer> d_frequencies = new HashMap<String, Integer>();
	private List<String> d_categories = new ArrayList<String>();
	public static final String PROPERTY_FREQUENCIES = "frequencies";
	
	private FrequencyMeasurement() {
		super(null);
	}
	
	public FrequencyMeasurement(PopulationCharacteristic cv) {
		this(((CategoricalVariableType) cv.getVariableType()).getCategories(), new HashMap<String, Integer>());
	}
	
	/**
	 * @param categories Note: defensively copied. 
	 * @param map Note: defensively copied. 
	 */
	public FrequencyMeasurement(List<String> categories, Map<String, Integer> map) {
		super(null);
		d_categories = new ArrayList<String>(categories);
		d_frequencies = new HashMap<String, Integer>();
		for (String cat : d_categories) {
			d_frequencies.put(cat, map.get(cat));
		}
		updateSampleSize();
	}

	private void updateSampleSize() {
		int size = 0;
		for (String cat : d_categories) {
			if (getFrequencies().get(cat) == null) {
				setSampleSize(null);
				return;
			}
			size += getFrequencies().get(cat);
		}
		setSampleSize(size);
	}

	public void setFrequency(String category, Integer freq) throws IllegalArgumentException {
		checkCategory(category);
		Map<String, Integer> oldfreq = new HashMap<String,Integer>(getFrequencies());
		getFrequencies().put(category, freq);
		updateSampleSize();
		firePropertyChange(PROPERTY_FREQUENCIES, oldfreq, getFrequencies());
	}
	
	public Integer getFrequency(String category) throws IllegalArgumentException {
		checkCategory(category);
		return getFrequencies().get(category);
	}

	private void checkCategory(String category) {
		if (!getFrequencies().containsKey(category)) {
			throw new IllegalArgumentException("Illegal category: " + category );
		}
	}

	public String[] getCategories() {
		return d_categories.toArray(new String[]{});
	}
	
	public void add(FrequencyMeasurement other) {
		for (String cat : d_categories) {
			if (getFrequency(cat) == null || other.getFrequency(cat) == null) {
				setFrequency(cat, null);
			} else {
				setFrequency(cat, getFrequency(cat) + other.getFrequency(cat));
			}
		}
	}
		
	public boolean isOfType(VariableType type) {
		return type instanceof CategoricalVariableType;
	}

	@Override
	public Set<Entity> getDependencies() {
		return Collections.emptySet();
	}
	
	@Override
	public String toString() {
		String ret = new String();
		for (String cat : d_categories) {
			if (!ret.equals("")) {
				ret += " / ";
			}
			ret += cat + " = " + (getFrequencies().get(cat) == null ? "N/A" : getFrequencies().get(cat));
		}
		return ret;
	}
	
	@Override
	public FrequencyMeasurement clone() {
		return new FrequencyMeasurement(d_categories, d_frequencies);
	}
	
	@Override
	public boolean equals(Object o) {
		if (o instanceof FrequencyMeasurement) {
			FrequencyMeasurement m = (FrequencyMeasurement) o;
			if (!d_categories.equals(m.d_categories)) {
				return false;
			}
			return frequenciesEqual(getFrequencies(), m.getFrequencies());
		}
		return false;
	}
	
	private boolean frequenciesEqual(Map<String, Integer> frequencies,
			Map<String, Integer> frequencies2) {
		if (!frequencies.keySet().equals(frequencies2.keySet())) {
			return false;
		}
		for (String key : frequencies.keySet()) {
			if (!EqualsUtil.equal(frequencies.get(key), frequencies2.get(key))) {
				return false;
			}
		}
		return true;
	}
	
	@Override
	public int hashCode() {
		return d_frequencies.hashCode();
	}

	Map<String, Integer> getFrequencies() {
		return d_frequencies;
	}
}