org.orbisgis.legend

Interface IInterpolationLegend

All Superinterfaces:

LookupFieldName

All Known Implementing Classes:

InterpolationLegend, LinearInterpolationLegend, MonovariateProportionalViewBox, ProportionalLine, ProportionalPoint, ProportionalStrokeLegend, ProportionalWKNLegend, SqrtInterpolationLegend

public interface IInterpolationLegend
extends LookupFieldName

Interface for interpolation legends.

Author:

Adam Gouge

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.
double	getSecondData() Gets the data of the second interpolation point.
double	getSecondValue() Gets the value of the second interpolation point as a double.
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	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 interface org.orbisgis.legend.LookupFieldName

getLookupFieldName, setLookupFieldName

Method Detail

getFirstData

double getFirstData()

Gets the data of the first interpolation point.

Returns:

First interpolation point data

getSecondData

double getSecondData()

Gets the data of the second interpolation point.

Returns:

Second interpolation point data

setFirstData

void setFirstData(double d)

Sets the data of the first interpolation point.

Parameters:

d - First interpolation point data to set

setSecondData

void setSecondData(double d)

Sets the data of the second interpolation point

Parameters:

d - Second interpolation point data to set

getFirstValue

double getFirstValue()
                     throws ParameterException

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

Returns:

The first interpolation point's value

Throws:

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

setFirstValue

void setFirstValue(double d)

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

Parameters:

d - First value to set

getSecondValue

double getSecondValue()
                      throws ParameterException

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

Returns:

The second interpolation point's value

Throws:

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

setSecondValue

void setSecondValue(double d)

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

Parameters:

d - Second value to set