IlvDMSCoordinateFormatter (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.IlvAbstractCoordinateFormatter
- - ilog.views.maps.IlvDMSCoordinateFormatter

All Implemented Interfaces:

IlvPersistentObject, IlvCoordinateFormatter, Serializable
```
public class IlvDMSCoordinateFormatter
extends IlvAbstractCoordinateFormatter
```
The IlvDMSCoordinateFormatter class is a utility class that converts longitude and latitude (measured in radians) into Degree-Minute-Second format such as N64&B0;53'12.09" E167&B0;47'06.84". If the coordinates cannot be parsed using default mechanism, IlvProjectionUtil.DMSToRadian(java.lang.String) will be used as fall back parser. Ellipsoid is not used in this implementation of IlvCoordinateFormatter.

Since:

JViews 7.5

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvDMSCoordinateFormatter()` Default constructor
`IlvDMSCoordinateFormatter(IlvInputStream stream)` Creates a new `IlvDecimalCoordinateFormatter` from an `IlvInputStream`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Overrides deep comparison equals.
`String`	`getAngleString(double angleRad)` Formats a single angle.
`double`	`getLatitude()` Returns the latitude of current point.
`int`	`getLatitudeDegrees()` Returns the longitude of current point.
`int`	`getLatitudeMinutes()` Returns the latitude minutes.
`double`	`getLatitudeSeconds()` Returns the latitude seconds.
`String`	`getLatitudeString()` Returns the latitude string.
`double`	`getLongitude()` Returns the longitude of current point.
`int`	`getLongitudeDegrees()` Returns the longitude in degrees.
`int`	`getLongitudeMinutes()` Returns the longitude minutes.
`double`	`getLongitudeSeconds()` Returns the longitude seconds.
`String`	`getLongitudeString()` Returns the longitude string.
`boolean`	`isEast()` Returns whether the point longitude is towards east (or west if false).
`boolean`	`isNorth()` Returns whether the point latitude is towards north (or south if false).
`void`	`parse(String pointString)` Parse a formatted string containing a point's coordinates in this system
`void`	`setLonLat(double longitude, double latitude)` Sets latitude and longitude of the current point.
`void`	`setLonLatDMS(int longitudeDegrees, int longitudeMinutes, double longitudeSeconds, boolean east, int latitudeDegrees, int latitudeMinutes, double latitudeSeconds, boolean north)` Sets a point in Degree-Minute-Second coordinates
`protected void`	`setupFormatters()` This method is called after precision has been changed and should update the internal number formatters, if any.
`String`	`toString()` Returns the string representation of current point in this system.

Methods inherited from class ilog.views.maps.IlvAbstractCoordinateFormatter
getDecimalFormatSymbols, getEllipsoid, getInputSeparator, getOutputSeparator, getPrecision, hashCode, setCoordinatePrecision, setEllipsoid, setOutputSeparator, setParseSeparator, setPrecision, write

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

- Constructor Detail
  - IlvDMSCoordinateFormatter
```
public IlvDMSCoordinateFormatter()
```
    Default constructor
  - IlvDMSCoordinateFormatter
```
public IlvDMSCoordinateFormatter(IlvInputStream stream)
                          throws IlvReadFileException
```
    Creates a new IlvDecimalCoordinateFormatter from an IlvInputStream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if an error occurs while reading.
- Method Detail
  - getLatitude
```
public double getLatitude()
                   throws IllegalStateException
```
    Returns the latitude of current point.
    
    Returns:
    
    Returns the latitude of current point.
    
    Throws:
    
    IllegalStateException - if coordinates were not set first on the system
  - getLatitudeDegrees
```
public int getLatitudeDegrees()
```
    Returns the longitude of current point.
    
    Returns:
    
    Returns the longitude of current point.
    
    Throws:
    
    IllegalStateException - if coordinates were not set first on the system
  - getLatitudeMinutes
```
public int getLatitudeMinutes()
```
    Returns the latitude minutes.
    
    Returns:
    
    Returns the latitude minutes.
  - getLatitudeSeconds
```
public double getLatitudeSeconds()
```
    Returns the latitude seconds.
    
    Returns:
    
    Returns the latitude seconds.
  - getLatitudeString
```
public String getLatitudeString()
```
    Returns the latitude string.
    
    Returns:
    
    Returns the latitude string.
  - getLongitude
```
public double getLongitude()
                    throws IllegalStateException
```
    Returns the longitude of current point.
    
    Returns:
    
    Returns the longitude of current point.
    
    Throws:
    
    IllegalStateException - if coordinates were not set first on the system
  - getLongitudeDegrees
```
public int getLongitudeDegrees()
```
    Returns the longitude in degrees.
    
    Returns:
    
    Returns the longitude in degrees.
  - getLongitudeMinutes
```
public int getLongitudeMinutes()
```
    Returns the longitude minutes.
    
    Returns:
    
    Returns the longitude minutes.
  - getLongitudeSeconds
```
public double getLongitudeSeconds()
```
    Returns the longitude seconds.
    
    Returns:
    
    Returns the longitude seconds.
  - getLongitudeString
```
public String getLongitudeString()
```
    Returns the longitude string.
    
    Returns:
    
    Returns the longitude string.
  - isEast
```
public boolean isEast()
```
    Returns whether the point longitude is towards east (or west if false).
    
    Returns:
    
    Returns whether the point longitude is towards east (or west if false).
  - isNorth
```
public boolean isNorth()
```
    Returns whether the point latitude is towards north (or south if false).
    
    Returns:
    
    Returns whether the point latitude is towards north (or south if false).
  - parse
```
public void parse(String pointString)
           throws IllegalArgumentException
```
    Parse a formatted string containing a point's coordinates in this system
    
    Parameters:
    
    pointString - the string to parse.
    
    Throws:
    
    IllegalArgumentException - if string format is not valid
  - setLonLat
```
public void setLonLat(double longitude,
                      double latitude)
```
    Sets latitude and longitude of the current point.
    
    Parameters:
    
    longitude - longitude in radians.
    
    latitude - latitude in radians.
    
    See Also:
    
    IlvCoordinateFormatter.setLonLat(double, double)
  - setLonLatDMS
```
public void setLonLatDMS(int longitudeDegrees,
                         int longitudeMinutes,
                         double longitudeSeconds,
                         boolean east,
                         int latitudeDegrees,
                         int latitudeMinutes,
                         double latitudeSeconds,
                         boolean north)
```
    Sets a point in Degree-Minute-Second coordinates
    
    Parameters:
    
    longitudeDegrees - longitude degrees
    
    longitudeMinutes - longitude minutes
    
    longitudeSeconds - longitude seconds
    
    east - is longitude east or west
    
    latitudeDegrees - latitude degrees
    
    latitudeMinutes - latitude minutes
    
    latitudeSeconds - latitude seconds
    
    north - is latitude north or south
  - toString
```
public String toString()
```
    Returns the string representation of current point in this system.
    
    Specified by:
    
    toString in interface IlvCoordinateFormatter
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    Returns the string representation of current point in this system.
  - setupFormatters
```
protected void setupFormatters()
```
    This method is called after precision has been changed and should update the internal number formatters, if any.
    
    Specified by:
    
    setupFormatters in class IlvAbstractCoordinateFormatter
    
    See Also:
    
    IlvAbstractCoordinateFormatter.setupFormatters()
  - getAngleString
```
public String getAngleString(double angleRad)
                      throws UnsupportedOperationException
```
    Formats a single angle.
    
    Parameters:
    
    angleRad - angle in radians.
    
    Returns:
    
    the formatted string.
    
    Throws:
    
    UnsupportedOperationException - if the formatter does not support angles.
    
    See Also:
    
    IlvCoordinateFormatter.getAngleString(double)
  - equals
```
public boolean equals(Object other)
```
    Overrides deep comparison equals.
    
    Overrides:
    
    equals in class IlvAbstractCoordinateFormatter
    
    See Also:
    
    Object.equals(java.lang.Object)

Class IlvDMSCoordinateFormatter

Constructor Summary

Method Summary

Methods inherited from class ilog.views.maps.IlvAbstractCoordinateFormatter

Methods inherited from class java.lang.Object

Constructor Detail

IlvDMSCoordinateFormatter

IlvDMSCoordinateFormatter

Method Detail

getLatitude

getLatitudeDegrees

getLatitudeMinutes

getLatitudeSeconds

getLatitudeString

getLongitude

getLongitudeDegrees

getLongitudeMinutes

getLongitudeSeconds

getLongitudeString

isEast

isNorth

parse

setLonLat

setLonLatDMS

toString

setupFormatters

getAngleString

equals