com.esri.arcgis.gisclient
Class IWMSLayerDescriptionProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.gisclient.IWMSLayerDescriptionProxy

All Implemented Interfaces:

IWMSLayerDescription, Externalizable, Serializable

public class IWMSLayerDescriptionProxy
extends com.esri.arcgis.interop.Dispatch
implements IWMSLayerDescription, Serializable

Provides access to members give access to WMSLayerDescription information.

Remarks

IWMSLayerDescription provides access to members that describe the capabilities of a WMS layer.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IWMSLayerDescriptionProxy()
	IWMSLayerDescriptionProxy(Object obj)
protected	IWMSLayerDescriptionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getAbstract() Abstract of the WMS layer.
void	getBoundingBox(int index, IEnvelope[] envelope, String[] srsCode) Minimum bounding extents of the layer data along with the applicable SRS.
int	getBoundingBoxCount() Number of bounding extents of the layer.
String	getExceptionFormat(int index) Supported exception at the given index.
int	getExceptionFormatCount() Supported exception format count.
String	getFeatureInfoFormat(int index) Supported FeatureInfoFormat at the given index.
int	getFeatureInfoFormatCount() Supported FeatureInfoFormat count.
double	getFixedHeight() Fixed height at which server is able to display the layer.
double	getFixedWidth() Fixed width at which server is able to display the layer.
String	getImageFormat(int index) Supported GetMap's ImageFormat at the given index.
int	getImageFormatCount() Supported GetMap's ImageFormat count.
int	getIsCascaded() Indicates the number of times the layer has been reserved.
IEnvelope	getLatLongBoundingBox() Minimum bounding extent of the layer data in EPSG:4326.
IWMSLayerDescription	getLayerDescription(int index) WMSLayerDescription at a given index.
int	getLayerDescriptionCount() Number of WMSLayerDescriptions.
String	getName() Name of WMS layer.
double	getScaleHintMax() Suggested maximum scale of the WMS layer.
double	getScaleHintMin() Suggested minimimum scale for the WMS layer.
String	getSRS(int index) Supproted SRS at the given index.
int	getSRSCount() Supported SRS count.
IWMSLayerStyleDescription	getStyleDescription(int index) Style of the layer at the given index.
int	getStyleDescriptionCount() Number of styles in the layer.
String	getTitle() Title of WMS layer.
String	getWMSVersion() WMS Version.
boolean	isOpaque() Indicates whether the layer is opaque or transparent in terms of the area that gets drawn.
boolean	isQueryable() Indicates whether the layer is queryable.
boolean	isSubsettable() Indicates whether or not the server will be able to crop the data to a geographic area smaller than its enclosing bounding box.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IWMSLayerDescriptionProxy

public IWMSLayerDescriptionProxy()

IWMSLayerDescriptionProxy

public IWMSLayerDescriptionProxy(Object obj)
                          throws IOException

Throws:

IOException

IWMSLayerDescriptionProxy

protected IWMSLayerDescriptionProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

Name of WMS layer.

Remarks

Name is text used to identify a WMS layer for machine-to-machine communication.

Product Availability

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

Specified by:

getName in interface IWMSLayerDescription

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

Title of WMS layer.

Remarks

Title is the user-friendly text used to identify a WMS layer.

Product Availability

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

Specified by:

getTitle in interface IWMSLayerDescription

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAbstract

public String getAbstract()
                   throws IOException,
                          AutomationException

Abstract of the WMS layer.

Remarks

The abstract is a narrative description of the WMS layer.

Product Availability

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

Specified by:

getAbstract in interface IWMSLayerDescription

Returns:

The esri_abstract

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isQueryable

public boolean isQueryable()
                    throws IOException,
                           AutomationException

Indicates whether the layer is queryable.

Product Availability

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

Specified by:

isQueryable in interface IWMSLayerDescription

Returns:

The isQuaryable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOpaque

public boolean isOpaque()
                 throws IOException,
                        AutomationException

Indicates whether the layer is opaque or transparent in terms of the area that gets drawn.

Product Availability

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

Specified by:

isOpaque in interface IWMSLayerDescription

Returns:

The isOpaque

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIsCascaded

public int getIsCascaded()
                  throws IOException,
                         AutomationException

Indicates the number of times the layer has been reserved.

Product Availability

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

Specified by:

getIsCascaded in interface IWMSLayerDescription

Returns:

The isCascaded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSubsettable

public boolean isSubsettable()
                      throws IOException,
                             AutomationException

Indicates whether or not the server will be able to crop the data to a geographic area smaller than its enclosing bounding box.

Product Availability

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

Specified by:

