org.orbisgis.legend.structure.viewbox

Class MonovariateProportionalViewBox

java.lang.Object

org.orbisgis.legend.structure.viewbox.DefaultViewBox

org.orbisgis.legend.structure.viewbox.MonovariateProportionalViewBox

All Implemented Interfaces:

IInterpolationLegend, LegendStructure, LookupFieldName, ViewBoxLegend

public class MonovariateProportionalViewBox
extends DefaultViewBox
implements IInterpolationLegend

The representation of a monovariate proportional symbol, that has been defined using a ViewBox. Such an analysis can be recognized if there is only one dimension (ie height OR width) defined in the underlying ViewBox, and it is associated to an Interpolation that can be recognized as a SqrtInterpolationLegend.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
MonovariateProportionalViewBox() Builds a new MonovariateProportionalViewBox.
MonovariateProportionalViewBox(SqrtInterpolationLegend inter, boolean onHeight, ViewBox view) Build a new MonovariateProportionalViewBox using the given SqrtInterpolationLegend and boolean instances.

Method Summary

Methods

Modifier and Type	Method and Description
double	getFirstData() Gets the data of the first interpolation point.
double	getFirstValue() Gets the value of the first interpolation point as a double.
SqrtInterpolationLegend	getInterpolation() Get the SqrtInterpolationLegend associated to this Legend.
String	getLookupFieldName() Gets the field name.
double	getSecondData() Gets the data of the second interpolation point.
double	getSecondValue() Gets the value of the second interpolation point as a double.
boolean	isOnHeight() This method lets us check if the interpolation is made on the width or on the height of the ViewBox.
void	setFirstData(double d) Sets the data of the first interpolation point.
void	setFirstValue(double d) Sets the value of the first interpolation point as a double.
void	setLookupFieldName(String name) Sets the field name.
void	setSecondData(double d) Sets the data of the second interpolation point
void	setSecondValue(double d) Set the value of the second interpolation point as a double.

Methods inherited from class org.orbisgis.legend.structure.viewbox.DefaultViewBox

getHeightLegend, getViewBox, getWidthLegend, setHeightLegend, setWidthLegend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonovariateProportionalViewBox

public MonovariateProportionalViewBox()

Builds a new MonovariateProportionalViewBox. It contains a ViewBox with a null width and an interpolated height. Interpolation is built such than 1 gives 1. Note that the lookup value won't be set from this constructor, this has to be made externally !

MonovariateProportionalViewBox

public MonovariateProportionalViewBox(SqrtInterpolationLegend inter,
                              boolean onHeight,
                              ViewBox view)

Build a new MonovariateProportionalViewBox using the given SqrtInterpolationLegend and boolean instances. onHeight is used to know if the interpolation is made on the height (onHeight is true) or on the width (onHeight is false) of the associated ViewBox;

Parameters:

inter -

view -

onHeight -

Method Detail

getInterpolation

public SqrtInterpolationLegend getInterpolation()

Get the SqrtInterpolationLegend associated to this Legend.

Returns:

A SqrtInterpolationLegend instance.

isOnHeight

public boolean isOnHeight()

This method lets us check if the interpolation is made on the width or on the height of the ViewBox.

Returns:

true if the interpolation is made on the height of the ViewBox, ie if getViewBox().getHeight() returns a not-null instance of Interpolate.

getFirstData

public double getFirstData()

Description copied from interface: IInterpolationLegend

Gets the data of the first interpolation point.

Specified by:

getFirstData in interface IInterpolationLegend

Returns:

First interpolation point data

setFirstData

public void setFirstData(double d)

Description copied from interface: IInterpolationLegend

Sets the data of the first interpolation point.

Specified by:

setFirstData in interface IInterpolationLegend

Parameters:

d - First interpolation point data to set

getSecondData

public double getSecondData()

Description copied from interface: IInterpolationLegend

Gets the data of the second interpolation point.

Specified by:

getSecondData in interface IInterpolationLegend

Returns:

Second interpolation point data

setSecondData

public void setSecondData(double d)

Description copied from interface: IInterpolationLegend

Sets the data of the second interpolation point

Specified by:

setSecondData in interface IInterpolationLegend

Parameters:

d - Second interpolation point data to set

getFirstValue

public double getFirstValue()
                     throws ParameterException

Description copied from interface: IInterpolationLegend

Gets the value of the first interpolation point as a double.

Specified by:

getFirstValue in interface IInterpolationLegend

Returns:

The first interpolation point's value

Throws:

ParameterException - If a problem is encountered while retrieving the double value.

setFirstValue

public void setFirstValue(double d)

Description copied from interface: IInterpolationLegend

Sets the value of the first interpolation point as a double.

Specified by:

setFirstValue in interface IInterpolationLegend

Parameters:

d - First value to set

getSecondValue

public double getSecondValue()
                      throws ParameterException

Description copied from interface: IInterpolationLegend

Gets the value of the second interpolation point as a double.

Specified by:

getSecondValue in interface IInterpolationLegend

Returns:

The second interpolation point's value

Throws:

ParameterException - If a problem is encountered while retrieving the double value.

setSecondValue

public void setSecondValue(double d)

Description copied from interface: IInterpolationLegend

Set the value of the second interpolation point as a double.

Specified by:

setSecondValue in interface IInterpolationLegend

Parameters:

d - Second value to set

getLookupFieldName

public String getLookupFieldName()

Description copied from interface: LookupFieldName

Gets the field name.

Specified by:

getLookupFieldName in interface LookupFieldName

Returns:

The field name

setLookupFieldName

public void setLookupFieldName(String name)

Description copied from interface: LookupFieldName

Sets the field name.

Specified by:

setLookupFieldName in interface LookupFieldName

Parameters:

name - Name