com.esri.arcgis.carto
Class ImageServerIP

java.lang.Object
  com.esri.arcgis.carto.ImageServerIP

All Implemented Interfaces:

IImageServer, IImageServer2, IImageServer3, ITiledImageServer, IAGSServerObject, IAGSServerObject2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class ImageServerIP
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObject, IAGSServerObject2, IImageServer, IImageServer2, IImageServer3, ISupportErrorInfo, ITiledImageServer

COM Class 'ImageServerIP'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Image Server Message Proxy.' 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.gisclient.IAGSServerObject2

IID, IID2e07daa3_6dec_4dc3_a7ed_2f29e2ecfe4a, xxDummy

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerObject

IID7c25fb69_eac4_433c_b08c_7ae39e83ffbd

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

IID, IIDd27b4a93_5dd5_47e0_9551_951010c342ad, xxDummy

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

IIDd9bf0bf1_2ac8_49f5_94cb_6b5182c6297f

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

IID10a6f247_a053_4bb1_aaf3_503ef365e10e

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID10bfd112_33d2_4986_997a_f2b6069e45b8, xxDummy

Constructor Summary

ImageServerIP()
Constructs a ImageServerIP using ArcGIS Engine.

ImageServerIP(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageServerIP theImageServerIP = (ImageServerIP) obj;

Method Summary

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.
IMapImage	exportMapImage(IGeoImageDescription pImageDescription, IImageType pImageType) Exports into a well-known image with a correct aspect ratio for a given image description.
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.
IFields	getFields() The fields of the image catalog.
java.lang.String	getFile(IImageServerDownloadResult pFile) Get the URL to a given download result.
IName	getFullName() The AGSServerConnectionName object associated with the server object.
int	getHttpTimeout() The maximum time in seconds to wait for a response from the server (Internet only).
byte[]	getImage(IGeoImageDescription pImageDescription) Gets an image for a given image description.
byte[]	getImageTile(int level, int row, int column) Gets a tile for a given tile location from a given map.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMetadata() The image service metadata.
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.
IRasterInfo	getRasterInfo(int rID) Gets the image information of a given raster catalog item.
java.lang.String	getRasterMetadata(int rID) Gets the metadata of a given raster catalog item.
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 for a given map.
ITileImageInfo	getTileImageInfo() Gets the cache tile image information for a given map.
float	getVersion() The Image Server version number.
java.lang.String	getVirtualCacheDirectory() Gets the virtual cache directory for a given layer within a map.
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.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isFixedScaleImage() Indicates if a given map is a fixed scale map.
void	release() Release a ImageServerIP.
void	setHttpTimeout(int secs) The maximum time in seconds to wait for a response from the server (Internet only).

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageServerIP

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

Constructs a ImageServerIP using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ImageServerIP

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

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

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

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a ImageServerIP.

Specified by:

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

getFullName

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

The AGSServerConnectionName object associated with the server object.

Specified by:

getFullName in interface IAGSServerObject2

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.

setHttpTimeout

public void setHttpTimeout(int secs)
                    throws java.io.IOException,
                           AutomationException

The maximum time in seconds to wait for a response from the server (Internet only).

Specified by:

setHttpTimeout in interface IAGSServerObject2

Parameters:

secs - The secs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHttpTimeout

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

The maximum time in seconds to wait for a response from the server (Internet only).

Specified by:

getHttpTimeout in interface IAGSServerObject2

Returns:

The secs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

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

The Image Server version number.

Specified by:

getVersion in interface IImageServer

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

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

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

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.

exportMapImage

public IMapImage exportMapImage(IGeoImageDescription pImageDescription,
                                IImageType pImageType)
                         throws java.io.IOException,
                                AutomationException

Exports into a well-known image with a correct aspect ratio for a given image description.

Specified by:

exportMapImage in interface IImageServer2

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

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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 IImageServer3

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.

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.

getTileCacheInfo

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

Gets the cache configuration for a given map.

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 from a given map.

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 for a given map.

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 a given map is a fixed scale map.

Specified by:

isFixedScaleImage in interface ITiledImageServer

Returns:

The pIsFixedScaleMap

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.