ilog.views.maps

Class IlvUTMCoordinateFormatter

java.lang.Object

ilog.views.maps.IlvAbstractCoordinateFormatter

ilog.views.maps.IlvUTMCoordinateFormatter

All Implemented Interfaces:

IlvPersistentObject, IlvCoordinateFormatter

Direct Known Subclasses:

IlvCoordinateFormatterDictionary.MGRSConverter

public class IlvUTMCoordinateFormatter
extends IlvAbstractCoordinateFormatter

The IlvUTMCoordinateFormatter utility class converts longitude and latitude values (expressed in radians) into either:

• Universal Transverse Mercator (UTM) coordinates: zone number, zone letter , grid square, easting on 5 digits, northing on 5 digits such as MGRS 60 V WQ 77438 21254.
• MGRS coordinates: zone number, zone letter, easting, northing, such as UTM 60 V 3277438 1221254.

Ellipsoid is initially set to WGS 84.

Since:

JViews 7.5

See Also:

This formater is only able to parse coordinates from an UTM coordinate string.

Constructor Summary

Constructors

Constructor and Description
IlvUTMCoordinateFormatter() Public constructor, using a default WGS84 ellipsoid
IlvUTMCoordinateFormatter(IlvInputStream stream) Creates a new IlvUTMCoordinateFormatter from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Overrides deep comparison equals.
String	getAngleString(double angleRad) This method is not supported by this coordinate formatter
double	getEasting() Returns the easting of the current point.
double	getLatitude() Returns the latitude of current point.
double	getLongitude() Returns the longitude of current point.
double	getNorthing() Returns the northing of the current point.
char	getZoneLetter() Returns the zone letter of the current point.
int	getZoneNumber() Returns the zone number of the current point.
boolean	isMGRSOutput() Indicates whether the coordinate output is UTM or MGRS.
void	parse(String coordinatesString) Parse a formatted string containing a point's coordinates in this system
void	setEllipsoid(IlvEllipsoid el) This method does nothing for UTM (Ellipsoid must be WGS84).
void	setLonLat(double longitude, double latitude) Sets latitude and longitude of the current point.
void	setMGRSOutput(boolean outputAsMGRS) Indicates whether the coordinate output are UTM or MGRS.
protected void	setupFormatters() This method is called after precision has been changed and should update the internal number formatters, if any.
void	setUTMPoint(double easting, double northing, int zNumber, char zLetter) Sets a point in UTM coordinates
String	toString() Returns the string representation of current point in this system.
void	write(IlvOutputStream stream) Writes the attributes of a persistent object.

Methods inherited from class ilog.views.maps.IlvAbstractCoordinateFormatter

getDecimalFormatSymbols, getEllipsoid, getInputSeparator, getOutputSeparator, getPrecision, hashCode, setCoordinatePrecision, setOutputSeparator, setParseSeparator, setPrecision

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvUTMCoordinateFormatter

public IlvUTMCoordinateFormatter()

Public constructor, using a default WGS84 ellipsoid

IlvUTMCoordinateFormatter

public IlvUTMCoordinateFormatter(IlvInputStream stream)
                          throws IlvReadFileException

Creates a new IlvUTMCoordinateFormatter from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if an error occurs while reading.

Method Detail

setEllipsoid

public void setEllipsoid(IlvEllipsoid el)

This method does nothing for UTM (Ellipsoid must be WGS84).

Specified by:

setEllipsoid in interface IlvCoordinateFormatter

Overrides:

setEllipsoid in class IlvAbstractCoordinateFormatter

Parameters:

el - ellipsoid to use for conversions.

See Also:

IlvAbstractCoordinateFormatter.setEllipsoid(ilog.views.maps.projection.IlvEllipsoid)

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of a persistent object.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvAbstractCoordinateFormatter

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

See Also:

IlvPersistentObject.write(ilog.views.io.IlvOutputStream)

getEasting

public double getEasting()
                  throws IllegalStateException

Returns the easting of the current point.

Returns:

Returns the easting of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system

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

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

getNorthing

public double getNorthing()
                   throws IllegalStateException

Returns the northing of the current point.

Returns:

Returns the northing of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system

getZoneLetter

public char getZoneLetter()
                   throws IllegalStateException

Returns the zone letter of the current point.

Returns:

Returns the zone letter of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system

getZoneNumber

public int getZoneNumber()
                  throws IllegalStateException

Returns the zone number of the current point.

Returns:

Returns the zone number of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system

parse

public void parse(String coordinatesString)
           throws IllegalArgumentException

Parse a formatted string containing a point's coordinates in this system

Parameters:

coordinatesString - 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)

setUTMPoint

public void setUTMPoint(double easting,
                        double northing,
                        int zNumber,
                        char zLetter)

Sets a point in UTM coordinates

Parameters:

easting - easting of the UTM coordinates

northing - northing of the UTM coordinates

zNumber - zone number of the UTM coordinates

zLetter - zone letter of the UTM coordinates

isMGRSOutput

public final boolean isMGRSOutput()

Indicates whether the coordinate output is UTM or MGRS.

Returns:

true if coordinate output is MGRS, false if coordinate output is UTM.

Since:

JViews 8.5

setMGRSOutput

public final void setMGRSOutput(boolean outputAsMGRS)

Indicates whether the coordinate output are UTM or MGRS. Default is false.

Parameters:

outputAsMGRS - If true the output coordinates are MGRS.

Since:

JViews 8.5

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

This method is not supported by this coordinate formatter

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)