/*
 * Copyright (c) 2012 Diamond Light Source Ltd.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */

package uk.ac.diamond.scisoft.analysis.plotserver;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.dawnsci.analysis.api.roi.IROI;
import org.eclipse.dawnsci.analysis.dataset.roi.ROIList;
import org.eclipse.dawnsci.analysis.dataset.roi.ROIUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This bean contains all the information about a GUI which needs to be
 * propagated around between different GUIs and the client. It is important to
 * note that although this can contain any information (i.e. any serializable
 * object) it should be lightweight as it will be passed around regularly. If
 * any heavier data needs to be passed about use the DataBean methodology. It
 * would make sense to extend this for specific GUIs to include easier methods
 * for filling and emptying the data
 */
public class GuiBean extends HashMap<GuiParameters, Serializable> implements Serializable {
	private static final Logger logger = LoggerFactory.getLogger(GuiBean.class);

	private boolean warn = true;

	/**
	 * @return a shallow copy of gui bean
	 */
	public GuiBean copy() {
		GuiBean bean = new GuiBean();
		bean.putAll(this);
		return bean;
	}

	/**
	 * Merge entries from another bean
	 * @param bean 
	 */
	public void merge(GuiBean bean) {
		for (Map.Entry<GuiParameters, Serializable> pair: bean.entrySet()) {
			this.put(pair.getKey(), pair.getValue());
		}
	}

	@Override
	public Serializable get(Object key) {
		Serializable returnValue = super.get(key);
		
		if (warn && key instanceof GuiParameters) {
			GuiParameters guiParam = (GuiParameters) key;
			if (returnValue != null && !guiParam.getStorageClass().isInstance(returnValue)) {
				logger.error("Value in GuiBean for key " + guiParam.toString() + " is not of expected type. A ClassCastException is likely");
			}
		}
		
		return returnValue;
	}

	@SuppressWarnings("unchecked")
	@Override
	public Serializable put(GuiParameters key, Serializable value) {
		if (key == null) {
			throw new NullPointerException("key must not be null");
		}
		if (key.equals(GuiParameters.ROIDATA)) { // special case to handle old users of ROIDATA
			if (!key.getStorageClass().isInstance(value)) {
				if (value instanceof IROI) {
					IROI roi = (IROI) value;
					String name = roi.getName();
					ROIList<IROI> list = (ROIList<IROI>) get(GuiParameters.ROIDATALIST);
					if (list == null || list.size() == 0) {
						list = (ROIList<IROI>) ROIUtils.createNewROIList(roi);
					} else {
						IROI oroi = list.get(0);
						if (!oroi.getClass().isAssignableFrom(roi.getClass())) {
							list = (ROIList<IROI>) ROIUtils.createNewROIList(roi); // overwrite list
						}
					}
					boolean found = false;
					for (int i = 0, imax = list.size(); i < imax; i++) {
						IROI r = list.get(i);
						if (r.getName().equals(name)) {
							found = true;
							if (r != roi) {
								list.set(i, roi);
							}
							break;
						}
					}
					if (!found) {
						list.add(roi);
					}
					super.put(GuiParameters.ROIDATALIST, list);
					value = roi.getName();
				}
			}
		}
		if (warn && value != null && !key.getStorageClass().isInstance(value)) {
			logger.error("Value in GuiBean for key " + key.toString() + " is not of expected type. A ClassCastException is likely");
		}
		return super.put(key, value);
	}

	@Override
	public void putAll(Map<? extends GuiParameters, ? extends Serializable> m) {
		for (Map.Entry<? extends GuiParameters, ? extends Serializable> pair: m.entrySet()) {
			this.put(pair.getKey(), pair.getValue());
		}
	}

	public boolean isWarn() {
		return warn;
	}

	public void setWarn(boolean warn) {
		this.warn = warn;
	}

	/**
	 * @return roi if it can be found otherwise null
	 */
	public IROI getROI() {
		String name = (String) get(GuiParameters.ROIDATA);
		if (name != null) {
			ROIList<?> list = (ROIList<?>) get(GuiParameters.ROIDATALIST);
			for (IROI r : list) {
				if (r.getName().equals(name)) {
					return r;
				}
			}
		}
		return null;
	}
}