com.esri.arcgis.gisclient
Class WMSConnection

java.lang.Object
  com.esri.arcgis.gisclient.WMSConnection

All Implemented Interfaces:

IWMSConnection, IWMSServiceDescription, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class WMSConnection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWMSConnection, IWMSServiceDescription, ISupportErrorInfo

COM Class 'WMSConnection'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriGISClient.olb'

Description 'The Connection for WMS.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.gisclient.IWMSConnection

IID, IID67bc7de0_0a6d_4ba6_9d26_437c44dbddf3, xxDummy

Fields inherited from interface com.esri.arcgis.gisclient.IWMSServiceDescription

IID, IIDde0e6ebf_8abf_4700_b9f5_b097e14c0e51, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

WMSConnection()
Constructs a WMSConnection using ArcGIS Engine.

WMSConnection(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WMSConnection theWMSConnection = (WMSConnection) obj;

Method Summary

void	addIWMSClientEventsListener(IWMSClientEvents theListener) addIWMSClientEventsListener.
boolean	equals(java.lang.Object o) Compare this object with another
void	fireWMSException(java.lang.String requestType, java.lang.String requestURL, IWMSServiceExceptionHandler pException) Notifies listeners about a valid exception from the WMS Service.
void	fireWMSRequest(java.lang.String requestType, java.lang.String requestURL) Notifies listeners about the URL request made to this WMS Service.
java.lang.String	getBaseURL(java.lang.String capability, java.lang.String requestMethod) Base url for given capability and request method.
static java.lang.String	getClsid() getClsid.
java.lang.String	getExceptionFormat(int index) Supported exception at the given index.
int	getExceptionFormatCount() Supported exception format count.
java.lang.String	getFeatureInfoFormat(int index) Supported FeatureInfoFormat at the given index.
int	getFeatureInfoFormatCount() Supported FeatureInfoFormat count.
java.lang.String	getFeatureInfoRequestURL(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int positionX, int positionY, int featureCount, java.lang.String responseFormat) The url to download the feature info from.
IName	getFullName() Complete information required to connect to a WMS server..
java.lang.String	getImageFormat(int index) Supported GetMap's ImageFormat at the given index.
int	getImageFormatCount() Supported GetMap's ImageFormat count.
java.lang.String	getImageRequestUrl(IArray pLayers, IEnvelope pBoundingBox, int imageWidth, int imageHeight, int bgColor, java.lang.String responseFormat, boolean drawTransparent) The URL to download the map image from.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IWMSLayerDescription	getLayerDescription(int index) WMS layer information at the given index.
int	getLayerDescriptionCount() WMS layer count.
java.lang.String	getName() Name of the connection.
java.lang.String	getSRS(int index) Supported SRS at the given index.
int	getSRSCount() Supported SRS count.
java.lang.String	getWMSAbstract() Abstract of WMS Service.
java.lang.String	getWMSName() Name of WMS Service.
java.lang.String	getWMSTitle() Title of WMS Service.
java.lang.String	getWMSVersion() Version of WMS Service.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	release() Release a WMSConnection.
void	removeIWMSClientEventsListener(IWMSClientEvents theListener) removeIWMSClientEventsListener.
void	setFullNameByRef(IName ppName) Complete information required to connect to a WMS server..
void	setName(java.lang.String name) Name of the connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

WMSConnection

public WMSConnection()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a WMSConnection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

WMSConnection

public WMSConnection(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIWMSClientEventsListener

public void addIWMSClientEventsListener(IWMSClientEvents theListener)
                                 throws java.io.IOException

addIWMSClientEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.gisclient.IWMSClientEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeIWMSClientEventsListener

public void removeIWMSClientEventsListener(IWMSClientEvents theListener)
                                    throws java.io.IOException

removeIWMSClientEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.gisclient.IWMSClientEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a WMSConnection.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the connection.

Specified by:

getName in interface IWMSConnection

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the connection.

Specified by:

setName in interface IWMSConnection

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

Complete information required to connect to a WMS server..

Specified by:

getFullName in interface IWMSConnection

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullNameByRef

public void setFullNameByRef(IName ppName)
                      throws java.io.IOException,
                             AutomationException

Complete information required to connect to a WMS server..

Specified by:

setFullNameByRef in interface IWMSConnection

Parameters:

ppName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSName

public java.lang.String getWMSName()
                            throws java.io.IOException,
                                   AutomationException

Name of WMS Service.

Specified by:

getWMSName in interface IWMSServiceDescription

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSAbstract

public java.lang.String getWMSAbstract()
                                throws java.io.IOException,
                                       AutomationException

Abstract of WMS Service.

Specified by:

getWMSAbstract in interface IWMSServiceDescription

Returns:

The esri_abstract

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSTitle

public java.lang.String getWMSTitle()
                             throws java.io.IOException,
                                    AutomationException

Title of WMS Service.

Specified by:

getWMSTitle in interface IWMSServiceDescription

Returns:

The title

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSVersion

public java.lang.String getWMSVersion()
                               throws java.io.IOException,
                                      AutomationException

Version of WMS Service.

Specified by:

getWMSVersion in interface IWMSServiceDescription

Returns:

The title

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptionCount

public int getLayerDescriptionCount()
                             throws java.io.IOException,
                                    AutomationException

WMS layer count.

Specified by:

getLayerDescriptionCount in interface IWMSServiceDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescription

public IWMSLayerDescription getLayerDescription(int index)
                                         throws java.io.IOException,
                                                AutomationException

WMS layer information at the given index.

Specified by:

getLayerDescription in interface IWMSServiceDescription

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IWMSLayerDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSRSCount

public int getSRSCount()
                throws java.io.IOException,
                       AutomationException

Supported SRS count.

Specified by:

getSRSCount in interface IWMSServiceDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSRS

public java.lang.String getSRS(int index)
                        throws java.io.IOException,
                               AutomationException

Supported SRS at the given index.

Specified by:

getSRS in interface IWMSServiceDescription

Parameters:

index - The index (in)

Returns:

The sRS

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageRequestUrl

public java.lang.String getImageRequestUrl(IArray pLayers,
                                           IEnvelope pBoundingBox,
                                           int imageWidth,
                                           int imageHeight,
                                           int bgColor,
                                           java.lang.String responseFormat,
                                           boolean drawTransparent)
                                    throws java.io.IOException,
                                           AutomationException

The URL to download the map image from.

Specified by:

getImageRequestUrl in interface IWMSServiceDescription

Parameters:

pLayers - A reference to a com.esri.arcgis.system.IArray (in)

pBoundingBox - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

bgColor - The bgColor (A COM typedef) (in)

responseFormat - The responseFormat (in)

drawTransparent - The drawTransparent (in)

Returns:

The uRL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoRequestURL

public java.lang.String getFeatureInfoRequestURL(IArray pLayers,
                                                 IEnvelope pBoundingBox,
                                                 int imageWidth,
                                                 int imageHeight,
                                                 int positionX,
                                                 int positionY,
                                                 int featureCount,
                                                 java.lang.String responseFormat)
                                          throws java.io.IOException,
                                                 AutomationException

The url to download the feature info from.

Specified by:

getFeatureInfoRequestURL in interface IWMSServiceDescription

Parameters:

pLayers - A reference to a com.esri.arcgis.system.IArray (in)

pBoundingBox - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

positionX - The positionX (in)

positionY - The positionY (in)

featureCount - The featureCount (in)

responseFormat - The responseFormat (in)

Returns:

The uRL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormatCount

public int getImageFormatCount()
                        throws java.io.IOException,
                               AutomationException

Supported GetMap's ImageFormat count.

Specified by:

getImageFormatCount in interface IWMSServiceDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormat

public java.lang.String getImageFormat(int index)
                                throws java.io.IOException,
                                       AutomationException

Supported GetMap's ImageFormat at the given index.

Specified by:

getImageFormat in interface IWMSServiceDescription

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormatCount

public int getFeatureInfoFormatCount()
                              throws java.io.IOException,
                                     AutomationException

Supported FeatureInfoFormat count.

Specified by:

getFeatureInfoFormatCount in interface IWMSServiceDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormat

public java.lang.String getFeatureInfoFormat(int index)
                                      throws java.io.IOException,
                                             AutomationException

Supported FeatureInfoFormat at the given index.

Specified by:

getFeatureInfoFormat in interface IWMSServiceDescription

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExceptionFormatCount

public int getExceptionFormatCount()
                            throws java.io.IOException,
                                   AutomationException

Supported exception format count.

Specified by:

getExceptionFormatCount in interface IWMSServiceDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExceptionFormat

public java.lang.String getExceptionFormat(int index)
                                    throws java.io.IOException,
                                           AutomationException

Supported exception at the given index.

Specified by:

getExceptionFormat in interface IWMSServiceDescription

Parameters:

index - The index (in)

Returns:

The exceptionFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseURL

public java.lang.String getBaseURL(java.lang.String capability,
                                   java.lang.String requestMethod)
                            throws java.io.IOException,
                                   AutomationException

Base url for given capability and request method.

Specified by:

getBaseURL in interface IWMSServiceDescription

Parameters:

capability - The capability (in)

requestMethod - The requestMethod (in)

Returns:

The baseURL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireWMSRequest

public void fireWMSRequest(java.lang.String requestType,
                           java.lang.String requestURL)
                    throws java.io.IOException,
                           AutomationException

Notifies listeners about the URL request made to this WMS Service.

Specified by:

fireWMSRequest in interface IWMSServiceDescription

Parameters:

requestType - The requestType (in)

requestURL - The requestURL (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireWMSException

public void fireWMSException(java.lang.String requestType,
                             java.lang.String requestURL,
                             IWMSServiceExceptionHandler pException)
                      throws java.io.IOException,
                             AutomationException

Notifies listeners about a valid exception from the WMS Service.

Specified by:

fireWMSException in interface IWMSServiceDescription

Parameters:

requestType - The requestType (in)

requestURL - The requestURL (in)

pException - A reference to a com.esri.arcgis.gisclient.IWMSServiceExceptionHandler (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.