org.mapfish.print.map

Class Scale

java.lang.Object

org.mapfish.print.map.Scale

public final class Scale
extends java.lang.Object

Represent a scale and provide transformation.

Constructor Summary

Constructors

Constructor and Description
Scale(double denominator, org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi) Constructor.
Scale(double denominator, DistanceUnit projectionUnit, double dpi) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static Scale	fromResolution(double resolution) Construct a scale object from a resolution.
double	getDenominator(boolean geodetic, org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi, com.vividsolutions.jts.geom.Coordinate position)
static double	getDenominator(boolean geodetic, double scaleDenominator, org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi, com.vividsolutions.jts.geom.Coordinate position)
double	getDenominator(org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi)
double	getDenominator(DistanceUnit projectionUnit, double dpi)
double	getGeodeticDenominator(org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi, com.vividsolutions.jts.geom.Coordinate position)
static double	getGeodeticDenominator(double scaleDenominator, org.opengis.referencing.crs.CoordinateReferenceSystem projection, double dpi, com.vividsolutions.jts.geom.Coordinate position)
double	getResolution() Get the resolution.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scale

public Scale(double denominator,
             @Nonnull
             org.opengis.referencing.crs.CoordinateReferenceSystem projection,
             double dpi)

Constructor.

Parameters:

denominator - the scale denominator. a value of 1'000 would be a scale of 1:1'000.

projection - the projection.

dpi - the DPI on witch the scale is valid.

Scale

public Scale(double denominator,
             @Nonnull
             DistanceUnit projectionUnit,
             double dpi)

Constructor.

Parameters:

denominator - the scale denominator. a value of 1'000 would be a scale of 1:1'000.

projectionUnit - the unit used by the projection.

dpi - the DPI on witch the scale is valid.

Method Detail

getResolution

public double getResolution()

Get the resolution.

Returns:

the resolution

getDenominator

public double getDenominator(boolean geodetic,
                             @Nonnull
                             org.opengis.referencing.crs.CoordinateReferenceSystem projection,
                             double dpi,
                             com.vividsolutions.jts.geom.Coordinate position)

Parameters:

geodetic - geodetic mode.

projection - the projection to perform the calculation in.

dpi - the dpi of the display device.

position - the position on the map.

Returns:

the scale denominator

getDenominator

public double getDenominator(@Nonnull
                             org.opengis.referencing.crs.CoordinateReferenceSystem projection,
                             double dpi)

Parameters:

projection - the projection to perform the calculation in

dpi - the dpi of the display device.

Returns:

the scale denominator

getDenominator

public double getDenominator(@Nonnull
                             DistanceUnit projectionUnit,
                             double dpi)

Parameters:

projectionUnit - the projection unit

dpi - the dpi of the display device.

Returns:

the scale denominator

getGeodeticDenominator

public double getGeodeticDenominator(@Nonnull
                                     org.opengis.referencing.crs.CoordinateReferenceSystem projection,
                                     double dpi,
                                     com.vividsolutions.jts.geom.Coordinate position)

Parameters:

projection - the projection to perform the calculation in

dpi - the dpi of the display device.

position - the position on the map.

Returns:

the scale denominator

getDenominator

public static double getDenominator(boolean geodetic,
                                    double scaleDenominator,
                                    @Nonnull
                                    org.opengis.referencing.crs.CoordinateReferenceSystem projection,
                                    double dpi,
                                    com.vividsolutions.jts.geom.Coordinate position)

Parameters:

geodetic - Do in geodetic.

scaleDenominator - the scale denominator.

projection - the projection to perform the calculation in.

dpi - the dpi of the display device.

position - the position on the map.

Returns:

the scale denominator.

getGeodeticDenominator

public static double getGeodeticDenominator(double scaleDenominator,
                                            @Nonnull
                                            org.opengis.referencing.crs.CoordinateReferenceSystem projection,
                                            double dpi,
                                            com.vividsolutions.jts.geom.Coordinate position)

Parameters:

scaleDenominator - the scale denominator.

projection - the projection to perform the calculation in.

dpi - the dpi of the display device.

position - the position on the map.

Returns:

the scale denominator.

fromResolution

public static Scale fromResolution(double resolution)

Construct a scale object from a resolution.

Parameters:

resolution - the resolution of the map

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object