ilog.views.maps

Class IlvCoordinateFormatterDictionary

java.lang.Object

ilog.views.maps.IlvCoordinateFormatterDictionary

All Implemented Interfaces:

Serializable

public class IlvCoordinateFormatterDictionary
extends Object
implements Serializable

This class implements a dictionary providing facilities to retrieve the name of the available formatters as well as instances of these formatters.

Since:

JViews 7.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvCoordinateFormatterDictionary.MGRSConverter A UTM coordinate formatter that has by default an MGRS Output

Constructor Summary

Constructors

Constructor and Description
IlvCoordinateFormatterDictionary() Creates an instance of the formatter dictionary and initializes it with the formatters in the package.

Method Summary

Modifier and Type	Method and Description
IlvCoordinateFormatter	createFormatter(String name, IlvEllipsoid preferredEllipsoid) Returns the formatter corresponding to the string passed as argument.
Enumeration<String>	getFormatterNames() Returns a list of the formatters supported by the dictionary.
void	registerFormatter(String name, Class<?> formatterClass) Registers a new formatter.
boolean	unregisterFormatter(String name) Removes a formatter from the dictionary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvCoordinateFormatterDictionary

public IlvCoordinateFormatterDictionary()

Creates an instance of the formatter dictionary and initializes it with the formatters in the package.

Method Detail

createFormatter

public IlvCoordinateFormatter createFormatter(String name,
                                              IlvEllipsoid preferredEllipsoid)

Returns the formatter corresponding to the string passed as argument.

Parameters:

name - name of the formatter (must be in getFormatterNames enumeration)

preferredEllipsoid - ellipsoid to be used for precise computations (or null)

Returns:

Returns the formatter corresponding to the string passed as argument or null if the formatter is not known.

getFormatterNames

public Enumeration<String> getFormatterNames()

Returns a list of the formatters supported by the dictionary.

Returns:

Returns a list of the formatters supported by the dictionary.
The elements in the enumeration are instances of the class String.

registerFormatter

public void registerFormatter(String name,
                              Class<?> formatterClass)

Registers a new formatter.

Parameters:

name - the name of the formatter

formatterClass - the class that defines the formatter. This formatter class must inherit from the class IlvFormatter and have a constructor without argument.

unregisterFormatter

public boolean unregisterFormatter(String name)

Removes a formatter from the dictionary.

Parameters:

name - name of the formatter.

Returns:

true if the formatter was in the dictionary