com.esri.arcgis.system
Class LocaleInfo

java.lang.Object
  com.esri.arcgis.system.LocaleInfo

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, ILocaleInfo, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class LocaleInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocaleInfo, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IDocumentVersionSupportGEN, Externalizable

An object that represents a locale info.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

LocaleInfo()
Constructs a LocaleInfo using ArcGIS Engine.

LocaleInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocaleInfo theLocaleInfo = (LocaleInfo) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCountryID() Obtains country identifier.
String	getCountryName() English name of country.
String	getDisplayName() English display name of the locale.
int	getLanguageID() Obtains language identifier.
String	getLanguageName() English name of language.
int	getLocaleID() Obtains locale unique identifier.
String	getLocalizedCountryName() Localized name of country.
String	getLocalizedDisplayName() Localized display name of the locale.
String	getLocalizedLanguageName() Localized name of language.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getNativeCountryName() Native name of country.
String	getNativeLanguageName() Native name of language.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCountryID(int countryID) Obtains country identifier.
void	setCountryName(String country) English name of country.
void	setDisplayName(String displayName) English display name of the locale.
void	setLanguageID(int languageID) Obtains language identifier.
void	setLanguageName(String language) English name of language.
void	setLocaleID(int localeID) Obtains locale unique identifier.
void	setLocalizedCountryName(String country) Localized name of country.
void	setLocalizedDisplayName(String displayName) Localized display name of the locale.
void	setLocalizedLanguageName(String language) Localized name of language.
void	setNativeCountryName(String country) Native name of country.
void	setNativeLanguageName(String language) Native name of language.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

LocaleInfo

public LocaleInfo()
           throws IOException,
                  UnknownHostException

Constructs a LocaleInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LocaleInfo

public LocaleInfo(Object obj)
           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocaleInfo theLocaleInfo = (LocaleInfo) obj;

Construct a LocaleInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LocaleInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLocaleID

public int getLocaleID()
                throws IOException,
                       AutomationException

Obtains locale unique identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLocaleID in interface ILocaleInfo

Returns:

The localeID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocaleID

public void setLocaleID(int localeID)
                 throws IOException,
                        AutomationException

Obtains locale unique identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLocaleID in interface ILocaleInfo

Parameters:

localeID - The localeID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLanguageID

public int getLanguageID()
                  throws IOException,
                         AutomationException

Obtains language identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLanguageID in interface ILocaleInfo

Returns:

The languageID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLanguageID

public void setLanguageID(int languageID)
                   throws IOException,
                          AutomationException

Obtains language identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLanguageID in interface ILocaleInfo

Parameters:

languageID - The languageID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountryID

public int getCountryID()
                 throws IOException,
                        AutomationException

Obtains country identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCountryID in interface ILocaleInfo

Returns:

The countryID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCountryID

public void setCountryID(int countryID)
                  throws IOException,
                         AutomationException

Obtains country identifier.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCountryID in interface ILocaleInfo

Parameters:

countryID - The countryID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLanguageName

public String getLanguageName()
                       throws IOException,
                              AutomationException

English name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLanguageName in interface ILocaleInfo

Returns:

The language

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLanguageName

public void setLanguageName(String language)
                     throws IOException,
                            AutomationException

English name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLanguageName in interface ILocaleInfo

Parameters:

language - The language (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountryName

public String getCountryName()
                      throws IOException,
                             AutomationException

English name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCountryName in interface ILocaleInfo

Returns:

The country

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCountryName

public void setCountryName(String country)
                    throws IOException,
                           AutomationException

English name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCountryName in interface ILocaleInfo

Parameters:

country - The country (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

English display name of the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDisplayName in interface ILocaleInfo

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(String displayName)
                    throws IOException,
                           AutomationException

English display name of the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDisplayName in interface ILocaleInfo

Parameters:

displayName - The displayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalizedLanguageName

public String getLocalizedLanguageName()
                                throws IOException,
                                       AutomationException

Localized name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLocalizedLanguageName in interface ILocaleInfo

Returns:

The language

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocalizedLanguageName

public void setLocalizedLanguageName(String language)
                              throws IOException,
                                     AutomationException

Localized name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLocalizedLanguageName in interface ILocaleInfo

Parameters:

language - The language (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalizedCountryName

public String getLocalizedCountryName()
                               throws IOException,
                                      AutomationException

Localized name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLocalizedCountryName in interface ILocaleInfo

Returns:

The country

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocalizedCountryName

public void setLocalizedCountryName(String country)
                             throws IOException,
                                    AutomationException

Localized name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLocalizedCountryName in interface ILocaleInfo

Parameters:

country - The country (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalizedDisplayName

public String getLocalizedDisplayName()
                               throws IOException,
                                      AutomationException

Localized display name of the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLocalizedDisplayName in interface ILocaleInfo

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocalizedDisplayName

public void setLocalizedDisplayName(String displayName)
                             throws IOException,
                                    AutomationException

Localized display name of the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLocalizedDisplayName in interface ILocaleInfo

Parameters:

displayName - The displayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeLanguageName

public String getNativeLanguageName()
                             throws IOException,
                                    AutomationException

Native name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNativeLanguageName in interface ILocaleInfo

Returns:

The language

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNativeLanguageName

public void setNativeLanguageName(String language)
                           throws IOException,
                                  AutomationException

Native name of language.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setNativeLanguageName in interface ILocaleInfo

Parameters:

language - The language (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeCountryName

public String getNativeCountryName()
                            throws IOException,
                                   AutomationException

Native name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNativeCountryName in interface ILocaleInfo

Returns:

The country

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNativeCountryName

public void setNativeCountryName(String country)
                          throws IOException,
                                 AutomationException

Native name of country.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setNativeCountryName in interface ILocaleInfo

Parameters:

country - The country (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException