com.esri.aims.mtier.model.map.environment
Class Locale

java.lang.Object
  |
  +--com.esri.aims.mtier.model.map.environment.Locale
All Implemented Interfaces:
Serializable

public class Locale
extends Object
implements Serializable

Stores information that is used to determine the country and language locale. Locale is set after the Map object's InitMap method is called.

See Also:
Serialized Form

Constructor Summary
Locale()
          Constructs an instance of a Locale object.
 
Method Summary
 String getCountry()
          Returns the country associated with this Locale.
 String getLanguage()
          Returns the language associated with this Locale.
 String getVariant()
          Returns the variant value associated with this Locale.
 void setCountry(String value)
          Sets the country to be associated with this Locale.
 void setLanguage(String value)
          Sets the language to be associated with this Locale using given string.
 void setVariant(String value)
          Sets the variant using given string for this Locale.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Locale

public Locale()
Constructs an instance of a Locale object. Example:
Locale locale = new Locale();

Method Detail

setLanguage

public void setLanguage(String value)
Sets the language to be associated with this Locale using given string. Example:
locale.setLanguage("en");

Parameters:
value - the language value.
See Also:
getLanguage()

getLanguage

public String getLanguage()
Returns the language associated with this Locale. Example:
String lang = locale.getLanguage();

Returns:
the language name as a string
See Also:
setLanguage(java.lang.String)

setCountry

public void setCountry(String value)
Sets the country to be associated with this Locale. Example:
locale.setCountry("us");

Parameters:
value - the country value.
See Also:
getCountry()

getCountry

public String getCountry()
Returns the country associated with this Locale. Example: String country = locale.getCountry();

Returns:
the country name as a string
See Also:
setCountry(java.lang.String)

setVariant

public void setVariant(String value)
Sets the variant using given string for this Locale. Example:
locale.setVariant("_EURO");

Parameters:
value - the variant value.
See Also:
getVariant()

getVariant

public String getVariant()
Returns the variant value associated with this Locale. Example:
String variant = locale.getVariant();

Returns:
the variant value as a string
See Also:
setVariant(java.lang.String)