org.orbisgis.legend.thematic.proportional

Class ProportionalPoint

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantFormPoint

org.orbisgis.legend.thematic.proportional.ProportionalPoint

All Implemented Interfaces:

IInterpolationLegend, Legend, LegendStructure, LookupFieldName, IUniqueSymbolArea, IUniqueSymbolLine, UniqueSymbol, OnVertexOnInterior, StrokeUom, SymbolUom

public class ProportionalPoint
extends ConstantFormPoint
implements IUniqueSymbolArea, IInterpolationLegend

A ProportionalPoint is a ConstantFormPoint whose ViewBox is defined so that it can be recognized as a MonovariateProportionalViewBox.

Author:

Alexis Guéganno

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ProportionalPoint() Builds a new ProportionalPoint.
ProportionalPoint(PointSymbolizer pointSymbolizer) Tries to build an instance of ProportionalPoint using the given PointSymbolizer.
ProportionalPoint(PointSymbolizer symbolizer, ProportionalWKNLegend graphicLegend) Create a new ProportionalPoint.

Method Summary

Methods

Modifier and Type	Method and Description
ConstantSolidFill	getFillLegend() Gets the Fill analysis embedded in this IUniqueSymbolArea.
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.
ConstantFormWKN	getMarkGraphic() Gets the MarkGraphicLegend that must be associated to the inner PointSymbolizer.
ConstantPenStroke	getPenStroke() Gets the analysis associated to the inner PenStroke.
double	getSecondData() Gets the data of the second interpolation point.
double	getSecondValue() Gets the value of the second interpolation point as a double.
void	setFillLegend(ConstantSolidFill csf) Sets the Fill analysis embedded in this IUniqueSymbolArea.
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	setPenStroke(ConstantPenStroke cpsl) Sets the analysis associated to the inner PenStroke.
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.ConstantFormPoint

getStrokeUom, getSymbolizer, getSymbolUom, getWellKnownName, isOnVertex, setOnInterior, setOnVertex, setStrokeUom, setSymbolUom, setWellKnownName

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

Methods inherited from interface org.orbisgis.legend.Legend

getMaxScale, getMinScale, getName, getSymbolizer, setMaxScale, setMinScale, setName

Field Detail

NAME

public static final String NAME

Constructor Detail

ProportionalPoint

public ProportionalPoint()

Builds a new ProportionalPoint. It has default MarkGraphic parameters except for the ViewBox, of course.

ProportionalPoint

public ProportionalPoint(PointSymbolizer pointSymbolizer)

Tries to build an instance of ProportionalPoint using the given PointSymbolizer.

Parameters:

pointSymbolizer -

Throws:

IllegalArgumentException - If pointSymbolizer can't be recognized as a valid UniqueSymbolPoint.

ProportionalPoint

public ProportionalPoint(PointSymbolizer symbolizer,
                 ProportionalWKNLegend graphicLegend)

Create a new ProportionalPoint. As the associated analysis is given in parameter, it is up to the calling method to be sure that

Parameters:

symbolizer -

graphicLegend -

Method Detail

getMarkGraphic

public ConstantFormWKN getMarkGraphic()

Description copied from class: ConstantFormPoint

Gets the MarkGraphicLegend that must be associated to the inner PointSymbolizer.

Specified by:

getMarkGraphic in class ConstantFormPoint

Returns:

An instance of MarkGraphicLegend.

getFillLegend

public ConstantSolidFill getFillLegend()

Gets the Fill analysis embedded in this IUniqueSymbolArea.

Specified by:

getFillLegend in interface IUniqueSymbolArea

Returns:

setFillLegend

public void setFillLegend(ConstantSolidFill csf)

Sets the Fill analysis embedded in this IUniqueSymbolArea.

Specified by:

setFillLegend in interface IUniqueSymbolArea

Parameters:

csf -

getPenStroke

public ConstantPenStroke getPenStroke()

Gets the analysis associated to the inner PenStroke.

Specified by:

getPenStroke in interface IUniqueSymbolLine

Returns:

setPenStroke

public void setPenStroke(ConstantPenStroke cpsl)

Sets the analysis associated to the inner PenStroke.

Specified by:

setPenStroke in interface IUniqueSymbolLine

Parameters:

cpsl -

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

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

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: