ilog.views.maps

Interface IlvCoordinateFormatter

All Superinterfaces:

IlvPersistentObject, Serializable

All Known Implementing Classes:

IlvAbstractCoordinateFormatter, IlvCoordinateFormatterDictionary.MGRSConverter, IlvDecimalCoordinateFormatter, IlvDMSCoordinateFormatter, IlvGeocentricCoordinateFormater, IlvGeodesicCoordinateFormatter, IlvUTMCoordinateFormatter

public interface IlvCoordinateFormatter
extends IlvPersistentObject

The IlvCoordinateFormatter is a utility interface used to manage a coordinate format. It converts points plotted along longitude-latitude coordinates to corresponding points in a target coordinate format. It usually expresses this conversion as a formatted string. For example, you would use the following commands to convert a point in longitude and latitude coordinates into a specified IlvCoordinateFormatter:

  // Get an instance of IlvCoordinateFormatter.
  IlvCoordinateFormatter  coordinateFormat  = ...;

  // Set the longitude and latitude of the point to convert.
  coordinateFormat.setLonLat(Math.PI/4,Math.PI/4);
  // Print the string representing the point in the new coordinate system.
  System.out.println(coordinateFormat.toString());
  ...

 

Conversely, you would use the following commands to convert a point whose representation in the coordinate format is defined by a string:

  // Get the string representation of a point in the IlvCoordinateFormatter.
  String pointRepresentation = "N12.5 E23.4";
  // Set it on an instance of IlvCoordinateFormatter
  coordinateFormat.parse(pointRepresentation);
  // Print the string representing the point in the new coordinate format.
  System.out.println("Longitude is : " + coordinateFormat.getLongitude()
                    + "Latitude is : " + coordinateFormat.getLatitude());
 

Since:

JViews 7.5

Method Summary

Modifier and Type	Method and Description
String	getAngleString(double angleRad) This method formats a single angle.
double	getLatitude() Returns the latitude of current point.
double	getLongitude() Returns the longitude of current point.
String	getOutputSeparator() Returns the output separator.
void	parse(String coordinatesString) Parse a formatted string containing a point's coordinates in this format.
void	setCoordinatePrecision(int precision) Sets the Sets the maximum number of digits allowed in the fraction portion of a coordinate.
void	setEllipsoid(IlvEllipsoid ellipsoid) Sets the ellipsoid associated with this coordinate format.
void	setLonLat(double xlongitude, double ylatitude) Sets latitude and longitude of the current point.
void	setOutputSeparator(String separator) Changes the separator string that will be used to separate the different parts of output string in the toString method.
void	setParseSeparator(char separatorChar) Changes the separator character that will be used to analyze the string passed to the parse method.
String	toString() Returns the string representation of current point in this format

Methods inherited from interface ilog.views.io.IlvPersistentObject

write

Method Detail

getLatitude

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

IllegalStateException - if formatter does not accept latitudes at this moment.

getLongitude

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.

parse

void parse(String coordinatesString)
    throws IllegalArgumentException

Parse a formatted string containing a point's coordinates in this format.

Parameters:

coordinatesString - string containing coordinate information.

Throws:

IllegalArgumentException - if string format is not valid.

setCoordinatePrecision

void setCoordinatePrecision(int precision)

Sets the Sets the maximum number of digits allowed in the fraction portion of a coordinate.

Parameters:

precision - precision to use for displaying coordinates.

setEllipsoid

void setEllipsoid(IlvEllipsoid ellipsoid)

Sets the ellipsoid associated with this coordinate format.

Parameters:

ellipsoid - ellipsoid to use for conversions.

setLonLat

void setLonLat(double xlongitude,
               double ylatitude)

Sets latitude and longitude of the current point.

Parameters:

xlongitude - longitude in radians.

ylatitude - latitude in radians.

setOutputSeparator

void setOutputSeparator(String separator)

Changes the separator string that will be used to separate the different parts of output string in the toString method.

Parameters:

separator - the separator string.

setParseSeparator

void setParseSeparator(char separatorChar)

Changes the separator character that will be used to analyze the string passed to the parse method.

Parameters:

separatorChar - the separator character

toString

String toString()

Returns the string representation of current point in this format

Overrides:

toString in class Object

Returns:

Returns the string representation of current point in this format

getAngleString

String getAngleString(double angleRad)
               throws UnsupportedOperationException

This method formats a single angle.

Parameters:

angleRad - angle in radians.

Returns:

the formatted string.

Throws:

UnsupportedOperationException - if the formatter does not support angles.

getOutputSeparator

String getOutputSeparator()

Returns the output separator.

Returns:

the output separator.