/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2009 Jaspersoft Corporation. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports 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.
*
* JasperReports 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.jasperreports.charts.base;
import java.awt.Color;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import net.sf.jasperreports.charts.JRDataRange;
import net.sf.jasperreports.charts.JRMeterPlot;
import net.sf.jasperreports.charts.JRValueDisplay;
import net.sf.jasperreports.charts.type.MeterShapeEnum;
import net.sf.jasperreports.charts.util.JRMeterInterval;
import net.sf.jasperreports.engine.JRChart;
import net.sf.jasperreports.engine.JRChartPlot;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRExpressionCollector;
import net.sf.jasperreports.engine.JRFont;
import net.sf.jasperreports.engine.base.JRBaseChartPlot;
import net.sf.jasperreports.engine.base.JRBaseFont;
import net.sf.jasperreports.engine.base.JRBaseObjectFactory;
/**
* An immutable representation of the layout of a Meter chart.
*
* @author Barry Klawans (bklawans@users.sourceforge.net)
* @version $Id: JRBaseMeterPlot.java 3715 2010-04-08 18:08:49Z teodord $
*/
public class JRBaseMeterPlot extends JRBaseChartPlot implements JRMeterPlot
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
/**
* The range displayed by the Meter.
*/
protected JRDataRange dataRange = null;
/**
* Formatting information for the textual display of the value.
*/
protected JRValueDisplay valueDisplay = null;
/**
* The shape to use when drawing the Meter. Only applied if the meter is
* over 180 degrees wide and less than a full circle.
*/
protected MeterShapeEnum shapeValue = null;
/**
* The defined intervals for the Meter. Each interval indicates a
* subsection of the meter and a color to use for that section.
*/
protected List intervals = new java.util.ArrayList();
/**
* The extend of the meter face in degrees. It will always be centered
* around the straight up position.
*/
protected Integer meterAngleInteger = null;
/**
* Optional description of what the meter is displaying. It will be
* appended to the textual representation of the value.
*/
protected String units = null;
/**
* How often to draw ticks around the face of the meter. The interval
* is relative to the meter range - if the meter displays 100 to 200 and
* the tickInterval is 20, there will be 4 ticks at 120, 140, 160 and 180.
*/
protected Double tickIntervalDouble = null;
/**
* The color to use for the face of the meter.
*/
protected Color meterBackgroundColor = null;
/**
* The color to use for the pointer on the meter.
*/
protected Color needleColor = null;
/**
* The color to use for each tick on the face of the meter.
*/
protected Color tickColor = null;
/**
* The font to use when writing tick labels.
*/
protected JRFont tickLabelFont = null;
/**
* Constructs a copy of an existing meter.
*
* @param plot the plot to copy
*/
public JRBaseMeterPlot(JRChartPlot plot, JRChart chart)
{
super(plot, chart);
JRMeterPlot meterPlot = plot instanceof JRMeterPlot ? (JRMeterPlot)plot : null;
if (meterPlot == null)
{
valueDisplay = new JRBaseValueDisplay(null, chart);
tickLabelFont = new JRBaseFont(chart, null);
}
else
{
valueDisplay = new JRBaseValueDisplay(meterPlot.getValueDisplay(), chart);
tickLabelFont = new JRBaseFont(chart, meterPlot.getTickLabelFont());
}
}
/**
* Constructs a copy of an existing meter and registers all expressions
* maintained by the meter plot with a factory.
*
* @param meterPlot the meter to copy
* @param factory the factory to register expressions with
*/
public JRBaseMeterPlot(JRMeterPlot meterPlot, JRBaseObjectFactory factory)
{
super(meterPlot, factory);
dataRange = new JRBaseDataRange(meterPlot.getDataRange(), factory);
valueDisplay = new JRBaseValueDisplay(meterPlot.getValueDisplay(), factory);
shapeValue = meterPlot.getShapeValue();
List origIntervals = meterPlot.getIntervals();
intervals.clear();
if (origIntervals != null)
{
Iterator iter = origIntervals.iterator();
while (iter.hasNext())
{
JRMeterInterval interval = (JRMeterInterval)iter.next();
intervals.add(new JRMeterInterval(interval, factory));
}
}
meterAngleInteger = meterPlot.getMeterAngleInteger();
units = meterPlot.getUnits();
tickIntervalDouble = meterPlot.getTickIntervalDouble();
meterBackgroundColor = meterPlot.getMeterBackgroundColor();
needleColor = meterPlot.getNeedleColor();
tickColor = meterPlot.getTickColor();
tickLabelFont = new JRBaseFont(this.getChart(), meterPlot.getTickLabelFont());
}
/**
*
*/
public JRDataRange getDataRange()
{
return dataRange;
}
/**
*
*/
public JRValueDisplay getValueDisplay()
{
return valueDisplay;
}
/**
* @deprecated Replaced by {@link #getShapeValue()}
*/
public byte getShape()
{
return getShapeValue() == null ? MeterShapeEnum.PIE.getValue() : getShapeValue().getValue();
}
/**
* @deprecated Replaced by {@link #getShapeValue()}
*/
public Byte getShapeByte()
{
return getShapeValue() == null ? null : getShapeValue().getValueByte();
}
/**
*
*/
public MeterShapeEnum getShapeValue()
{
return shapeValue;
}
/**
*
*/
public List getIntervals(){
return intervals;
}
/**
* @deprecated Replaced by {@link #getMeterAngleInteger()}
*/
public int getMeterAngle()
{
return meterAngleInteger == null ? 180 : meterAngleInteger.intValue();
}
/**
*
*/
public Integer getMeterAngleInteger()
{
return meterAngleInteger;
}
/**
*
*/
public String getUnits()
{
return units;
}
/**
* @deprecated Replaced by {@link #getTickIntervalDouble()}
*/
public double getTickInterval()
{
return tickIntervalDouble == null ? 10.0 : tickIntervalDouble.doubleValue();
}
/**
*
*/
public Double getTickIntervalDouble()
{
return tickIntervalDouble;
}
/**
*
*/
public Color getMeterBackgroundColor()
{
return meterBackgroundColor;
}
/**
*
*/
public Color getNeedleColor()
{
return needleColor;
}
/**
*
*/
public Color getTickColor()
{
return tickColor;
}
/**
*
*/
public JRFont getTickLabelFont()
{
return tickLabelFont;
}
/**
* Adds all the expression used by this plot with the specified collector.
* All collected expression that are also registered with a factory will
* be included with the report is compiled.
*
* @param collector the expression collector to use
*/
public void collectExpressions(JRExpressionCollector collector)
{
collector.collect(this);
}
/**
*
*/
public Object clone(JRChart parentChart)
{
JRBaseMeterPlot clone = (JRBaseMeterPlot)super.clone(parentChart);
if (dataRange != null)
{
clone.dataRange = (JRDataRange)dataRange.clone();
}
if (valueDisplay != null)
{
clone.valueDisplay = (JRValueDisplay)valueDisplay.clone();
}
if (intervals != null)
{
clone.intervals = new ArrayList(intervals.size());
for(int i = 0; i < intervals.size(); i++)
{
clone.intervals.add(((JRMeterInterval)intervals.get(i)).clone());
}
}
return clone;
}
/*
* These fields are only for serialization backward compatibility.
*/
private int PSEUDO_SERIAL_VERSION_UID = JRConstants.PSEUDO_SERIAL_VERSION_UID; //NOPMD
/**
* @deprecated
*/
private byte shape = MeterShapeEnum.PIE.getValue();
/**
* @deprecated
*/
private int meterAngle = 180;
/**
* @deprecated
*/
private double tickInterval = 10.0;
/**
* @deprecated
*/
private Byte shapeByte = null;
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2)
{
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_1_3)
{
shapeValue = MeterShapeEnum.getByValue(shape);
meterAngleInteger = Integer.valueOf(meterAngle);
tickIntervalDouble = Double.valueOf(tickInterval);
}
else
{
shapeValue = MeterShapeEnum.getByValue(shapeByte);
shapeByte = null;
}
}
}
}