org.orbisgis.legend.structure.stroke

Class ProportionalStrokeLegend

java.lang.Object

org.orbisgis.legend.structure.stroke.PenStrokeLegend

org.orbisgis.legend.structure.stroke.ConstantColorAndDashesPSLegend

org.orbisgis.legend.structure.stroke.ProportionalStrokeLegend

All Implemented Interfaces:

IInterpolationLegend, LegendStructure, LookupFieldName, StrokeLegend

public class ProportionalStrokeLegend
extends ConstantColorAndDashesPSLegend
implements IInterpolationLegend

PenStroke is defined using a Width attribute, which is a RealAttribute. Consequently, it can be defined as linearly interpolated upon some numeric attribute. This way, we obtain a "proportional line" analysis.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ProportionalStrokeLegend() Builds an empty ProportionalStrokeLegend.
ProportionalStrokeLegend(PenStroke penStroke) Builds a ProportionalStrokeLegend from the given PenStroke.
ProportionalStrokeLegend(PenStroke penStroke, LinearInterpolationLegend width, ConstantFillLegend fill, LegendStructure dashes) Build a new ProportionalStrokeLegend, using the given PenStroke.

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.stroke.ConstantColorAndDashesPSLegend

getDashArray, getLineColor, getLineOpacity, setDashArray, setLineColor, setLineOpacity

Methods inherited from class org.orbisgis.legend.structure.stroke.PenStrokeLegend

getDashLegend, getFillAnalysis, getLineWidthLegend, getStroke, getStrokeUom, setDashLegend, setLineWidthLegend, setStrokeUom

Methods inherited from class java.lang.Object

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

Constructor Detail

ProportionalStrokeLegend

public ProportionalStrokeLegend()

Builds an empty ProportionalStrokeLegend. It will change 0 to 0 and 1 to 1. The lookup field can't be properly set from this method, it's up to the caller to do it.

ProportionalStrokeLegend

public ProportionalStrokeLegend(PenStroke penStroke)

Builds a ProportionalStrokeLegend from the given PenStroke. We suppose the given parameter has been validated. Otherwise, we will receive ClassCastException during initialization.

Parameters:

penStroke -

ProportionalStrokeLegend

public ProportionalStrokeLegend(PenStroke penStroke,
                        LinearInterpolationLegend width,
                        ConstantFillLegend fill,
                        LegendStructure dashes)

Build a new ProportionalStrokeLegend, using the given PenStroke.

Parameters:

penStroke -

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

setLookupFieldName

public void setLookupFieldName(String name)

Description copied from interface: LookupFieldName

Sets the field name.

Specified by:

setLookupFieldName in interface LookupFieldName

Parameters:

name - Name

getLookupFieldName

public String getLookupFieldName()

Description copied from interface: LookupFieldName

Gets the field name.

Specified by:

getLookupFieldName in interface LookupFieldName

Returns:

The field name