com.esri.arcgis.carto
Interface IImageServer4

All Superinterfaces:

IImageServer, IImageServer2, IImageServer3, Serializable

All Known Implementing Classes:

ImageServer

public interface IImageServer4
extends IImageServer3, Serializable

Provides access to members that control an image server object (SO).

Remarks

IImageServer4 interface provides methods accessing the catalog of an image service such as select catalog items based on a query, get the catalog items, metadata, and download the selected items. It also provides methods to get raster attribute table, edit image service and perform mensuration.

Editing is supported when data source is a mosaic dataset stored in SDE, and not supported on other formats and workspaces.

An ImageServer object can be created from multiple data models: raster dataset, mosaic dataset, or layer file. Table below lists the supported methods with regards to the data models.

Methods	Mosaic Dataset	Raster Dataset	Raster Layer File
GetVersion	yes	yes	yes
GetServiceInfo	yes	yes	yes
GetImage	yes	yes	yes
ExportImage	yes	yes	yes
ExportMapImage	yes	yes	yes
GetMetadata	yes	yes	yes
GenerateServiceInfo	yes	yes	yes
Identify	yes	yes	yes
IdentifyAll	yes	yes	yes
ComputeHistograms	yes	yes	yes
Measure	yes	yes	yes
GetKeyProperties	yes	yes	yes
GetRasterAttributeTable	yes	yes	yes
Add	yes	no	no
Update	yes	no	no
Delete	yes	no	no
GetRasterKeyProperties	yes	no	no
GetCatalogItemCount	yes	no	no
GetCatalogItemIDs	yes	no	no
GetCatalogItems	yes	no	no
GetThumnail	yes	no	no
GetRasterMetadata	yes	no	no
GetRasterInfo	yes	no	no
GetPixelBlock	yes	no	no
GetNativeRasterInfo	yes	no	no
GetNativePixelBlock	yes	no	no
GetFields	yes	no	no
Download	yes	no	no
GetFile	yes	no	no

Product Availability

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

Method Summary

IImageServerEditResults	add(IRasterItemDescriptions pItemDescriptions) Adds a list of raster items for sharing with other users (roles).
IRasterHistograms	computeHistograms(IGeometry pGeometry, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule) Computes histograms within an area of interest.
IImageServerEditResult	createView(IImageView pView) Creates a new view.
IImageServerEditResults	delete(IFIDSet pRIDs) Deletes a given list of raster items (images).
IImageServerEditResult	deleteView(String vID) Deletes the view of a given view ID.
Object	execute(String name, Object argument) Executes a named image server processing command.
IPropertySet	getKeyProperties() The image service key properties.
IRecordSet	getRasterAttributeTable() The raster attribute table.
IPropertySet	getRasterKeyProperties(int rID) The key properties for a given raster catalog item.
IImageView	getView(String vID) Gets the view of a given view ID.
IImageServerIdentifyResults	identifyAll(IGeometry pLocations, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule, String options) Identifies the pixel values and all catalog items at the given one or more locations.
IImageServerMeasureResult	measure(IGeometry pFrom, IGeometry pTo, IMosaicRule pMosaicRule, IPoint pCellsize, int operation) Measures distance, angle, area, perimeter, and height.
IImageServerEditResults	update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions) Updates a given list of raster items (images).
IImageServerEditResults	updateView(String vID, IFIDSet pAddIDs, IFIDSet pDeleteIDs) Inserts and Removes raster items to a given view.

Methods inherited from interface com.esri.arcgis.carto.IImageServer3

download, generateServiceInfo, getCatalogItemCount, getCatalogItemIDs, getCatalogItems, getFields, getFile, getMetadata, getNativePixelBlock, getNativeRasterInfo, getPixelBlock, getRasterInfo, getRasterMetadata, getThumbnail, identify

Methods inherited from interface com.esri.arcgis.carto.IImageServer2

exportMapImage

Methods inherited from interface com.esri.arcgis.carto.IImageServer

exportImage, getImage, getServiceInfo, getVersion

Method Detail

add

IImageServerEditResults add(IRasterItemDescriptions pItemDescriptions)
                            throws IOException,
                                   AutomationException

Adds a list of raster items for sharing with other users (roles).

Description

Add rasters to an image service (created from a SDE mosaic dataset) using the given RasterItemDescriptions

Remarks

Use Add method to add raster datasets, or other supported raster types (defined by the image service) to image service. Supported raster types are available through IImageServiceInfo3.

RasterItemDescription describes all required information, including name and location of the raster files (through shared path or http), visibility range, attribute values, raster type etc. If the source rasters are not georeferenced, georeferncing information (geodataTransformations) can be specified in RasterItemDescription.

Product Availability

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

Parameters:

pItemDescriptions - A reference to a com.esri.arcgis.carto.IRasterItemDescriptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

