xdev.ui.charts.model.VTStringTimeChartDataInitializer 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 java.util.Date;
import java.util.List;
import java.util.Map;

import xdev.ui.charts.AbstractRelationalStructureChart;
import xdev.ui.charts.utils.ChartRangeComputationUtils;
import xdev.ui.charts.utils.VirtualTableChartUtils;
import xdev.ui.charts.utils.VirtualTableColumnTypeUtils;
import xdev.vt.VirtualTable;
import xdev.vt.VirtualTableAdapter;
import xdev.vt.VirtualTableColumn;
import xdev.vt.VirtualTableEvent;

import com.jidesoft.chart.axis.CategoryAxis;
import com.jidesoft.chart.axis.NumericAxis;
import com.jidesoft.chart.model.DefaultChartModel;
import com.jidesoft.chart.model.RealPosition;
import com.jidesoft.chart.model.TimePosition;
import com.jidesoft.range.CategoryRange;
import com.jidesoft.range.Range;
import com.jidesoft.range.TimeRange;


/**
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public class VTStringTimeChartDataInitializer extends VirtualTableAdapter implements
		ChartDataInitializer>
{
	
	/**
	 * the values stored in a {@link TimeRange}.
	 */
	private Range																timeValueRange;
	
	/**
	 * the category values stored in a {@link CategoryAxis}.
	 */
	private CategoryRange													categoryRange;
	
	/**
	 * the chart to initialze.
	 */
	private AbstractRelationalStructureChart>	chart;
	
	private ChartColorScheme														colorScheme;
	
	private Chart3DOrientationStrategy												orientation;
	
	// concrete data
	private VirtualTable															modelVT;
	private VirtualTableColumn									categoryColumn;
	private VirtualTableColumn										valueColumn;
	private VirtualTableColumn									depthColumn;
	private VirtualTableColumn[]													seriesColumns;
	
	
	/**
	 * Creates an empty {@link OrientationalChartDataInitializer}.
	 * 
	 * The chart orientation can be set via
	 * {@link OrientationalChartDataInitializer#setChartOrientation(Chart3DOrientationStrategy)}
	 * .
	 * 
	 */
	public VTStringTimeChartDataInitializer()
	{
		super();
	}
	
	
	public VTStringTimeChartDataInitializer(
			AbstractRelationalStructureChart> chart)
	{
		super();
		this.setChart(chart);
	}
	
	
	/**
	 * @return the chart
	 */
	@Override
	public AbstractRelationalStructureChart> getChart()
	{
		if(this.chart == null)
		{
			throw new NullPointerException("A chart must be set to initialize data");
		}
		else
		{
			return chart;
		}
	}
	
	
	@Override
	public void setChart(AbstractRelationalStructureChart> chart)
	{
		this.chart = chart;
	}
	
	
	private void initializeCategoryAxis(VirtualTableColumn categoryColumnIndex,
			VirtualTable container, Chart3DOrientationStrategy orientation)
	{
		this.categoryRange = ChartRangeComputationUtils.computeStringRange(container,
				container.getColumnIndex(categoryColumnIndex));
		
		orientation.setCategoryAxis(this.getChart(),new CategoryAxis(this.categoryRange,
				categoryColumnIndex.getName()));
	}
	
	
	// single value column data
	private void initializeValueAxis(VirtualTableColumn valueColumnIndex,
			VirtualTable container, Chart3DOrientationStrategy orientation)
	{
		this.timeValueRange = ChartRangeComputationUtils.computeTimeValueRange(container,
				container.getColumnIndex(valueColumnIndex));
		
		orientation.setValueAxis(this.getChart(),new NumericAxis(this.timeValueRange));
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void initializeChartModel(VirtualTable container,
			VirtualTableColumn categoryColumnIndex, VirtualTableColumn valueColumnIndex,
			Chart3DOrientationStrategy orientation, VirtualTableColumn... seriesColumnIndices)
	{
		this.modelVT = container;
		this.modelVT.addVirtualTableListener(this);
		this.categoryColumn = VirtualTableColumnTypeUtils.isStringColumn(categoryColumnIndex);
		this.valueColumn = VirtualTableColumnTypeUtils.isDateColumn(valueColumnIndex);
		this.seriesColumns = seriesColumnIndices;
		this.orientation = orientation;
		
		if(VirtualTableChartUtils.checkVTData(this.modelVT))
		{
			this.initializeCategoryAxis(categoryColumnIndex,container,orientation);
			this.initializeValueAxis(valueColumnIndex,container,orientation);
			Map, DefaultChartModel> seriesContextMap = VirtualTableChartUtils
					.createChartSeriesDataContext(container,seriesColumnIndices);
			
			DefaultChartModel singleSeriesModel = new DefaultChartModel(valueColumn.getName());
			DefaultChartModel currentSeriesModel = null;
			for(int row = 0; row < container.getRowCount(); row++)
			{ // select model
				currentSeriesModel = VirtualTableChartUtils.getChartModel(singleSeriesModel,
						seriesContextMap,VirtualTableChartUtils.getRowGroupData(
								container.getRow(row),seriesColumnIndices));
				
				Date value = container.getValueAt(row,valueColumn);
				currentSeriesModel.addPoint(orientation.getOrientedPoint(ChartRangeComputationUtils
						.getCategory(this.categoryRange,
								container.getValueAt(row,this.categoryColumn)),new TimePosition(
						value.getTime())));
			}
			VirtualTableChartUtils.addChartModels(this.getChart(),orientation,
					seriesContextMap.values(),this.getChartColorScheme(),this.seriesColumns.length);
		}
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void initializeChartModel(VirtualTable container,
			VirtualTableColumn categoryColumnIndex, VirtualTableColumn valueColumnIndex,
			VirtualTableColumn depthColumnIndex, Chart3DOrientationStrategy orientation,
			VirtualTableColumn... seriesColumnIndices)
	{
		this.modelVT = container;
		this.modelVT.addVirtualTableListener(this);
		this.categoryColumn = VirtualTableColumnTypeUtils.isStringColumn(categoryColumnIndex);
		this.valueColumn = VirtualTableColumnTypeUtils.isDateColumn(valueColumnIndex);
		this.depthColumn = VirtualTableColumnTypeUtils.isNumericColumn(depthColumnIndex);
		this.seriesColumns = seriesColumnIndices;
		this.orientation = orientation;
		
		if(VirtualTableChartUtils.checkVTData(this.modelVT))
		{
			this.initializeCategoryAxis(categoryColumnIndex,container,orientation);
			this.initializeValueAxis(valueColumnIndex,container,orientation);
			Map, DefaultChartModel> seriesContextMap = VirtualTableChartUtils
					.createChartSeriesDataContext(container,seriesColumnIndices);
			
			DefaultChartModel singleSeriesModel = new DefaultChartModel(valueColumn.getName());
			DefaultChartModel currentSeriesModel = null;
			for(int row = 0; row < container.getRowCount(); row++)
			{
				currentSeriesModel = VirtualTableChartUtils.getChartModel(singleSeriesModel,
						seriesContextMap,VirtualTableChartUtils.getRowGroupData(
								container.getRow(row),seriesColumnIndices));
				Date value = container.getValueAt(row,valueColumn);
				Number depthValue = container.getValueAt(row,depthColumn);
				
				currentSeriesModel.addPoint(orientation.getOrientedPoint(ChartRangeComputationUtils
						.getCategory(this.categoryRange,
								container.getValueAt(row,this.categoryColumn)),new TimePosition(
						value.getTime()),new RealPosition(depthValue.doubleValue())));
			}
			VirtualTableChartUtils.addChartModels(this.getChart(),orientation,
					seriesContextMap.values(),this.getChartColorScheme(),this.seriesColumns.length);
		}
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setChartColorScheme(ChartColorScheme colorScheme)
	{
		this.colorScheme = colorScheme;
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public ChartColorScheme getChartColorScheme()
	{
		if(this.colorScheme != null)
		{
			return this.colorScheme;
		}
		else
		{
			return ChartDataInitializer.DEFAULT_CHART_COLORSCHEME;
		}
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void virtualTableDataChanged(VirtualTableEvent event)
	{
		// re/initialize model
		if(this.depthColumn != null)
		{
			this.initializeChartModel(this.modelVT,this.categoryColumn,this.valueColumn,
					this.depthColumn,this.orientation,this.seriesColumns);
		}
		else
		{
			this.initializeChartModel(this.modelVT,this.categoryColumn,this.valueColumn,
					this.orientation,this.seriesColumns);
		}
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void virtualTableRowInserted(VirtualTableEvent event)
	{
		// re/initialize model
		if(this.depthColumn != null)
		{
			this.initializeChartModel(this.modelVT,this.categoryColumn,this.valueColumn,
					this.depthColumn,this.orientation,this.seriesColumns);
		}
		else
		{
			this.initializeChartModel(this.modelVT,this.categoryColumn,this.valueColumn,
					this.orientation,this.seriesColumns);
		}
	}
}