org.orbisgis.legend.structure.interpolation

Class InterpolationLegend

java.lang.Object

org.orbisgis.legend.structure.interpolation.InterpolationLegend

All Implemented Interfaces:

IInterpolationLegend, LegendStructure, LookupFieldName, NumericLegend, ParameterLegend

Direct Known Subclasses:

LinearInterpolationLegend, SqrtInterpolationLegend

public abstract class InterpolationLegend
extends Object
implements NumericLegend, IInterpolationLegend

The default representation of an interpolation, in the legend. If obtained during an analysis, it is supposed to mean that none of the other, more accurate cases, has been recognized in the input Interpolate2Real instance used by the analyzer.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
InterpolationLegend(Interpolate2Real inter) Build a new InterpolationLegend

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.
Interpolate2Real	getInterpolation() Get the Interpolate2Real instance associated to this InterpolationLegend.
SeParameter	getParameter() Gets the SeParameter that had been used to build this LegendStructure.
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 class java.lang.Object

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

Methods inherited from interface org.orbisgis.legend.LookupFieldName

getLookupFieldName, setLookupFieldName

Constructor Detail

InterpolationLegend

public InterpolationLegend(Interpolate2Real inter)

Build a new InterpolationLegend

Parameters:

inter -

Method Detail

getInterpolation

public Interpolate2Real getInterpolation()

Get the Interpolate2Real instance associated to this InterpolationLegend.

Returns:

getParameter

public SeParameter getParameter()

Description copied from interface: ParameterLegend

Gets the SeParameter that had been used to build this LegendStructure.

Specified by:

getParameter in interface ParameterLegend

Returns:

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