package rocks.inspectit.ui.rcp.editor.table.input;

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

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.swt.widgets.TableColumn;

import rocks.inspectit.ui.rcp.editor.inputdefinition.InputDefinition;
import rocks.inspectit.ui.rcp.editor.preferences.PreferenceEventCallback.PreferenceEvent;
import rocks.inspectit.ui.rcp.editor.preferences.PreferenceId;
import rocks.inspectit.ui.rcp.editor.root.IRootEditor;

/**
 * The abstract class of the {@link TableInputController} interface to provide some standard
 * methods.
 *
 * @author Patrice Bouillet
 *
 */
public abstract class AbstractTableInputController implements TableInputController {

	/**
	 * Map of the enumeration keys and {@link TableViewerColumn}s. Subclasses can use utility
	 * methods to bound columns for later use.
	 */
	private Map<Enum<?>, TableViewerColumn> tableViewerColumnMap = new HashMap<>();

	/**
	 * The input definition.
	 */
	private InputDefinition inputDefinition;

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setInputDefinition(InputDefinition inputDefinition) {
		Assert.isNotNull(inputDefinition);

		this.inputDefinition = inputDefinition;
	}

	/**
	 * Returns the input definition.
	 *
	 * @return The input definition.
	 */
	protected InputDefinition getInputDefinition() {
		Assert.isNotNull(inputDefinition);

		return inputDefinition;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Return <code>null</code> by default, sub-classes may override.
	 */
	@Override
	public Object getTableInput() {
		return null;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Return an empty set by default, sub-classes may override.
	 */
	@Override
	public Set<PreferenceId> getPreferenceIds() {
		return Collections.emptySet();
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Do nothing by default, sub-classes may override.
	 */
	@Override
	public void preferenceEventFired(PreferenceEvent preferenceEvent) {
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Do nothing by default, sub-classes may override.
	 */
	@Override
	public void doRefresh(IProgressMonitor monitor, IRootEditor rootEditor) {
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Do nothing by default, sub-classes may override.
	 */
	@Override
	public void doubleClick(DoubleClickEvent event) {
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Return <code>null</code> by default, sub-classes may override.
	 */
	@Override
	public boolean canOpenInput(List<? extends Object> data) {
		return false;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Do nothing by default, sub-classes may override.
	 */
	@Override
	public void setLimit(int limit) {
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Object[] getObjectsToSearch(Object tableInput) {
		if (tableInput instanceof Object[]) {
			return (Object[]) tableInput;
		}
		if (tableInput instanceof Collection) {
			return ((Collection<?>) tableInput).toArray();
		}
		return new Object[0];
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void dispose() {
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * By default controller sets the sub view to be master.
	 */
	@Override
	public SubViewClassification getSubViewClassification() {
		return SubViewClassification.MASTER;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * Returns true, classes may override.
	 */
	@Override
	public boolean canAlterColumnWidth(TableColumn tableColumn) {
		return true;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * By default does nothing, sub-classes may override.
	 */
	@Override
	public void objectChecked(Object object, boolean checked) {
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * By default false.
	 */
	@Override
	public boolean isCheckStyle() {
		return false;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * By default false.
	 */
	@Override
	public boolean areItemsInitiallyChecked() {
		return false;
	}

	/**
	 * Maps a column with the enumeration key. The implementing classes should map each column they
	 * create to the enum that represents that column. Later on the column can be retrieved with the
	 * enum key if needed.
	 *
	 * @param key
	 *            Enumeration that represents the column.
	 * @param column
	 *            Created column to be mapped.
	 */
	public void mapTableViewerColumn(Enum<?> key, TableViewerColumn column) {
		tableViewerColumnMap.put(key, column);
	}

	/**
	 * Returns the column that has been mapped with the given enum key. Enum should represent the
	 * wanted column.
	 *
	 * @param key
	 *            Enumeration that represents the column.
	 * @return Returns the column that has been mapped with the given enum key or <code>null</code>
	 *         if no mapping has been done.
	 */
	public TableViewerColumn getMappedTableViewerColumn(Enum<?> key) {
		return tableViewerColumnMap.get(key);
	}
}