xdev.ui.charts.model.ChartDataInitializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of csapi Show documentation

XDEV Component Suite

There is a newer version: 6.0.2

package xdev.ui.charts.model;

/*-
 * #%L
 * XDEV BI Suite
 * %%
 * Copyright (C) 2011 - 2021 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import xdev.ui.charts.AbstractRelationalStructureChart;


/**
 * Initializes a charts axis and data.
 * 
 * @param 
 *            the container type which provides the model data.
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public interface ChartDataInitializer
{
	
	static final Chart3DOrientationStrategy	DEFAULT_ORIENTATION_STRATEGY	= new VerticalChartOrientationStrategy();
	static final ChartColorScheme			DEFAULT_CHART_COLORSCHEME		= ChartColorScheme.BLUE;
	
	
	public void initializeChartModel(ContainerType container, ValueType categoryColumnIndex,
			ValueType valueColumnIndex, Chart3DOrientationStrategy orientation,
			ValueType... seriesColumnIndices);
	
	
	public void initializeChartModel(ContainerType container, ValueType categoryColumnIndex,
			ValueType valueColumnIndex, ValueType depthColumnIndex,
			Chart3DOrientationStrategy orientation, ValueType... seriesColumnIndices);

	
	/**
	 * Returns the initialized chart.
	 * 
	 * @return the initialized chart.
	 */
	AbstractRelationalStructureChart getChart();
	
	
	/**
	 * Sets the chart to initialize.
	 * 
	 * @param chart
	 *            the chart to initialize.
	 */
	void setChart(AbstractRelationalStructureChart chart);
	
	
	/**
	 * 
	 * @param colorScheme
	 */
	void setChartColorScheme(ChartColorScheme colorScheme);
	
	
	/**
	 * 
	 * @return
	 */
	ChartColorScheme getChartColorScheme();
}