com.esri.arcgis.carto

Class ImageServer

java.lang.Object

com.esri.arcgis.carto.ImageServer

All Implemented Interfaces:

IImageServer, IImageServerEx, IImageServerInit, IImageServerObjects, ITiledImageServer, IRasterFunctionTemplateMapper, com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRESTRequestHandler, ISupportErrorInfo, java.io.Serializable

public class ImageServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageServer, IImageServerEx, IImageServerInit, ITiledImageServer, IServerObject, IObjectConstruct, IRequestHandler, ILogSupport, IObjectActivate, IServerObjectExtensionManager, ISupportErrorInfo, IImageServerObjects, IRESTRequestHandler, IRasterFunctionTemplateMapper

COM Class 'ImageServer'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'The ArcGIS Server Image Server class.' 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.carto.IImageServer

IID, IID10a6f247_a053_4bb1_aaf3_503ef365e10e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IImageServerEx

IID, IID042ee12d_b2b7_4c2a_b2b2_ddd787957485, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IImageServerInit

IID, IIDee09fed6_6e28_491a_b00b_5b8796f075e1, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITiledImageServer

IID, IID10bfd112_33d2_4986_997a_f2b6069e45b8, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerObject

IID, IID0ad6ab40_9d6a_4bf8_8b86_eb89406dfc6c, xxDummy

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

IID, IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb, xxDummy

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

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerObjectExtensionManager

IID, IID25d8b9dd_c7e8_4da4_bf4b_08a67087ceea, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IImageServerObjects

IID, IIDd0bafeb3_b04d_4bc2_bd89_d1251450cb83, xxDummy

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

IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper

IID, IIDfad854e0_e6e6_42b3_9505_a44d62607932, xxDummy

Constructor Summary

Constructors

