ilog.views.maps

Class IlvDecimalCoordinateFormatter

java.lang.Object

ilog.views.maps.IlvAbstractCoordinateFormatter

ilog.views.maps.IlvDecimalCoordinateFormatter

All Implemented Interfaces:

IlvPersistentObject, IlvCoordinateFormatter

public class IlvDecimalCoordinateFormatter
extends IlvAbstractCoordinateFormatter

IlvDecimalCoordinateFormatter allows the user to enter a decimal based latitude or longitude as degrees. For example, 12.521 33.435.

This implementation is based on the formatter returned by NumberFormat.getInstance(java.util.Locale) .

Note: ellipsoid is not used in this implementation of IlvCoordinateFormatter.

Since:

JViews 7.5

See Also:

IlvCoordinateFormatter

Constructor Summary

Constructors

Constructor and Description
IlvDecimalCoordinateFormatter() The default constructor.
IlvDecimalCoordinateFormatter(IlvInputStream stream) Creates a new IlvDecimalCoordinateFormatter 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 formats a single angle.
double	getLatitude() Returns the latitude of the current point.
String	getLatitudeString() Returns the latitude part of the formatted string.
double	getLongitude() Returns the longitude of the current point.
String	getLongitudeString() Returns the longitude part of the formatted string.
int	hashCode()
void	parse(String coordinatesString) Parses a formatted string containing a point's coordinates in this format.
void	setLonLat(double longitude, double latitude) Sets the latitude and longitude of the current point.
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 format.

Methods inherited from class ilog.views.maps.IlvAbstractCoordinateFormatter

getDecimalFormatSymbols, getEllipsoid, getInputSeparator, getOutputSeparator, getPrecision, setCoordinatePrecision, setEllipsoid, setOutputSeparator, setParseSeparator, setPrecision, write

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDecimalCoordinateFormatter

public IlvDecimalCoordinateFormatter()

The default constructor.

IlvDecimalCoordinateFormatter

public IlvDecimalCoordinateFormatter(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 the current point.

Returns:

The latitude of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system

See Also:

IlvCoordinateFormatter.getLatitude()

getLatitudeString

public String getLatitudeString()

Returns the latitude part of the formatted string.

Returns:

The latitude part of the formatted string.

getLongitude

public double getLongitude()
                    throws IllegalStateException

Returns the longitude of the current point.

Returns:

The longitude part of the current point.

Throws:

IllegalStateException - if coordinates were not set first on the system.

See Also:

IlvCoordinateFormatter.getLongitude()

getLongitudeString

public String getLongitudeString()

Returns the longitude part of the formatted string.

Returns:

The longitude part of the formatted string.

parse

public void parse(String coordinatesString)
           throws IllegalArgumentException

Parses 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.

See Also:

IlvCoordinateFormatter.parse(java.lang.String)

setLonLat

public void setLonLat(double longitude,
                      double latitude)

Sets the latitude and longitude of the current point.

Parameters:

longitude - longitude in radians.

latitude - latitude in radians.

See Also:

IlvCoordinateFormatter.setLonLat(double, double)

toString

public String toString()

Returns the string representation of current point in this format.

Specified by:

toString in interface IlvCoordinateFormatter

Overrides:

toString in class Object

Returns:

Returns the string representation of current point in this format

See Also:

IlvCoordinateFormatter.toString()

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

hashCode

public int hashCode()

Overrides:

hashCode in class IlvAbstractCoordinateFormatter

equals

public boolean equals(Object other)

Overrides deep comparison equals.

Overrides:

equals in class IlvAbstractCoordinateFormatter

See Also:

Object.equals(java.lang.Object)