com.esri.arcgis.carto

Interface IImageServer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IImageServerProxy, ImageServer

public interface IImageServer
extends java.io.Serializable

COM Interface 'IImageServer'. Generated 9/21/2023 10:01:50 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description: 'Provides access to members that control an image server.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID10a6f247_a053_4bb1_aaf3_503ef365e10e
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.
IImageServerEditResults	delete(IFIDSet pRIDs) Deletes a given list of raster items (images).
IImageServerDownloadResults	download(IFIDSet pFIDs, IGeometry pGeometry, java.lang.String format) Clips images to a given geometry, and returns a list of downloadable files for a given set of catalog item IDs.
IImageResult	exportImage(IGeoImageDescription pImageDescription, IImageType pImageType) Exports into a well-known image for a given image description.
IImageServiceInfo	generateServiceInfo(IRenderingRule pRenderingRule) Generates the image service information as if a given rendering rule is applied.
int	getCatalogItemCount(IQueryFilter pFilter) Gets the catalog item count for a given query filter.
IFIDSet	getCatalogItemIDs(IQueryFilter pFilter) Gets the catalog item IDs for a given query filter.
IRecordSet	getCatalogItems(IQueryFilter pFilter) Gets the catalog items for a given query filter.
IFields	getFields() The fields of the image catalog.
java.lang.String	getFile(IImageServerDownloadResult pFile) Get the URL to a given download result.
byte[]	getImage(IGeoImageDescription pImageDescription) Gets an image for a given image description.
ISpatialReference	getImageCoordinateSystem(int rID) Gets the image coordinate system of a given raster.
java.lang.String	getImageSupportData(int rID) Gets the image support data.
IPropertySet	getKeyProperties() The image service key properties.
IPropertySet	getKeyProperties2(IRenderingRule pRenderingRule) Gets the service key properties based on a rendering rule.
java.lang.String	getMetadata() The image service metadata.
IMultidimensionalInfo	getMultidimensionalInfo() The image service multidimensional info.
byte[]	getNativePixelBlock(int rID, int iID, int tx, int ty, int level) Gets a pixel block at a given block location for a specified raw source raster.
IRasterInfos	getNativeRasterInfo(int rID) Gets raster information of all raw source rasters for a given raster catalog item.
byte[]	getPixelBlock(int rID, int tx, int ty, int level) Gets a pixel block at a given block location.
IRecordSet	getRasterAttributeTable() The raster attribute table.
IRasterInfo	getRasterInfo(int rID) Gets the image information of a given raster catalog item.
IPropertySet	getRasterKeyProperties(int rID) The key properties for a given raster catalog item.
java.lang.String	getRasterMetadata(int rID) Gets the metadata of a given raster catalog item.
IPropertySet	getSensorProperties(int rID) Gets the image coordinate system of a given raster.
IImageServiceInfo	getServiceInfo() The properties of the image service provided.
IImageResult	getThumbnail(int rID) Gets the thumbnail image of a given raster catalog item.
float	getVersion() The Image Server version number.
IImageServerIdentifyResult	identify(IGeometry pLocation, IMosaicRule pMosaicRule, IPoint pCellsize) Identifies the pixel value and catalog items at the given location.
IImageServerIdentifyResults	identifyAll(IGeometry pLocations, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule, java.lang.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).

Field Detail

IID10a6f247_a053_4bb1_aaf3_503ef365e10e

static final int IID10a6f247_a053_4bb1_aaf3_503ef365e10e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getVersion

float getVersion()
          throws java.io.IOException,
                 AutomationException

The Image Server version number.

Returns:

The pVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceInfo

IImageServiceInfo getServiceInfo()
                          throws java.io.IOException,
                                 AutomationException

The properties of the image service provided.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImage

byte[] getImage(IGeoImageDescription pImageDescription)
         throws java.io.IOException,
                AutomationException

Gets an image for a given image description.

Parameters:

pImageDescription - A reference to a com.esri.arcgis.carto.IGeoImageDescription (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportImage

IImageResult exportImage(IGeoImageDescription pImageDescription,
                         IImageType pImageType)
                  throws java.io.IOException,
                         AutomationException

Exports into a well-known image for a given image description.

Parameters:

pImageDescription - A reference to a com.esri.arcgis.carto.IGeoImageDescription (in)

pImageType - A reference to a com.esri.arcgis.carto.IImageType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
           throws java.io.IOException,
                  AutomationException

The fields of the image catalog.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalogItemCount

int getCatalogItemCount(IQueryFilter pFilter)
                 throws java.io.IOException,
                        AutomationException

Gets the catalog item count for a given query filter.

Parameters:

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The pNumItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalogItemIDs

IFIDSet getCatalogItemIDs(IQueryFilter pFilter)
                   throws java.io.IOException,
                          AutomationException

Gets the catalog item IDs for a given query filter.

Parameters:

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalogItems

IRecordSet getCatalogItems(IQueryFilter pFilter)
                    throws java.io.IOException,
                           AutomationException

Gets the catalog items for a given query filter.

Parameters:

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

download

IImageServerDownloadResults download(IFIDSet pFIDs,
                                     IGeometry pGeometry,
                                     java.lang.String format)
                              throws java.io.IOException,
                                     AutomationException

Clips images to a given geometry, and returns a list of downloadable files for a given set of catalog item IDs.

Parameters:

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

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

format - The format (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFile

java.lang.String getFile(IImageServerDownloadResult pFile)
                  throws java.io.IOException,
                         AutomationException

Get the URL to a given download result.

Parameters:

pFile - A reference to a com.esri.arcgis.carto.IImageServerDownloadResult (in)

Returns:

The pURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

IImageServerIdentifyResult identify(IGeometry pLocation,
                                    IMosaicRule pMosaicRule,
                                    IPoint pCellsize)
                             throws java.io.IOException,
                                    AutomationException

Identifies the pixel value and catalog items at the given location.

Parameters:

pLocation - 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)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadata

java.lang.String getMetadata()
                      throws java.io.IOException,
                             AutomationException

The image service metadata.

Returns:

The pXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo(int rID)
                   throws java.io.IOException,
                          AutomationException

Gets the image information of a given raster catalog item.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelBlock

byte[] getPixelBlock(int rID,
                     int tx,
                     int ty,
                     int level)
              throws java.io.IOException,
                     AutomationException

Gets a pixel block at a given block location.

Parameters:

rID - The rID (in)

tx - The tx (in)

ty - The ty (in)

level - The level (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterMetadata

java.lang.String getRasterMetadata(int rID)
                            throws java.io.IOException,
                                   AutomationException

Gets the metadata of a given raster catalog item.

Parameters:

rID - The rID (in)

Returns:

The pXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

IImageResult getThumbnail(int rID)
                   throws java.io.IOException,
                          AutomationException

Gets the thumbnail image of a given raster catalog item.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

generateServiceInfo

IImageServiceInfo generateServiceInfo(IRenderingRule pRenderingRule)
                               throws java.io.IOException,
                                      AutomationException

Generates the image service information as if a given rendering rule is applied.

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeRasterInfo

IRasterInfos getNativeRasterInfo(int rID)
                          throws java.io.IOException,
                                 AutomationException

Gets raster information of all raw source rasters for a given raster catalog item.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativePixelBlock

byte[] getNativePixelBlock(int rID,
                           int iID,
                           int tx,
                           int ty,
                           int level)
                    throws java.io.IOException,
                           AutomationException

Gets a pixel block at a given block location for a specified raw source raster.

Parameters:

rID - The rID (in)

iID - The iID (in)

tx - The tx (in)

ty - The ty (in)

level - The level (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

IImageServerEditResults add(IRasterItemDescriptions pItemDescriptions)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates a given list of raster items (images).

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:

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

AutomationException - If the ArcObject component throws an exception.

delete

IImageServerEditResults delete(IFIDSet pRIDs)
                        throws java.io.IOException,
                               AutomationException

Deletes a given list of raster items (images).

Parameters:

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

Returns:

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

Throws:

java.io.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 java.io.IOException,
                                  AutomationException

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

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:

java.io.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 java.io.IOException,
                                    AutomationException

Computes histograms within an area of interest.

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:

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

AutomationException - If the ArcObject component throws an exception.

getRasterAttributeTable

IRecordSet getRasterAttributeTable()
                            throws java.io.IOException,
                                   AutomationException

The raster attribute table.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyProperties

IPropertySet getKeyProperties()
                       throws java.io.IOException,
                              AutomationException

The image service key properties.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterKeyProperties

IPropertySet getRasterKeyProperties(int rID)
                             throws java.io.IOException,
                                    AutomationException

The key properties for a given raster catalog item.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

java.io.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,
                                        java.lang.String options)
                                 throws java.io.IOException,
                                        AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getMultidimensionalInfo

IMultidimensionalInfo getMultidimensionalInfo()
                                       throws java.io.IOException,
                                              AutomationException

The image service multidimensional info.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageCoordinateSystem

ISpatialReference getImageCoordinateSystem(int rID)
                                    throws java.io.IOException,
                                           AutomationException

Gets the image coordinate system of a given raster.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSensorProperties

IPropertySet getSensorProperties(int rID)
                          throws java.io.IOException,
                                 AutomationException

Gets the image coordinate system of a given raster.

Parameters:

rID - The rID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyProperties2

IPropertySet getKeyProperties2(IRenderingRule pRenderingRule)
                        throws java.io.IOException,
                               AutomationException

Gets the service key properties based on a rendering rule.

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageSupportData

java.lang.String getImageSupportData(int rID)
                              throws java.io.IOException,
                                     AutomationException

Gets the image support data.

Parameters:

rID - The rID (in)

Returns:

The pImageSupportData

Throws:

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

AutomationException - If the ArcObject component throws an exception.