Constructor and Description
ImageServer() Constructs a ImageServer using ArcGIS Engine.
ImageServer(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ImageServer theImageServer = (ImageServer) obj;

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the object.
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.
void	construct(IPropertySet props) Two phase object construction.
void	deactivate() Deactivates the object.
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.
boolean	equals(java.lang.Object o) Compare this object with another
IImageResult	exportImage(IGeoImageDescription pImageDescription, IImageType pImageType) Exports into a well-known image for a given image description.
IServerObjectExtension	findExtensionByCLSID(java.lang.String cLSID) Returns a server object extension found using a string representation of its class ID.
IServerObjectExtension	findExtensionByTypeName(java.lang.String name) Returns a server object extension found using its type name.
IImageServiceInfo	generateServiceInfo(IRenderingRule pRenderingRule) Generates the image service information as if a given rendering rule is applied.
ICacheControlInfo	getCacheControlInfo() Gets the cache description information for a given map.
ICacheDescriptionInfo	getCacheDescriptionInfo() Gets the cache description information for a given map.
ICacheStorageInfo	getCacheStorageInfo() Gets the cache storage information.
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.
static java.lang.String	getClsid() getClsid.
java.lang.String	getConfigurationName() Name of the server object configuration that defines the server object.
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.
IName	getImageDataSourceName() The image server data source name.
java.lang.String	getImageSupportData(int rID) Gets the image support data.
byte[]	getImageTile(int level, int row, int column) Gets a tile for a given tile location.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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.
IMosaicDataset	getMosaicDataset() The mosaic dataset.
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.
java.lang.String	getPhysicalCacheDirectory() The physical directory for cache files.
java.lang.String	getPhysicalOutputDirectory() The physical directory for output files.
byte[]	getPixelBlock(int rID, int tx, int ty, int level) Gets a pixel block at a given block location.
IRaster	getRaster() The raster.
IRecordSet	getRasterAttributeTable() The raster attribute table.
IRasterDataset	getRasterDataset() The raster dataset.
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.
java.lang.String	getSchema() This method returns the resource hierarchy of a REST based SOE.
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.
ITileCacheInfo	getTileCacheInfo() Gets the cache configuration.
ITileImageInfo	getTileImageInfo() Gets the cache tile image information.
java.lang.String	getTypeName() Type of the server object (MapServer or GeocodeServer).
float	getVersion() The Image Server version number.
java.lang.String	getVirtualCacheDirectory() Gets the virtual cache directory for a given layer within a map.
java.lang.String	getVirtualOutputDirectory() The virtual directory for output files.
byte[]	handleBinaryRequest(byte[] request) Handles a binary request.
byte[]	handleRESTRequest(java.lang.String capabilities, java.lang.String resourceName, java.lang.String operationName, java.lang.String operationInput, java.lang.String outputFormat, java.lang.String requestProperties, java.lang.String[] responseProperties) Handles REST requests for SOE.
java.lang.String	handleStringRequest(java.lang.String capabilities, java.lang.String request) Handles a SOAP string request.
int	hashCode() the hashcode for this object
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.
void	initialize(java.lang.String fullName) Initializes this image server from a fullname to a dataset.
void	initializeFromDataset(IRasterDataset pDataset) Initializes this image server from a Raster Dataset.
void	initializeFromServiceURL(java.lang.String serviceURL) Initializes this image server from an AIS service URL (ImageService://:/).
void	initLogging(ILog log) Initializes an object with a log.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isFixedScaleImage() Indicates if it is fixed scale image.
IImageServerMeasureResult	measure(IGeometry pFrom, IGeometry pTo, IMosaicRule pMosaicRule, IPoint pCellsize, int operation) Measures distance, angle, area, perimeter, and height.
void	release() Release this COM object reference
void	setImageDataSourceNameByRef(IName ppName) The image server data source name.
IRasterFunctionTemplate	toRasterFunctionTemplate(java.lang.String name) Constructs a raster function template from a known template name.
IImageServerEditResults	update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions) Updates a given list of raster items (images).

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageServer

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

Constructs a ImageServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ImageServer

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

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

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

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getVersion

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

The Image Server version number.

Specified by:

getVersion in interface IImageServer

Specified by:

getVersion in interface IImageServerEx

Returns:

The pVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceInfo

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

The properties of the image service provided.

Specified by:

getServiceInfo in interface IImageServer

Specified by:

getServiceInfo in interface IImageServerEx

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

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

Gets an image for a given image description.

Specified by:

getImage in interface IImageServer

Specified by:

getImage in interface IImageServerEx

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

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

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

Specified by:

exportImage in interface IImageServer

Specified by:

exportImage in interface IImageServerEx

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

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

The fields of the image catalog.

Specified by:

getFields in interface IImageServer

Specified by:

getFields in interface IImageServerEx

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

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

Gets the catalog item count for a given query filter.

Specified by:

getCatalogItemCount in interface IImageServer

Specified by:

getCatalogItemCount in interface IImageServerEx

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

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

Gets the catalog item IDs for a given query filter.

Specified by:

getCatalogItemIDs in interface IImageServer

Specified by:

getCatalogItemIDs in interface IImageServerEx

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

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

Gets the catalog items for a given query filter.

Specified by:

getCatalogItems in interface IImageServer

Specified by:

getCatalogItems in interface IImageServerEx

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

public 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.

Specified by:

download in interface IImageServer

Specified by:

download in interface IImageServerEx

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

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

Get the URL to a given download result.

Specified by:

getFile in interface IImageServer

Specified by:

getFile in interface IImageServerEx

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

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

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

Specified by:

identify in interface IImageServer

Specified by:

identify in interface IImageServerEx

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

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

The image service metadata.

Specified by:

getMetadata in interface IImageServer

Specified by:

getMetadata in interface IImageServerEx

Returns:

The pXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

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

Gets the image information of a given raster catalog item.

Specified by:

getRasterInfo in interface IImageServer

Specified by:

getRasterInfo in interface IImageServerEx

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

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

Gets a pixel block at a given block location.

Specified by:

getPixelBlock in interface IImageServer

Specified by:

getPixelBlock in interface IImageServerEx

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

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

Gets the metadata of a given raster catalog item.

Specified by:

getRasterMetadata in interface IImageServer

Specified by:

getRasterMetadata in interface IImageServerEx

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

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

Gets the thumbnail image of a given raster catalog item.

Specified by:

getThumbnail in interface IImageServer

Specified by:

getThumbnail in interface IImageServerEx

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

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

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

Specified by:

generateServiceInfo in interface IImageServer

Specified by:

generateServiceInfo in interface IImageServerEx

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

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

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

Specified by:

getNativeRasterInfo in interface IImageServer

Specified by:

getNativeRasterInfo in interface IImageServerEx

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

public 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.

Specified by:

getNativePixelBlock in interface IImageServer

Specified by:

getNativePixelBlock in interface IImageServerEx

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

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

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

Specified by:

add in interface IImageServer

Specified by:

add in interface IImageServerEx

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

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

Updates a given list of raster items (images).

Specified by:

update in interface IImageServer

Specified by:

update in interface IImageServerEx

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

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

Deletes a given list of raster items (images).

Specified by:

delete in interface IImageServer

Specified by:

delete in interface IImageServerEx

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

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

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

Specified by:

measure in interface IImageServer

Specified by:

measure in interface IImageServerEx

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

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

Computes histograms within an area of interest.

Specified by:

computeHistograms in interface IImageServer

Specified by:

computeHistograms in interface IImageServerEx

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

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

The raster attribute table.

Specified by:

getRasterAttributeTable in interface IImageServer

Specified by:

getRasterAttributeTable in interface IImageServerEx

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

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

The image service key properties.

Specified by:

getKeyProperties in interface IImageServer

Specified by:

getKeyProperties in interface IImageServerEx

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

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

The key properties for a given raster catalog item.

Specified by:

getRasterKeyProperties in interface IImageServer

Specified by:

getRasterKeyProperties in interface IImageServerEx

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

public 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.

Specified by:

identifyAll in interface IImageServer

Specified by:

identifyAll in interface IImageServerEx

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

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

The image service multidimensional info.

Specified by:

getMultidimensionalInfo in interface IImageServer

Specified by:

getMultidimensionalInfo in interface IImageServerEx

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

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

Gets the image coordinate system of a given raster.

Specified by:

getImageCoordinateSystem in interface IImageServer

Specified by:

getImageCoordinateSystem in interface IImageServerEx

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

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

Gets the image coordinate system of a given raster.

Specified by:

getSensorProperties in interface IImageServer

Specified by:

getSensorProperties in interface IImageServerEx

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

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

Gets the service key properties based on a rendering rule.

Specified by:

getKeyProperties2 in interface IImageServer

Specified by:

getKeyProperties2 in interface IImageServerEx

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

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

Gets the image support data.

Specified by:

getImageSupportData in interface IImageServer

Specified by:

getImageSupportData in interface IImageServerEx

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.

getVirtualOutputDirectory

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

The virtual directory for output files.

Specified by:

getVirtualOutputDirectory in interface IImageServerEx

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

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

The physical directory for output files.

Specified by:

getPhysicalOutputDirectory in interface IImageServerEx

Returns:

The dirPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPhysicalCacheDirectory

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

The physical directory for cache files.

Specified by:

getPhysicalCacheDirectory in interface IImageServerEx

Returns:

The pCacheDir

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(java.lang.String fullName)
                throws java.io.IOException,
                       AutomationException

Initializes this image server from a fullname to a dataset.

Specified by:

initialize in interface IImageServerInit

Parameters:

fullName - The fullName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initializeFromDataset

public void initializeFromDataset(IRasterDataset pDataset)
                           throws java.io.IOException,
                                  AutomationException

Initializes this image server from a Raster Dataset.

Specified by:

initializeFromDataset in interface IImageServerInit

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initializeFromServiceURL

public void initializeFromServiceURL(java.lang.String serviceURL)
                              throws java.io.IOException,
                                     AutomationException

Initializes this image server from an AIS service URL (ImageService://:/).

Specified by:

initializeFromServiceURL in interface IImageServerInit

Parameters:

serviceURL - The serviceURL (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImageDataSourceNameByRef

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

The image server data source name.

Specified by:

setImageDataSourceNameByRef in interface IImageServerInit

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.

getImageDataSourceName

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

The image server data source name.

Specified by:

getImageDataSourceName in interface IImageServerInit

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.

getTileCacheInfo

public ITileCacheInfo getTileCacheInfo()
                                throws java.io.IOException,
                                       AutomationException

Gets the cache configuration.

Specified by:

getTileCacheInfo in interface ITiledImageServer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageTile

public byte[] getImageTile(int level,
                           int row,
                           int column)
                    throws java.io.IOException,
                           AutomationException

Gets a tile for a given tile location.

Specified by:

getImageTile in interface ITiledImageServer

Parameters:

level - The level (in)

row - The row (in)

column - The column (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTileImageInfo

public ITileImageInfo getTileImageInfo()
                                throws java.io.IOException,
                                       AutomationException

Gets the cache tile image information.

Specified by:

getTileImageInfo in interface ITiledImageServer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheStorageInfo

public ICacheStorageInfo getCacheStorageInfo()
                                      throws java.io.IOException,
                                             AutomationException

Gets the cache storage information.

Specified by:

getCacheStorageInfo in interface ITiledImageServer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedScaleImage

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

Indicates if it is fixed scale image.

Specified by:

isFixedScaleImage in interface ITiledImageServer

Returns:

The pIsFixed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

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

Gets the virtual cache directory for a given layer within a map.

Specified by:

getVirtualCacheDirectory in interface ITiledImageServer

Returns:

The pURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheDescriptionInfo

public ICacheDescriptionInfo getCacheDescriptionInfo()
                                              throws java.io.IOException,
                                                     AutomationException

Gets the cache description information for a given map.

Specified by:

getCacheDescriptionInfo in interface ITiledImageServer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

public ICacheControlInfo getCacheControlInfo()
                                      throws java.io.IOException,
                                             AutomationException

Gets the cache description information for a given map.

Specified by:

getCacheControlInfo in interface ITiledImageServer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationName

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

Name of the server object configuration that defines the server object.

Specified by:

getConfigurationName in interface IServerObject

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTypeName

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

Type of the server object (MapServer or GeocodeServer).

Specified by:

getTypeName in interface IServerObject

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws java.io.IOException,
                      AutomationException

Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws java.io.IOException,
                                  AutomationException

Handles a binary request.

Specified by:

handleBinaryRequest in interface IRequestHandler

Parameters:

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public java.lang.String handleStringRequest(java.lang.String capabilities,
                                            java.lang.String request)
                                     throws java.io.IOException,
                                            AutomationException

Handles a SOAP string request.

Specified by:

handleStringRequest in interface IRequestHandler

Parameters:

capabilities - The capabilities (in)

request - The request (in)

Returns:

The response

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws java.io.IOException,
                        AutomationException

Initializes an object with a log.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

initLogging in interface ILogSupport

Parameters:

log - A reference to a com.esri.arcgis.system.ILog (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

public void activate()
              throws java.io.IOException,
                     AutomationException

Activates the object.

Specified by:

activate in interface IObjectActivate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Deactivates the object.

Specified by:

deactivate in interface IObjectActivate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IServerObjectExtension findExtensionByCLSID(java.lang.String cLSID)
                                            throws java.io.IOException,
                                                   AutomationException

Returns a server object extension found using a string representation of its class ID.

Specified by:

findExtensionByCLSID in interface IServerObjectExtensionManager

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findExtensionByTypeName

public IServerObjectExtension findExtensionByTypeName(java.lang.String name)
                                               throws java.io.IOException,
                                                      AutomationException

Returns a server object extension found using its type name.

Specified by:

findExtensionByTypeName in interface IServerObjectExtensionManager

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

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.

getMosaicDataset

public IMosaicDataset getMosaicDataset()
                                throws java.io.IOException,
                                       AutomationException

The mosaic dataset.

Specified by:

getMosaicDataset in interface IImageServerObjects

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws java.io.IOException,
                                       AutomationException

The raster dataset.

Specified by:

getRasterDataset in interface IImageServerObjects

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

The raster.

Specified by:

getRaster in interface IImageServerObjects

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleRESTRequest

public byte[] handleRESTRequest(java.lang.String capabilities,
                                java.lang.String resourceName,
                                java.lang.String operationName,
                                java.lang.String operationInput,
                                java.lang.String outputFormat,
                                java.lang.String requestProperties,
                                java.lang.String[] responseProperties)
                         throws java.io.IOException,
                                AutomationException

Handles REST requests for SOE.

This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.

The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.

Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section

Specified by:

handleRESTRequest in interface IRESTRequestHandler

Parameters:

capabilities - The capabilities supported by the SOE. An admin can choose which capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles. This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)

resourceName - Name of the resource being addressed. If empty, its assumed that root resource is being addressed. (in)

operationName - Name of the operation being invoked. If empty, description of resource is returned. (in)

operationInput - Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)

outputFormat - OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)

requestProperties - The requestProperties (in)

responseProperties - The responseProperties (out)

Returns:

Output generated by the SOE

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSchema

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

This method returns the resource hierarchy of a REST based SOE. This hierarchy is in JSON format as shown in the example below:

For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like:

 {
   "name": "MyRESTSOE",
   "description": "My REST SOE with 3 resources and 1 operation each.",
   "isCollection": false,
   "operations": [
   {
      "name": "operation0",
      "parameters": ["param01"],
      "supportedOutputFormats": ["json"]
    }
 ],
 "resources": [
  {
      "name": "subresource1",
      "description": "Sub Resource 1",
      "isCollection": true,
      "operations": [
       {
          "name": "operation1",
          "parameters": ["param10", "param11"],
          "supportedOutputFormats": ["json"]
       }
    ]
  },
  {
      "name": "subresource2",
      "description": "Sub Resource 2",
      "isCollection": true,
      "operations": [
       {
          "name": "operation2",
          "parameters": ["param20", "param21"],
          "supportedOutputFormats": ["json"]
       }
    ]
  }
 ]
}

Specified by:

getSchema in interface IRESTRequestHandler

Returns:

resource hierarchy of REST SOE, as String

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toRasterFunctionTemplate

public IRasterFunctionTemplate toRasterFunctionTemplate(java.lang.String name)
                                                 throws java.io.IOException,
                                                        AutomationException

Constructs a raster function template from a known template name.

Specified by:

toRasterFunctionTemplate in interface IRasterFunctionTemplateMapper

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.