IImageServerEditResults update(IFIDSet pRIDs,
                               IRasterItemDescriptions pItemDescriptions)
                               throws IOException,
                                      AutomationException

Updates a given list of raster items (images).

Description

Update rasters in an image service (created from a SDE mosaic dataset) based on given FIDSet and RasterItemDescriptions

Remarks

Use Update method to update a raster catalog item in an image service served through mosaic dataset. New attributes, footrpint geometry, or transofmrations can be specified in RasterItemDescription. A new raster can be uploaded to replace existing raster.

Product Availability

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

Parameters:

pRIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

pItemDescriptions - A reference to a com.esri.arcgis.carto.IRasterItemDescriptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

IImageServerEditResults delete(IFIDSet pRIDs)
                               throws IOException,
                                      AutomationException

Deletes a given list of raster items (images).

Description

Delete rasters from an image service (created from a SDE mosaic dataset) based on given FIDSet

Product Availability

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

Parameters:

pRIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

measure

IImageServerMeasureResult measure(IGeometry pFrom,
                                  IGeometry pTo,
                                  IMosaicRule pMosaicRule,
                                  IPoint pCellsize,
                                  int operation)
                                  throws IOException,
                                         AutomationException

Measures distance, angle, area, perimeter, and height.

Description

Perform mensuration on an image service.

Product Availability

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

Parameters:

pFrom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pTo - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pMosaicRule - A reference to a com.esri.arcgis.carto.IMosaicRule (in)

pCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)

operation - A com.esri.arcgis.carto.esriMensurationOperation constant (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerMeasureResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeHistograms

IRasterHistograms computeHistograms(IGeometry pGeometry,
                                    IMosaicRule pMosaicRule,
                                    IPoint pCellsize,
                                    IRenderingRule pRenderingRule)
                                    throws IOException,
                                           AutomationException

Computes histograms within an area of interest.

Product Availability

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

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pMosaicRule - A reference to a com.esri.arcgis.carto.IMosaicRule (in)

pCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)

pRenderingRule - A reference to a com.esri.arcgis.carto.IRenderingRule (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterHistograms

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterAttributeTable

IRecordSet getRasterAttributeTable()
                                   throws IOException,
                                          AutomationException

The raster attribute table.

Description

Get the raster attribute table of the image service which represents categorical information.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRecordSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyProperties

IPropertySet getKeyProperties()
                              throws IOException,
                                     AutomationException

The image service key properties.

Remarks

Key properties contain some well known property, such as AcquisitionDate, CloudCover, SensorName, ProductName, SunAzimuth, SunElevation, SensorAzimuth, SensorElevation etc.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterKeyProperties

IPropertySet getRasterKeyProperties(int rID)
                                    throws IOException,
                                           AutomationException

The key properties for a given raster catalog item.

Product Availability

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

Parameters:

rID - The rID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identifyAll

IImageServerIdentifyResults identifyAll(IGeometry pLocations,
                                        IMosaicRule pMosaicRule,
                                        IPoint pCellsize,
                                        IRenderingRule pRenderingRule,
                                        String options)
                                        throws IOException,
                                               AutomationException

Identifies the pixel values and all catalog items at the given one or more locations.

Remarks

Each element in the returned ImageServerIdentifyResult array corresponds to the identify result of a location in the given locations. Footprint geometry and catalog items may be skipped to speed up the operation by specifying options:
ITEMS=NO - only pixel value is returned
GEOMETRY=NO - pixel value, and item information are returned, but no geometry, and visibilities

Product Availability

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

Parameters:

pLocations - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pMosaicRule - A reference to a com.esri.arcgis.carto.IMosaicRule (in)

pCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)

pRenderingRule - A reference to a com.esri.arcgis.carto.IRenderingRule (in)

options - The options (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerIdentifyResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getView

IImageView getView(String vID)
                   throws IOException,
                          AutomationException

Gets the view of a given view ID.

Product Availability

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

Parameters:

vID - The vID (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createView

IImageServerEditResult createView(IImageView pView)
                                  throws IOException,
                                         AutomationException

Creates a new view.

Product Availability

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

Parameters:

pView - A reference to a com.esri.arcgis.carto.IImageView (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateView

IImageServerEditResults updateView(String vID,
                                   IFIDSet pAddIDs,
                                   IFIDSet pDeleteIDs)
                                   throws IOException,
                                          AutomationException

Inserts and Removes raster items to a given view.

Product Availability

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

Parameters:

vID - The vID (in)

pAddIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

pDeleteIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteView

IImageServerEditResult deleteView(String vID)
                                  throws IOException,
                                         AutomationException

Deletes the view of a given view ID.

Product Availability

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

Parameters:

vID - The vID (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageServerEditResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

Object execute(String name,
               Object argument)
               throws IOException,
                      AutomationException

Executes a named image server processing command.

Product Availability

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

Parameters:

name - The name (in)

argument - A Variant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.