org.orbisgis.legend.thematic.proportional

Class ProportionalLine

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantColorAndDashesLine

org.orbisgis.legend.thematic.proportional.ProportionalLine

All Implemented Interfaces:

IInterpolationLegend, Legend, LegendStructure, LookupFieldName, StrokeUom

public class ProportionalLine
extends ConstantColorAndDashesLine
implements IInterpolationLegend

A ProportionalLine represents a LineSymbolizer containing a PenStroke whose only varying parameter is the width of the line. This width is defined thanks to a linear interpolation made directly on the raw value (i.e. we don't apply any mathematical function to the input values).

Author:

Alexis Guéganno

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ProportionalLine()
ProportionalLine(LineSymbolizer symbolizer) Tries to build a new ProportionalLine from the given LineSymbolizer.
ProportionalLine(LineSymbolizer symbolizer, ProportionalStrokeLegend legend) Build a new ProportionalLine instance from the given symbolizer and legend.

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	getLegendTypeId() Returns an Id that will be used to check that a Legend can be edited with a given edition panel.
String	getLegendTypeName() Returns a string that describes - for human - the nature of the thematic analysis made in 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.
ProportionalStrokeLegend	getStrokeLegend() Get the LegendStructure associated to the Stroke of this ConstantColorAndDashesLine.
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.thematic.ConstantColorAndDashesLine

getLineColor, getStrokeUom, getSymbolizer, setLineColor, setStrokeUom

Methods inherited from class org.orbisgis.legend.thematic.SymbolizerLegend

getMaxScale, getMinScale, getName, setMaxScale, setMinScale, setName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Constructor Detail

ProportionalLine

public ProportionalLine()

ProportionalLine

public ProportionalLine(LineSymbolizer symbolizer)

Tries to build a new ProportionalLine from the given LineSymbolizer. If a ProportionalLine can't be built, an IllegalArgumentException is thrown.

Parameters:

symbolizer -

ProportionalLine

public ProportionalLine(LineSymbolizer symbolizer,
                ProportionalStrokeLegend legend)

Build a new ProportionalLine instance from the given symbolizer and legend. As the inner analysis is given directly with the symbolizer, we won't check they match. It is up to the caller to check they do.

Parameters:

symbolizer -

legend -

Method Detail

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

getStrokeLegend

public ProportionalStrokeLegend getStrokeLegend()

Description copied from class: ConstantColorAndDashesLine

Get the LegendStructure associated to the Stroke of this ConstantColorAndDashesLine. This method is abstract, as it is the only particularity of the implementations.

Specified by:

getStrokeLegend in class ConstantColorAndDashesLine

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

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

getLegendTypeName

public String getLegendTypeName()

Description copied from interface: Legend

Returns a string that describes - for human - the nature of the thematic analysis made in this Legend.

Specified by:

getLegendTypeName in interface Legend

Returns:

getLegendTypeId

public String getLegendTypeId()

Description copied from interface: Legend

Returns an Id that will be used to check that a Legend can be edited with a given edition panel.

Specified by:

getLegendTypeId in interface Legend

Overrides:

getLegendTypeId in class SymbolizerLegend

Returns: