package rocks.inspectit.ui.rcp.editor.graph.plot;

import java.util.Date;
import java.util.List;
import java.util.Set;

import org.jfree.chart.plot.XYPlot;

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.preferences.control.SamplingRateControl.Sensitivity;
import rocks.inspectit.ui.rcp.editor.preferences.control.samplingrate.SamplingRateMode;
import rocks.inspectit.ui.rcp.editor.root.IRootEditor;

/**
 * The interface for all plot controller.
 *
 * @author Patrice Bouillet
 *
 */
public interface PlotController {

	/**
	 * Sets the input definition of this controller.
	 *
	 * @param inputDefinition
	 *            The input definition.
	 */
	void setInputDefinition(InputDefinition inputDefinition);

	/**
	 * Sets the root editor.
	 *
	 * @param rootEditor
	 *            The rootEditor to set.
	 */
	void setRootEditor(IRootEditor rootEditor);

	/**
	 * This method is used to retrieve the plots which are used in the whole chart. No data has to
	 * be requested from the server here, this is done in the {@link #update()} method.
	 *
	 * @return A list containing {@link XYPlot} classes which are used by JFreeChart to initialize
	 *         the chart.
	 */
	List<XYPlot> getPlots();

	/**
	 * Returns the weight of a specific plot.
	 *
	 * @param subPlot
	 *            The plot to calculate the weight.
	 * @return Returns the weight of the plot.
	 */
	int getWeight(XYPlot subPlot);

	/**
	 * This method obtains historical information from the DB for the timeframe denoted by its
	 * parameters.
	 * <p>
	 * After fetching the historical data the upper and lower plot graphs get updated.
	 * <p>
	 * <b>Note that this method is not called in the UI thread because it is expected that this can
	 * be long running operation. Any access to the widgets in this method must be run in UI thread
	 * to ensure no InvalidThreadException occurs.</b>
	 *
	 * @param from
	 *            the timeframe's start date.
	 * @param to
	 *            the timeframes's end date.
	 */
	void update(Date from, Date to);

	/**
	 * Sets the sampling rate.
	 *
	 * @param mode
	 *            The mode.
	 * @param sensitivity
	 *            The sensitivity of the mode.
	 */
	void setSamplingRate(SamplingRateMode mode, Sensitivity sensitivity);

	/**
	 * Returns all needed preference IDs.
	 *
	 * @return A {@link Set} containing all {@link PreferenceId}. Returning <code>null</code> is not
	 *         permitted here. At least a {@link java.util.Collections#EMPTY_SET} should be
	 *         returned.
	 */
	Set<PreferenceId> getPreferenceIds();

	/**
	 * This method is called whenever something is changed in one of the preferences.
	 *
	 * @param preferenceEvent
	 *            The event object containing the changed objects.
	 */
	void preferenceEventFired(PreferenceEvent preferenceEvent);

	/**
	 * If the legend in the chart should be shown.
	 *
	 * @return True if legend should be shown, otherwise false.
	 */
	boolean showLegend();

	/**
	 * Disposes all plots etc.
	 */
	void dispose();

}