Charts no longer check if they are drawable

Fixes #201

Author: AB-xdev

CHANGELOG.md

@@ -1,4 +1,7 @@
-## 2.0.2
+## 2.1.0
+* Charts no longer check if they are drawable #198
+  * ChartJS behavior: If a chart can't be drawn it will render a empty canvas
+  * Deprecated methods: ``Chart#toJsonNative`` and ``Chart#isDrawable``
 * Make ``IndexAxis`` available in all options
 
 ## 2.0.1

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/AbstractChart.java

@@ -100,7 +100,7 @@ public T setDefaultObjectWriter(final ObjectWriter defaultObjectWriter)
 	}
 
 	@Override
-	public String toJsonNative()
+	public String toJson()
 	{
 		try
 		{

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/BarChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.BarData;
 import software.xdev.chartjs.model.data.HomogeneousData;
-import software.xdev.chartjs.model.dataset.BarDataset;
 import software.xdev.chartjs.model.options.BarOptions;
 import software.xdev.chartjs.model.options.Options;
 
@@ -63,47 +62,4 @@ public String getType()
 	{
 		return "bar";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * A {@code BarChart} is drawable if:
-	 * </p>
-	 * <ul>
-	 * <li>at least one dataset has at least one data point
-	 * <li>an xAxis scale exists with the id of the xAxisID set on a dataset, if
-	 * such an id set
-	 * <li>a yAxis scale exists with the id of the yAxisID set on a dataset, if
-	 * such an id is set
-	 * <li>there is at least one label in the {@link BarData}
-	 * </ul>
-	 *
-	 * @return true if this {@link BarChart} is drawable in its current state
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		if(this.getData().getLabels().isEmpty())
-		{
-			return false;
-		}
-		boolean sufficientData = false;
-		for(final BarDataset dataset : this.getData().getDatasets())
-		{
-			if(dataset.getXAxisID() != null && !this.hasScaleWithId(dataset.getXAxisID()))
-			{
-				return false;
-			}
-			if(dataset.getYAxisID() != null && !this.hasScaleWithId(dataset.getYAxisID()))
-			{
-				return false;
-			}
-			if(!dataset.getData().isEmpty())
-			{
-				sufficientData = true;
-			}
-		}
-		return sufficientData;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/BubbleChart.java

@@ -62,17 +62,4 @@ public String getType()
 	{
 		return "bubble";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code BubbleChart} is drawable if at least one dataset has at least one data point.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		return this.getData() != null && !this.getData().getDatasets().isEmpty();
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/Chart.java

@@ -30,43 +30,33 @@ public interface Chart<SELF, O extends Options<?, ?>, D extends AbstractData<?,
 	@JsonProperty("type")
 	String getType();
 
+	/**
+	 * @deprecated As of 2.1.0 {@link #toJson()} has the same functionality and should be used instead
+	 */
+	@Deprecated(since = "2.1.0", forRemoval = true)
+	default String toJsonNative()
+	{
+		return this.toJson();
+	}
+	
 	/**
 	 * <p>
 	 * Convert {@code this} instance to Json for use with Chart.js library.
 	 * </p>
 	 *
 	 * @return json representation of {@code this} {@link Chart}
 	 */
-	String toJsonNative();
+	String toJson();
 
 	/**
-	 * Same as {@link #toJsonNative()} but also check if the diagram {@link #isDrawable() is drawable}
-	 * @see #toJson()
+	 * @deprecated No functionality implemented as of 2.1.0
 	 */
-	default String toJson()
+	@Deprecated(since = "2.1.0", forRemoval = true)
+	default boolean isDrawable()
 	{
-		if(!this.isDrawable())
-		{
-			throw new IllegalArgumentException("Chart is not drawable");
-		}
-		return this.toJsonNative();
+		return true;
 	}
 
-	/**
-	 * <p>
-	 * Optional check to determine whether the current state of this {@link Chart} implementation instance will
-	 * generate
-	 * a drawable JSON string.
-	 * </p>
-	 * <p>
-	 * Implementations provide a best-effort evaluation, and can not guarantee that the serialized chart will be
-	 * rendered correctly.
-	 * </p>
-	 *
-	 * @return true if {@code this} {@link Chart} is drawable in its current state
-	 */
-	boolean isDrawable();
-	
 	SELF setOptions(final O options);
 
 	SELF setData(final D data);

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/DoughnutChart.java

@@ -62,17 +62,4 @@ public String getType()
 	{
 		return "doughnut";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code DoughnutChart} is drawable if at least one dataset has at least one data point.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		return this.getData() != null && !this.getData().getDatasets().isEmpty();
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/LineChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.HomogeneousData;
 import software.xdev.chartjs.model.data.LineData;
-import software.xdev.chartjs.model.dataset.LineDataset;
 import software.xdev.chartjs.model.options.LineOptions;
 import software.xdev.chartjs.model.options.Options;
 
@@ -63,36 +62,4 @@ public String getType()
 	{
 		return "line";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code LineChart} is drawable if at least one dataset has at least one data point.<br> If an xAxisID is set on a
-	 * dataset, an xAxis scale must exist with that id.
-	 * <br>
-	 * If an yAxisID is set on a dataset, a yAxis scale must exist with that id.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		boolean sufficientData = false;
-		for(final LineDataset dataset : this.getData().getDatasets())
-		{
-			if(dataset.getXAxisID() != null && !this.hasScaleWithId(dataset.getXAxisID()))
-			{
-				return false;
-			}
-			if(dataset.getYAxisID() != null && !this.hasScaleWithId(dataset.getYAxisID()))
-			{
-				return false;
-			}
-			if(!dataset.getData().isEmpty())
-			{
-				sufficientData = true;
-			}
-		}
-		return sufficientData;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/MixedChart.java

@@ -37,11 +37,4 @@ public String getType()
 	{
 		return this.type;
 	}
-	
-	@Override
-	public boolean isDrawable()
-	{
-		// Warning: Unchecked
-		return true;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/PieChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.HomogeneousData;
 import software.xdev.chartjs.model.data.PieData;
-import software.xdev.chartjs.model.dataset.PieDataset;
 import software.xdev.chartjs.model.options.Options;
 import software.xdev.chartjs.model.options.PieOptions;
 
@@ -63,24 +62,4 @@ public String getType()
 	{
 		return "pie";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code PieChart} is drawable if at least one dataset has at least one data point.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		for(final PieDataset dataset : this.getData().getDatasets())
-		{
-			if(!dataset.getData().isEmpty())
-			{
-				return true;
-			}
-		}
-		return false;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/PolarChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.HomogeneousData;
 import software.xdev.chartjs.model.data.PolarData;
-import software.xdev.chartjs.model.dataset.PolarDataset;
 import software.xdev.chartjs.model.options.Options;
 import software.xdev.chartjs.model.options.PolarOptions;
 
@@ -63,24 +62,4 @@ public String getType()
 	{
 		return "polarArea";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code PolarChart} is drawable if at least one dataset has at least two data points.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		for(final PolarDataset dataset : this.getData().getDatasets())
-		{
-			if(dataset.getData().size() >= 2)
-			{
-				return true;
-			}
-		}
-		return false;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/RadarChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.HomogeneousData;
 import software.xdev.chartjs.model.data.RadarData;
-import software.xdev.chartjs.model.dataset.RadarDataset;
 import software.xdev.chartjs.model.options.Options;
 import software.xdev.chartjs.model.options.RadarOptions;
 
@@ -63,24 +62,4 @@ public String getType()
 	{
 		return "radar";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code RadarChart} is drawable if at least one dataset has at least three data points.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		for(final RadarDataset dataset : this.getData().getDatasets())
-		{
-			if(dataset.getData().size() >= 3)
-			{
-				return true;
-			}
-		}
-		return false;
-	}
 }

chartjs-java-model/src/main/java/software/xdev/chartjs/model/charts/ScatterChart.java

@@ -17,7 +17,6 @@
 
 import software.xdev.chartjs.model.data.HomogeneousData;
 import software.xdev.chartjs.model.data.ScatterData;
-import software.xdev.chartjs.model.dataset.ScatterDataset;
 import software.xdev.chartjs.model.options.LineOptions;
 import software.xdev.chartjs.model.options.Options;
 
@@ -64,36 +63,4 @@ public String getType()
 	{
 		return "scatter";
 	}
-	
-	/**
-	 * {@inheritDoc}
-	 *
-	 * <p>
-	 * {@code LineChart} is drawable if at least one dataset has at least one data point.<br> If an xAxisID is set on a
-	 * dataset, an xAxis scale must exist with that id.
-	 * <br>
-	 * If an yAxisID is set on a dataset, a yAxis scale must exist with that id.
-	 * </p>
-	 */
-	@Override
-	public boolean isDrawable()
-	{
-		boolean sufficientData = false;
-		for(final ScatterDataset dataset : this.getData().getDatasets())
-		{
-			if(dataset.getXAxisID() != null && !this.hasScaleWithId(dataset.getXAxisID()))
-			{
-				return false;
-			}
-			if(dataset.getYAxisID() != null && !this.hasScaleWithId(dataset.getYAxisID()))
-			{
-				return false;
-			}
-			if(!dataset.getData().isEmpty())
-			{
-				sufficientData = true;
-			}
-		}
-		return sufficientData;
-	}
 }