isSubsettable in interface IWMSLayerDescription

Returns:

The isSubsettable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFixedWidth

public double getFixedWidth()
                     throws IOException,
                            AutomationException

Fixed width at which server is able to display the layer. If this is zero, server can display the layer at any resolution.

Product Availability

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

Specified by:

getFixedWidth in interface IWMSLayerDescription

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFixedHeight

public double getFixedHeight()
                      throws IOException,
                             AutomationException

Fixed height at which server is able to display the layer. If this is zero, server can display the layer at any resolution.

Product Availability

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

Specified by:

getFixedHeight in interface IWMSLayerDescription

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptionCount

public int getLayerDescriptionCount()
                             throws IOException,
                                    AutomationException

Number of WMSLayerDescriptions.

Product Availability

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

Specified by:

getLayerDescriptionCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescription

public IWMSLayerDescription getLayerDescription(int index)
                                         throws IOException,
                                                AutomationException

WMSLayerDescription at a given index.

Product Availability

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

Specified by:

getLayerDescription in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleHintMin

public double getScaleHintMin()
                       throws IOException,
                              AutomationException

Suggested minimimum scale for the WMS layer.

Product Availability

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

Specified by:

getScaleHintMin in interface IWMSLayerDescription

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleHintMax

public double getScaleHintMax()
                       throws IOException,
                              AutomationException

Suggested maximum scale of the WMS layer.

Product Availability

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

Specified by:

getScaleHintMax in interface IWMSLayerDescription

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLatLongBoundingBox

public IEnvelope getLatLongBoundingBox()
                                throws IOException,
                                       AutomationException

Minimum bounding extent of the layer data in EPSG:4326.

Product Availability

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

Specified by:

getLatLongBoundingBox in interface IWMSLayerDescription

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundingBoxCount

public int getBoundingBoxCount()
                        throws IOException,
                               AutomationException

Number of bounding extents of the layer.

Product Availability

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

Specified by:

getBoundingBoxCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundingBox

public void getBoundingBox(int index,
                           IEnvelope[] envelope,
                           String[] srsCode)
                    throws IOException,
                           AutomationException

Minimum bounding extents of the layer data along with the applicable SRS.

Product Availability

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

Specified by:

getBoundingBox in interface IWMSLayerDescription

Parameters:

index - The index (in)

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

srsCode - The srsCode (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleDescriptionCount

public int getStyleDescriptionCount()
                             throws IOException,
                                    AutomationException

Number of styles in the layer.

Product Availability

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

Specified by:

getStyleDescriptionCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleDescription

public IWMSLayerStyleDescription getStyleDescription(int index)
                                              throws IOException,
                                                     AutomationException

Style of the layer at the given index.

Product Availability

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

Specified by:

getStyleDescription in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSRSCount

public int getSRSCount()
                throws IOException,
                       AutomationException

Supported SRS count.

Product Availability

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

Specified by:

getSRSCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSRS

public String getSRS(int index)
              throws IOException,
                     AutomationException

Supproted SRS at the given index.

Product Availability

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

Specified by:

getSRS in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

The sRS

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWMSVersion

public String getWMSVersion()
                     throws IOException,
                            AutomationException

WMS Version.

Product Availability

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

Specified by:

getWMSVersion in interface IWMSLayerDescription

Returns:

The wMSVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormatCount

public int getImageFormatCount()
                        throws IOException,
                               AutomationException

Supported GetMap's ImageFormat count.

Product Availability

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

Specified by:

getImageFormatCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageFormat

public String getImageFormat(int index)
                      throws IOException,
                             AutomationException

Supported GetMap's ImageFormat at the given index.

Product Availability

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

Specified by:

getImageFormat in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormatCount

public int getFeatureInfoFormatCount()
                              throws IOException,
                                     AutomationException

Supported FeatureInfoFormat count.

Product Availability

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

Specified by:

getFeatureInfoFormatCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureInfoFormat

public String getFeatureInfoFormat(int index)
                            throws IOException,
                                   AutomationException

Supported FeatureInfoFormat at the given index.

Product Availability

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

Specified by:

getFeatureInfoFormat in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

The imageFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExceptionFormatCount

public int getExceptionFormatCount()
                            throws IOException,
                                   AutomationException

Supported exception format count.

Product Availability

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

Specified by:

getExceptionFormatCount in interface IWMSLayerDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExceptionFormat

public String getExceptionFormat(int index)
                          throws IOException,
                                 AutomationException

Supported exception at the given index.

Product Availability

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

Specified by:

getExceptionFormat in interface IWMSLayerDescription

Parameters:

index - The index (in)

Returns:

The exceptionFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.