com.esri.arcgis.datasourcesraster
Interface IAISImageServiceX

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAISImageService2X, IAISImageService3X

All Known Implementing Classes:

IAISImageService2XProxy, IAISImageServiceXProxy

public interface IAISImageServiceX
extends Serializable

IAISImageService Interface

Product Availability

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

Method Summary

boolean	applyServiceProperties() applyServiceProperties
void	close() Shuts downs and cleans up the Image Service object.
boolean	extractAoi(double x1, double y1, double x2, double y2, int nCols, int nRows) extractAoi
int	getBufferSize() Returns the size of buffer required for the last request AOI image.
boolean	getImageInBuffer(int bufferPtr) Gets the last requested AOI image into the buffer provided.
String	getImageMetadata(String levelOfDetail) getImageMetadata
String	getMetaData(String requestString) getMetaData
String	getProperty(String name) Get the value of the given property
String	getServiceInfo() getServiceInfo
String	getServiceProperties() getServiceProperties
String	getStatus() Returns a status XML string that defines the state of the last operation performed by this Image Service object.
boolean	init(String imageServiceSource, String serviceProperties, IAISClientObjectX parentClientObject) init
boolean	setProperty(String name, String value) Set the value of the given property
void	setServiceProperties(String pVal) setServiceProperties

Method Detail

init

boolean init(String imageServiceSource,
             String serviceProperties,
             IAISClientObjectX parentClientObject)
             throws IOException,
                    AutomationException

init

Product Availability

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

Parameters:

imageServiceSource - The imageServiceSource (in)

serviceProperties - The serviceProperties (in)

parentClientObject - A reference to a com.esri.arcgis.datasourcesraster.IAISClientObjectX (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceInfo

String getServiceInfo()
                      throws IOException,
                             AutomationException

getServiceInfo

Product Availability

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

Returns:

The serviceInfoXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetaData

String getMetaData(String requestString)
                   throws IOException,
                          AutomationException

getMetaData

Product Availability

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

Parameters:

requestString - The requestString (in)

Returns:

The metadata

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceProperties

String getServiceProperties()
                            throws IOException,
                                   AutomationException

getServiceProperties

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceProperties

void setServiceProperties(String pVal)
                          throws IOException,
                                 AutomationException

setServiceProperties

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyServiceProperties

boolean applyServiceProperties()
                               throws IOException,
                                      AutomationException

applyServiceProperties

Product Availability

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

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extractAoi

boolean extractAoi(double x1,
                   double y1,
                   double x2,
                   double y2,
                   int nCols,
                   int nRows)
                   throws IOException,
                          AutomationException

extractAoi

Product Availability

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

Parameters:

x1 - The x1 (in)

y1 - The y1 (in)

x2 - The x2 (in)

y2 - The y2 (in)

nCols - The nCols (in)

nRows - The nRows (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferSize

int getBufferSize()
                  throws IOException,
                         AutomationException

Returns the size of buffer required for the last request AOI image.

Product Availability

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

Returns:

The bufferSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageInBuffer

boolean getImageInBuffer(int bufferPtr)
                         throws IOException,
                                AutomationException

Gets the last requested AOI image into the buffer provided. This method will not work on 64-bit platforms and has been deprecated. Use the new alternative method QueryImageData() on IAISImageService3X for the same purpose.

Product Availability

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

Parameters:

bufferPtr - The bufferPtr (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageMetadata

String getImageMetadata(String levelOfDetail)
                        throws IOException,
                               AutomationException

getImageMetadata

Product Availability

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

Parameters:

levelOfDetail - The levelOfDetail (in)

Returns:

The imageMetaData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

String getStatus()
                 throws IOException,
                        AutomationException

Returns a status XML string that defines the state of the last operation performed by this Image Service object.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

boolean setProperty(String name,
                    String value)
                    throws IOException,
                           AutomationException

Set the value of the given property

Product Availability

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

Parameters:

name - The name (in)

value - The value (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperty

String getProperty(String name)
                   throws IOException,
                          AutomationException

Get the value of the given property

Product Availability

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

Parameters:

name - The name (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws IOException,
                  AutomationException

Shuts downs and cleans up the Image Service object. This function does not clean up other objects created by the Image Service object itself.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.