JMapUnit (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.client.views.JMapUnit

All Implemented Interfaces:

java.io.Serializable
```
public class JMapUnit
extends java.lang.Object
implements java.io.Serializable
```
This class represents a map unit

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static JMapUnit`	`CENTIMETER`
`static double`	`CM_TO_INCH` Value of the ratio used to convert centimeters in inches
`static JMapUnit`	`DEGREE`
`static int`	`DEGREE_DECIMAL`
`static int`	`DEGREE_MINUTE_SEC`
`static JMapUnit`	`FEET`
`static int`	`FEET_IN_A_MILE` Numbers of feet in a mile
`static double`	`FEET_TO_M` Value of the ratio used to convert feets to meters
`byte`	`id`
`static JMapUnit`	`INCH`
`static double`	`INCH_TO_CM` Value of the ratio used to convert inches to centimeters
`static byte`	`JMAP_UNIT_CM` byte to identify that the unit is in centimeters
`static byte`	`JMAP_UNIT_DEG` byte to identify that the unit is in degrees
`static byte`	`JMAP_UNIT_FT` byte to identify that the unit is in feet
`static byte`	`JMAP_UNIT_IN` byte to identify that the unit is in inches
`static byte`	`JMAP_UNIT_KM` byte to identify that the unit is in kilometers
`static byte`	`JMAP_UNIT_M` byte to identify that the unit is in meters
`static byte`	`JMAP_UNIT_MI` byte to identify that the unit is in miles
`static byte`	`JMAP_UNIT_MM` byte to identify that the unit is in millimeters
`static byte`	`JMAP_UNIT_N_MI` byte to identify that the unit is in nautical miles
`static byte`	`JMAP_UNIT_OTHER` byte to identify that the unit used not part of our list
`static byte`	`JMAP_UNIT_TENTH_MM` byte to identify that the unit is in tenth of millimeters
`static byte`	`JMAP_UNIT_YR` byte to identify that the unit is in yards
`static JMapUnit`	`KILOMETER`
`static double`	`M_TO_FEET` Value of the ratio used to convert meters to feet
`static JMapUnit`	`METER`
`static JMapUnit`	`MILE`
`static double`	`MILES_IN_A_DEGRE` numbers of miles in a degre Degrees of latitude are parallel so the distance between each degree remains almost constant but since degrees of longitude are farthest apart at the equator and converge at the poles, their distance varies greatly.
`static JMapUnit`	`MILLIMETER` 4378176 JMap, 4374754.0 GeoServer, MapServer
`static JMapUnit`	`NAUTICAL_MILE`
`double`	`scaleConst`
`static JMapUnit`	`TENTH_MILLIMETERS`
`static JMapUnit`	`YARD`

Constructor Summary

Constructors
Constructor and Description
`JMapUnit()`
`JMapUnit(byte id, double scaleConst, boolean cartesian, int option, java.lang.String xLabel, java.lang.String yLabel)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static double`	`convert(double value, JMapUnit fromUnit, JMapUnit toUnit)` Returns the distance value converted from the specified unit to the specified unit.
`static double[]`	`convertDegDecToDegMinSec(double degDec)` this method converts a value in degrees decimal to degree minute second NOTE: If the degree value is negative, the minutes and seconds will also be negative, so for display purposes, the absolute value should be used for minutes and seconds
`static double`	`convertDegMinSecToDegDec(double[] degMinSec)` This method converts a value in degree minute seconds to degrees decimal Note: if degree is negative, it assumes that minutes and seconds are also negative.
`static double`	`convertSurface(double value, JMapUnit fromUnit, JMapUnit toUnit)` Returns the surface value converted from the specified unit to the specified unit.
`boolean`	`equals(java.lang.Object o)` This method overrides equals()
`java.lang.String`	`getAbbreviation()`
`byte`	`getId()`
`static JMapUnit`	`getJMapUnit(java.lang.String JMapUnitName)` This method returns a JMapUnit instance from the name representing the unit in the current locale
`java.lang.String`	`getLocalizedKey()` Returns the localized key of the JMapUnit instance.
`java.lang.String`	`getName()` Returns the name of the JMapUnit instance.
`int`	`getOption()`
`double`	`getScaleConst()` Returns the scale constant of the JMapUnit instance.
`static JMapUnit`	`getUnit(byte unit)` This method returns a JMapUnit instance from the byte representing the unit.
`double`	`getUnitFactor()` Deprecated. use getScaleConst() instead
`static double`	`getUnitFactor(byte unitId)` Deprecated. Use instance method instead.
`java.lang.String`	`getXLabel()`
`java.lang.String`	`getYLabel()`
`boolean`	`isCartesian()`
`void`	`setCartesian(boolean cartesian)`
`void`	`setOption(int option)`
`void`	`setScaleConst(double scaleConst)`
`void`	`setXLabel(java.lang.String label)`
`void`	`setYLabel(java.lang.String label)`
`java.lang.String`	`toString()` This method overrides toString()
`static java.util.Enumeration<JMapUnit>`	`units()` Returns an enumeration of the units available for use in a View object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CM_TO_INCH
```
public static final double CM_TO_INCH
```
    Value of the ratio used to convert centimeters in inches
    
    See Also:
    
    Constant Field Values
  - INCH_TO_CM
```
public static final double INCH_TO_CM
```
    Value of the ratio used to convert inches to centimeters
    
    See Also:
    
    Constant Field Values
  - FEET_TO_M
```
public static final double FEET_TO_M
```
    Value of the ratio used to convert feets to meters
    
    See Also:
    
    Constant Field Values
  - M_TO_FEET
```
public static final double M_TO_FEET
```
    Value of the ratio used to convert meters to feet
    
    See Also:
    
    Constant Field Values
  - MILES_IN_A_DEGRE
```
public static final double MILES_IN_A_DEGRE
```
    numbers of miles in a degre Degrees of latitude are parallel so the distance between each degree remains almost constant but since degrees of longitude are farthest apart at the equator and converge at the poles, their distance varies greatly. Each degree of latitude is approximately 69 miles (111 kilometers) apart. The range varies (due to the earth's slightly ellipsoid shape) from 68.703 miles (110.567 km) at the equator to 69.407 (111.699 km) at the poles. This is convenient because each minute (1/60th of a degree) is approximately one mile. A degree of longitude is widest at the equator at 69.172 miles (111.321) and gradually shrinks to zero at the poles. At 40° north or south the distance between a degree of longitude is 53 miles (85 km).
    
    See Also:
    
    Constant Field Values
  - FEET_IN_A_MILE
```
public static final int FEET_IN_A_MILE
```
    Numbers of feet in a mile
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_M
```
public static final byte JMAP_UNIT_M
```
    byte to identify that the unit is in meters
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_KM
```
public static final byte JMAP_UNIT_KM
```
    byte to identify that the unit is in kilometers
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_CM
```
public static final byte JMAP_UNIT_CM
```
    byte to identify that the unit is in centimeters
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_MM
```
public static final byte JMAP_UNIT_MM
```
    byte to identify that the unit is in millimeters
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_TENTH_MM
```
public static final byte JMAP_UNIT_TENTH_MM
```
    byte to identify that the unit is in tenth of millimeters
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_FT
```
public static final byte JMAP_UNIT_FT
```
    byte to identify that the unit is in feet
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_MI
```
public static final byte JMAP_UNIT_MI
```
    byte to identify that the unit is in miles
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_IN
```
public static final byte JMAP_UNIT_IN
```
    byte to identify that the unit is in inches
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_YR
```
public static final byte JMAP_UNIT_YR
```
    byte to identify that the unit is in yards
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_N_MI
```
public static final byte JMAP_UNIT_N_MI
```
    byte to identify that the unit is in nautical miles
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_DEG
```
public static final byte JMAP_UNIT_DEG
```
    byte to identify that the unit is in degrees
    
    See Also:
    
    Constant Field Values
  - JMAP_UNIT_OTHER
```
public static final byte JMAP_UNIT_OTHER
```
    byte to identify that the unit used not part of our list
    
    See Also:
    
    Constant Field Values
  - DEGREE_DECIMAL
```
public static final int DEGREE_DECIMAL
```
    See Also:
    
    Constant Field Values
  - DEGREE_MINUTE_SEC
```
public static final int DEGREE_MINUTE_SEC
```
    See Also:
    
    Constant Field Values
  - MILLIMETER
```
public static final JMapUnit MILLIMETER
```
    4378176 JMap, 4374754.0 GeoServer, MapServer
  - CENTIMETER
```
public static final JMapUnit CENTIMETER
```
  - METER
```
public static final JMapUnit METER
```
  - KILOMETER
```
public static final JMapUnit KILOMETER
```
  - INCH
```
public static final JMapUnit INCH
```
  - FEET
```
public static final JMapUnit FEET
```
  - YARD
```
public static final JMapUnit YARD
```
  - MILE
```
public static final JMapUnit MILE
```
  - NAUTICAL_MILE
```
public static final JMapUnit NAUTICAL_MILE
```
  - TENTH_MILLIMETERS
```
public static final JMapUnit TENTH_MILLIMETERS
```
  - DEGREE
```
public static final JMapUnit DEGREE
```
  - id
```
public byte id
```
  - scaleConst
```
public double scaleConst
```
- Constructor Detail
  - JMapUnit
```
public JMapUnit()
```
  - JMapUnit
```
public JMapUnit(byte id,
                double scaleConst,
                boolean cartesian,
                int option,
                java.lang.String xLabel,
                java.lang.String yLabel)
```
- Method Detail
  - getUnit
```
public static JMapUnit getUnit(byte unit)
```
    This method returns a JMapUnit instance from the byte representing the unit.
    
    Returns:
    
    the corresponding new JMapUnit instance
  - getJMapUnit
```
public static JMapUnit getJMapUnit(java.lang.String JMapUnitName)
```
    This method returns a JMapUnit instance from the name representing the unit in the current locale
    
    Returns:
    
    the corresponding new JMapUnit instance, null if no unit corresponds to the name
  - getUnitFactor
```
@Deprecated
public static double getUnitFactor(byte unitId)
```
    Deprecated. Use instance method instead.
    
    Returns the unit factor of the JMapUnit object identified by unitId. The unit factor is the number of inches contained in the unit.
    
    Parameters:
    
    unitId - the id of the requested unit object
    
    Returns:
    
    the unit factor of the JMapUnit object identified by unitId
  - getUnitFactor
```
@Deprecated
public double getUnitFactor()
```
    Deprecated. use getScaleConst() instead
    
    Returns the unit factor of the JMapUnit instance. The unit factor is the number of inches contained in the unit.
    
    Returns:
    
    the unit factor of the JMapUnit instance
  - getName
```
public java.lang.String getName()
```
    Returns the name of the JMapUnit instance.
  - getLocalizedKey
```
public java.lang.String getLocalizedKey()
```
    Returns the localized key of the JMapUnit instance.
  - getId
```
public byte getId()
```
  - units
```
public static java.util.Enumeration<JMapUnit> units()
```
    Returns an enumeration of the units available for use in a View object.
    
    Returns:
    
    the enumeration of JMapUnit objects
  - convert
```
public static double convert(double value,
                             JMapUnit fromUnit,
                             JMapUnit toUnit)
```
    Returns the distance value converted from the specified unit to the specified unit.
    
    Parameters:
    
    value - the value to convert
    
    fromUnit - JMapUnit object representing the unit to convert from
    
    toUnit - JMapUnit object representing the unit to convert to
    
    Returns:
    
    the converted distance value
  - convertSurface
```
public static double convertSurface(double value,
                                    JMapUnit fromUnit,
                                    JMapUnit toUnit)
```
    Returns the surface value converted from the specified unit to the specified unit.
    
    Parameters:
    
    value - the value to convert
    
    fromUnit - JMapUnit object representing the unit to convert from
    
    toUnit - JMapUnit object representing the unit to convert to
    
    Returns:
    
    the converted surface value
  - toString
```
public java.lang.String toString()
```
    This method overrides toString()
    
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    This method overrides equals()
    
    Overrides:
    
    equals in class java.lang.Object
  - isCartesian
```
public boolean isCartesian()
```
    Returns:
    
    true if this unit is a cartesian unit, false if it is a spherical unit
  - getOption
```
public int getOption()
```
    Returns:
    
    Returns the option.
  - setOption
```
public void setOption(int option)
```
    Parameters:
    
    option - The option to set.
  - getXLabel
```
public java.lang.String getXLabel()
```
    Returns:
    
    Returns the label for the 'x' coordinate
  - setXLabel
```
public void setXLabel(java.lang.String label)
```
    Parameters:
    
    label - the label for the 'x' coordinate
  - getYLabel
```
public java.lang.String getYLabel()
```
    Returns:
    
    Returns the label for the 'y' coordinate
  - setYLabel
```
public void setYLabel(java.lang.String label)
```
    Parameters:
    
    label - the label for the 'y' coordinate
  - getScaleConst
```
public double getScaleConst()
```
    Returns the scale constant of the JMapUnit instance. The scale constant is the number of inches contained in the unit.
    
    Returns:
    
    the scale constant of the JMapUnit instance
  - setScaleConst
```
public void setScaleConst(double scaleConst)
```
  - setCartesian
```
public void setCartesian(boolean cartesian)
```
  - getAbbreviation
```
public java.lang.String getAbbreviation()
```
  - convertDegDecToDegMinSec
```
public static double[] convertDegDecToDegMinSec(double degDec)
```
    this method converts a value in degrees decimal to degree minute second NOTE: If the degree value is negative, the minutes and seconds will also be negative, so for display purposes, the absolute value should be used for minutes and seconds
    
    Parameters:
    
    degDec - the value in degrees decimal
    
    Returns:
    
    an array containing the 3 double values: 1) degree 2) minute 3) seconds
  - convertDegMinSecToDegDec
```
public static double convertDegMinSecToDegDec(double[] degMinSec)
```
    This method converts a value in degree minute seconds to degrees decimal Note: if degree is negative, it assumes that minutes and seconds are also negative. if they are not, they are automatically inverted Ex: deg.min.sec = [-1,15,15] will become deg.dec.= -1.2525 and not -0.7575.
    
    Parameters:
    
    degMinSec - a double array containing the values: 1) degree 2) minute 3) seconds
    
    Returns:
    
    the converted value in degree decimal

Class JMapUnit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CM_TO_INCH

INCH_TO_CM

FEET_TO_M

M_TO_FEET

MILES_IN_A_DEGRE

FEET_IN_A_MILE

JMAP_UNIT_M

JMAP_UNIT_KM

JMAP_UNIT_CM

JMAP_UNIT_MM

JMAP_UNIT_TENTH_MM

JMAP_UNIT_FT

JMAP_UNIT_MI

JMAP_UNIT_IN

JMAP_UNIT_YR

JMAP_UNIT_N_MI

JMAP_UNIT_DEG

JMAP_UNIT_OTHER

DEGREE_DECIMAL

DEGREE_MINUTE_SEC

MILLIMETER

CENTIMETER

METER

KILOMETER

INCH

FEET

YARD

MILE

NAUTICAL_MILE

TENTH_MILLIMETERS

DEGREE

id

scaleConst

Constructor Detail

JMapUnit

JMapUnit

Method Detail

getUnit

getJMapUnit

getUnitFactor

getUnitFactor

getName

getLocalizedKey

getId

units

convert

convertSurface

toString

equals

isCartesian

getOption

setOption

getXLabel

setXLabel

getYLabel

setYLabel

getScaleConst

setScaleConst

setCartesian

getAbbreviation

convertDegDecToDegMinSec

convertDegMinSecToDegDec