org.orbisgis.legend.structure.graphic

Class ProportionalWKNLegend

java.lang.Object

org.orbisgis.legend.structure.graphic.MarkGraphicLegend

org.orbisgis.legend.structure.graphic.ConstantFormWKN

org.orbisgis.legend.structure.graphic.ProportionalWKNLegend

All Implemented Interfaces:

IInterpolationLegend, LegendStructure, LookupFieldName

public class ProportionalWKNLegend
extends ConstantFormWKN
implements IInterpolationLegend

This class is used to describe instances of MarkGraphic that embeds a simple proportional symbol configuration, associated to a WKN graphic.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ProportionalWKNLegend() Builds a new ProportionalWKNLegend with a default MonovariateProportionalViewBox.
ProportionalWKNLegend(MarkGraphic mark)
ProportionalWKNLegend(MarkGraphic mark, StringLiteralLegend wknLegend, MonovariateProportionalViewBox viewBoxLegend, ConstantSolidFillLegend fillLegend, ConstantPenStrokeLegend strokeLegend) Build a new instance of this Legend specialization.

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.
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.
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.graphic.ConstantFormWKN

getPenStroke, getSolidFill, getStrokeUom, getSymbolUom, getWellKnownName, setPenStroke, setStrokeUom, setSymbolUom, setWellKnownName

Methods inherited from class org.orbisgis.legend.structure.graphic.MarkGraphicLegend

getFillLegend, getMarkGraphic, getStrokeLegend, getViewBoxLegend, getWknLegend, setFillLegend, setMarkGraphic, setStrokeLegend, setViewBoxLegend, setWknLegend

Methods inherited from class java.lang.Object

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

Constructor Detail

ProportionalWKNLegend

public ProportionalWKNLegend()

Builds a new ProportionalWKNLegend with a default MonovariateProportionalViewBox.

ProportionalWKNLegend

public ProportionalWKNLegend(MarkGraphic mark)

ProportionalWKNLegend

public ProportionalWKNLegend(MarkGraphic mark,
                     StringLiteralLegend wknLegend,
                     MonovariateProportionalViewBox viewBoxLegend,
                     ConstantSolidFillLegend fillLegend,
                     ConstantPenStrokeLegend strokeLegend)

Build a new instance of this Legend specialization.

Parameters:

mark -

wknLegend -

viewBoxLegend -

fillLegend -

strokeLegend -

Method Detail

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

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

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

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