com.esri.arcgis.gisclient
Interface IWMSLayerDescription

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IWMSLayerDescriptionProxy

public interface IWMSLayerDescription

extends java.io.Serializable

Provides access to members give access to WMSLayerDescription information.

Product Availability

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

Method Summary

java.lang.String	getAbstract() Abstract of the WMS layer.
void	getBoundingBox(int index, IEnvelope[] envelope, java.lang.String[] srsCode) Minimum bounding extents of the layer data along with the applicable SRS.
int	getBoundingBoxCount() Number of bounding extents of the layer.
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.
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.
java.lang.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.
java.lang.String	getName() Name of WMS layer.
double	getScaleHintMax() Suggested maximum scale of the WMS layer.
double	getScaleHintMin() Suggested minimimum scale for the WMS layer.
java.lang.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.
java.lang.String	getTitle() Title of WMS layer.
java.lang.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.

Method Detail

getName

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

Name of WMS layer.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

Title of WMS layer.

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAbstract

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

Abstract of the WMS layer.

Returns:

The esri_abstract

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isQueryable

public boolean isQueryable()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the layer is queryable.

Returns:

The isQuaryable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOpaque

public boolean isOpaque()
                 throws java.io.IOException,
                        AutomationException

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

Returns:

The isOpaque

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIsCascaded

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

Indicates the number of times the layer has been reserved.

Returns:

The isCascaded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSubsettable

public boolean isSubsettable()
                      throws java.io.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.

Returns:

The isSubsettable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFixedWidth

public double getFixedWidth()
                     throws java.io.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.

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFixedHeight

public double getFixedHeight()
                      throws java.io.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.

Returns:

The height

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

Number of WMSLayerDescriptions.

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

WMSLayerDescription at a given index.

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.

getScaleHintMin

public double getScaleHintMin()
                       throws java.io.IOException,
                              AutomationException

Suggested minimimum scale for the WMS layer.

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScaleHintMax

public double getScaleHintMax()
                       throws java.io.IOException,
                              AutomationException

Suggested maximum scale of the WMS layer.

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLatLongBoundingBox

public IEnvelope getLatLongBoundingBox()
                                throws java.io.IOException,
                                       AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundingBoxCount

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

Number of bounding extents of the layer.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBoundingBox

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getStyleDescriptionCount

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

Number of styles in the layer.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleDescription

public IWMSLayerStyleDescription getStyleDescription(int index)
                                              throws java.io.IOException,
                                                     AutomationException

Style of the layer at the given index.

Parameters:

index - The index (in)

Returns:

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

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.

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

Supproted SRS at the given index.

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.

getWMSVersion

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

WMS Version.

Returns:

The wMSVersion

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.

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.

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.

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.

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.

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.

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.