/*
* 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 net.sf.jasperreports.charts.JRDataRange;
import net.sf.jasperreports.charts.JRThermometerPlot;
import net.sf.jasperreports.charts.JRValueDisplay;
import net.sf.jasperreports.charts.type.ValueLocationEnum;
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.base.JRBaseChartPlot;
import net.sf.jasperreports.engine.base.JRBaseObjectFactory;
/**
* An immutable representation of the layout of a thermometer plot.
*
* @author Barry Klawans (bklawans@users.sourceforge.net)
* @version $Id: JRBaseThermometerPlot.java 3715 2010-04-08 18:08:49Z teodord $
*/
public class JRBaseThermometerPlot extends JRBaseChartPlot implements JRThermometerPlot
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
/**
* The range of values that can be displayed by this thermometer. Specifies
* the upper and lower bounds of the meter itself.
*/
protected JRDataRange dataRange = null;
/**
* Formatting information for the textual display of the value, including
* font, color and a mask.
*/
protected JRValueDisplay valueDisplay = null;
/**
* Indicates if the boundaries of each range should be shown.
* @deprecated No longer used.
*/
protected boolean showValueLines = false;
/**
* Specifies where the textual display of the value should be shown.
*/
protected ValueLocationEnum valueLocationObject = null;
/**
* The default color to use for the mercury in the thermometer.
*/
protected Color mercuryColor = null;
/**
* The boundaries of the low range.
*/
protected JRDataRange lowRange = null;
/**
* The boundaries of the medium range.
*/
protected JRDataRange mediumRange = null;
/**
* The boundaries of the high range.
*/
protected JRDataRange highRange = null;
/**
* Constructs a new thermometer plot that is a copy of an existing one.
*
* @param plot the plot to copy
* @param chart the parent chart
*/
public JRBaseThermometerPlot(JRChartPlot plot, JRChart chart)
{
super(plot, chart);
JRThermometerPlot thermoPlot = plot instanceof JRThermometerPlot ? (JRThermometerPlot)plot : null;
if (thermoPlot == null)
{
valueDisplay = new JRBaseValueDisplay(null, chart);
}
else
{
valueDisplay = new JRBaseValueDisplay(thermoPlot.getValueDisplay(), chart);
}
}
/**
* Constructs a new plot that is a copy of an existing one, and registers
* all expression used by the plot with the specified factory.
*
* @param thermoPlot the plot to copy
* @param factory the factory to register any expressions with
*/
public JRBaseThermometerPlot(JRThermometerPlot thermoPlot, JRBaseObjectFactory factory)
{
super(thermoPlot, factory);
dataRange = new JRBaseDataRange(thermoPlot.getDataRange(), factory);
valueDisplay = new JRBaseValueDisplay(thermoPlot.getValueDisplay(), factory);
valueLocationObject = thermoPlot.getValueLocationValue();
mercuryColor = thermoPlot.getMercuryColor();
if (thermoPlot.getLowRange() != null)
{
lowRange = new JRBaseDataRange(thermoPlot.getLowRange(), factory);
}
if (thermoPlot.getMediumRange() != null)
{
mediumRange = new JRBaseDataRange(thermoPlot.getMediumRange(), factory);
}
if (thermoPlot.getHighRange() != null)
{
highRange = new JRBaseDataRange(thermoPlot.getHighRange(), factory);
}
}
/**
*
*/
public JRDataRange getDataRange()
{
return dataRange;
}
/**
*
*/
public JRValueDisplay getValueDisplay()
{
return valueDisplay;
}
/**
* @deprecated No longer used.
*/
public boolean isShowValueLines()
{
return showValueLines;
}
/**
* @deprecated Replaced by {@link #getValueLocationValue()}
*/
public byte getValueLocation()
{
return getValueLocationValue() == null ? ValueLocationEnum.BULB.getValue() : getValueLocationValue().getValue();
}
/**
* @deprecated Replaced by {@link #getValueLocationValue()}
*/
public Byte getValueLocationByte()
{
return getValueLocationValue() == null ? null : getValueLocationValue().getValueByte();
}
/**
*
*/
public ValueLocationEnum getValueLocationValue()
{
return valueLocationObject;
}
/**
*
*/
public Color getMercuryColor()
{
return mercuryColor;
}
/**
*
*/
public JRDataRange getLowRange()
{
return lowRange;
}
/**
*
*/
public JRDataRange getMediumRange()
{
return mediumRange;
}
/**
*
*/
public JRDataRange getHighRange()
{
return highRange;
}
/**
* 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)
{
JRBaseThermometerPlot clone = (JRBaseThermometerPlot)super.clone(parentChart);
if (dataRange != null)
{
clone.dataRange = (JRDataRange)dataRange.clone();
}
if (valueDisplay != null)
{
clone.valueDisplay = (JRValueDisplay)valueDisplay.clone();
}
if (lowRange != null)
{
clone.lowRange = (JRDataRange)lowRange.clone();
}
if (mediumRange != null)
{
clone.mediumRange = (JRDataRange)mediumRange.clone();
}
if (highRange != null)
{
clone.highRange = (JRDataRange)highRange.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 valueLocation = ValueLocationEnum.BULB.getValue();
/**
* @deprecated
*/
private Byte valueLocationByte = null;
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_1_3)
{
valueLocationObject = ValueLocationEnum.getByValue(valueLocation);
}
else if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2)
{
valueLocationObject = ValueLocationEnum.getByValue(valueLocationByte);
valueLocationByte = null;
}
}
}