com.esri.arcgis.datasourcesraster
Class IAISImageServiceXProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.IAISImageServiceXProxy

All Implemented Interfaces:

IAISImageServiceX, Externalizable, Serializable

Direct Known Subclasses:

IAISImageService2XProxy

public class IAISImageServiceXProxy
extends com.esri.arcgis.interop.Dispatch
implements IAISImageServiceX, Serializable

IAISImageService Interface

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IAISImageServiceXProxy()
	IAISImageServiceXProxy(Object obj)
protected	IAISImageServiceXProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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
void	removeListener(String iidStr, Object theListener)
boolean	setProperty(String name, String value) Set the value of the given property
void	setServiceProperties(String pVal) setServiceProperties

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IAISImageServiceXProxy

public IAISImageServiceXProxy()

IAISImageServiceXProxy

public IAISImageServiceXProxy(Object obj)
                       throws IOException

Throws:

IOException

IAISImageServiceXProxy

protected IAISImageServiceXProxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

init

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

init

Product Availability

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

Specified by:

init in interface IAISImageServiceX

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

public String getServiceInfo()
                      throws IOException,
                             AutomationException

getServiceInfo

Product Availability

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

Specified by:

getServiceInfo in interface IAISImageServiceX

Returns:

The serviceInfoXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetaData

public String getMetaData(String requestString)
                   throws IOException,
                          AutomationException

getMetaData

Product Availability

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

Specified by:

getMetaData in interface IAISImageServiceX

Parameters:

requestString - The requestString (in)

Returns:

The metadata

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceProperties

public String getServiceProperties()
                            throws IOException,
                                   AutomationException

getServiceProperties

Product Availability

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

Specified by:

getServiceProperties in interface IAISImageServiceX

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceProperties

public void setServiceProperties(String pVal)
                          throws IOException,
                                 AutomationException

setServiceProperties

Product Availability

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

Specified by:

setServiceProperties in interface IAISImageServiceX

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyServiceProperties

public boolean applyServiceProperties()
                               throws IOException,
                                      AutomationException

applyServiceProperties

Product Availability

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

Specified by:

applyServiceProperties in interface IAISImageServiceX

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extractAoi

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

Specified by:

extractAoi in interface IAISImageServiceX

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

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

Specified by:

getBufferSize in interface IAISImageServiceX

Returns:

The bufferSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageInBuffer

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

Specified by:

getImageInBuffer in interface IAISImageServiceX

Parameters:

bufferPtr - The bufferPtr (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageMetadata

public String getImageMetadata(String levelOfDetail)
                        throws IOException,
                               AutomationException

getImageMetadata

Product Availability

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

Specified by:

getImageMetadata in interface IAISImageServiceX

Parameters:

levelOfDetail - The levelOfDetail (in)

Returns:

The imageMetaData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

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

Specified by:

getStatus in interface IAISImageServiceX

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

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

Specified by:

setProperty in interface IAISImageServiceX

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

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

Specified by:

getProperty in interface IAISImageServiceX

Parameters:

name - The name (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

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

Specified by:

close in interface IAISImageServiceX

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.