/*
 * 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.rpc.flattening;

import java.util.HashMap;
import java.util.Map;

import uk.ac.diamond.scisoft.analysis.rpc.flattening.helpers.DatasetHelper;

/**
 * Use this class to describe a data set that already resides on disk and can be loaded using the file loaders. This
 * object is flattened to a flattened representation that is unflattened by {@link DatasetHelper}.
 * <p>
 * The unflattened form of this type is an {@link Dataset} in Java or an Numpy.ndarray in Python.
 * <p>
 * When unflattened in Java the filename can be any file that Analysis understands with its file loaders as the
 * filename is passed to {@link LoaderFactory}.
 * <p>
 * When unflattened in Python the filename must be an .npy fileformat that numpy.load can process. .npz file formats
 * are not officially supported.
 * 
 * @see LoaderFactory
 * @see <a href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.load.html">Numpy loading</a>
 */
public class DatasetDescriptor implements IFlattens {

	private String filename;
	private boolean deleteAfterLoad;
	private Integer index;
	private String name;

	/**
	 * Return full path to the file to load
	 * 
	 * @return file name
	 */
	public String getFilename() {
		return filename;
	}

	/**
	 * Return whether to delete the file when this object is unflattened to a Dataset
	 * 
	 * @return whether to delete
	 */
	public boolean isDeleteAfterLoad() {
		return deleteAfterLoad;
	}

	/**
	 * Get the index in the loaded data holder to use as the data set if no name is specified.
	 * 
	 * @return index
	 */
	public Integer getIndex() {
		return index;
	}

	/**
	 * Get the name in the loaded data holder to use as the data set.
	 * 
	 * @return name
	 */
	public String getName() {
		return name;
	}

	/**
	 * Full path to the file to load.
	 * 
	 * @param filename
	 *            of the file to load.
	 */
	public void setFilename(String filename) {
		this.filename = filename;
	}

	/**
	 * Set to true to delete the file when this object is unflattened to a Dataset
	 * 
	 * @param deleteAfterLoad
	 */
	public void setDeleteAfterLoad(boolean deleteAfterLoad) {
		this.deleteAfterLoad = deleteAfterLoad;
	}

	/**
	 * Set the index in the loaded data holder to use as the data set if no name is specified.
	 * 
	 * @param index
	 *            to load
	 */
	public void setIndex(Integer index) {
		this.index = index;
	}

	/**
	 * Set the name in the loaded data holder to use as the data set.
	 * 
	 * @param name
	 *            to load
	 */
	public void setName(String name) {
		this.name = name;
	}

	@Override
	public Object flatten(IRootFlattener rootFlattener) {
		Map<String, Object> outMap = new HashMap<String, Object>();
		outMap.put(IFlattener.TYPE_KEY, DatasetHelper.TYPE_NAME);
		outMap.put(DatasetHelper.FILENAME, rootFlattener.flatten(filename));
		outMap.put(DatasetHelper.DELETEFILEAFTERLOAD, rootFlattener.flatten(deleteAfterLoad));
		outMap.put(DatasetHelper.INDEX, rootFlattener.flatten(index));
		outMap.put(DatasetHelper.NAME, rootFlattener.flatten(name));
		return outMap;
	}

}