com.jwebmp.plugins.jqplot.graphs.JQPlotLineGraph Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017 Marc Magon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.jwebmp.plugins.jqplot.graphs;

import com.jwebmp.core.plugins.ComponentInformation;
import com.jwebmp.plugins.jqplot.JQPlotGraph;
import com.jwebmp.plugins.jqplot.graphs.display.JQPlotLine;
import com.jwebmp.plugins.jqplot.options.JQPlotOptions;

import java.util.ArrayList;
import java.util.List;

import static com.jwebmp.core.utilities.StaticStrings.*;

/**
 * The line graph implementation
 *
 * @param 
 *
 * @author mmagon
 * @since 2014/07/08
 */
@ComponentInformation(name = "Line Graph",
		description = "The most basic jqPlot chart takes a series of data and plots a line. No options need to be supplied. Data is passed in as an array of series. A series can be either an array of y values or an array of [x,y] data pairs. If y values only, x values are assigned like 1, 2, 3, ... Note, for this plot you don't need any plugins.",
		url = "http://www.jqplot.com/examples/line-charts.php")
public class JQPlotLineGraph>
		extends JQPlotGraph
{


	private List plotLines;

	/**
	 * The plot line graph
	 */
	public JQPlotLineGraph()
	{
		//Nothing Needed
	}

	/**
	 * Each line should consist of data-points in the form of x,y,x,y,x,y,x,y
	 *
	 * @param xyValues
	 * 		An array of x,y values continual
	 */
	public void addLine(double... xyValues)
	{
		JQPlotLine newLine = new JQPlotLine(JQPlotLine.buildFromArray(xyValues));
		getPlotLines().add(newLine);
	}

	/**
	 * Returns the plot lines on this graph
	 *
	 * @return
	 */
	public List getPlotLines()
	{
		if (plotLines == null)
		{
			plotLines = new ArrayList<>();
		}
		return plotLines;
	}

	/**
	 * Each line should consist of data-points in the form of x,y,x,y,x,y,x,y
	 *
	 * @param xyValues
	 * 		An array of x,y values continual
	 */
	public void addLine(Object[] xyValues)
	{
		JQPlotLine newLine = new JQPlotLine(JQPlotLine.buildFromArray(xyValues));
		getPlotLines().add(newLine);
	}

	/**
	 * Each line should consist of data-points in the form of x,y,x,y,x,y,x,y
	 *
	 * @param xyValues
	 * 		A string of x,y coordinates
	 */
	public void addLine(String xyValues)
	{
		JQPlotLine newLine = new JQPlotLine(JQPlotLine.buildFromDelimiteredSrting(xyValues, STRING_COMMNA));
		getPlotLines().add(newLine);
	}

	/**
	 * Each line should consist of data-points in the form of x,y,x,y,x,y,x,y
	 *
	 * @param newLine
	 * 		A new line to add
	 */
	public void addLine(JQPlotLine newLine)
	{

		getPlotLines().add(newLine);
	}

	@Override
	protected StringBuilder getDataPointRender()
	{
		StringBuilder sb = new StringBuilder();
		sb.append("[");
		for (JQPlotLine plotLine : getPlotLines())
		{
			sb.append(plotLine)
			  .append(STRING_COMMNA);
		}
		sb = sb.deleteCharAt(sb.lastIndexOf(STRING_COMMNA));
		sb.append("]");
		return sb;
	}

	@Override
	public int hashCode()
	{
		return super.hashCode();
	}

	@Override
	public boolean equals(Object o)
	{
		return super.equals(o);
	}
}