com.esri.arcgis.datasourcesraster
Interface IAISImageServiceX

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IAISImageService2X, IAISImageService3X

All Known Implementing Classes:

IAISImageService2XProxy, IAISImageService3XProxy, IAISImageServiceXProxy

public interface IAISImageServiceX
extends java.io.Serializable

COM Interface 'IAISImageServiceX'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'IAISImageService Interface' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDe97d7801_6643_4529_b88f_9318a38206e6
static int	xxDummy Deprecated. Internal use only

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.
java.lang.String	getImageMetadata(java.lang.String levelOfDetail) getImageMetadata
java.lang.String	getMetaData(java.lang.String requestString) getMetaData
java.lang.String	getProperty(java.lang.String name) Get the value of the given property
java.lang.String	getServiceInfo() getServiceInfo
java.lang.String	getServiceProperties() getServiceProperties
java.lang.String	getStatus() Returns a status XML string that defines the state of the last operation performed by this Image Service object.
boolean	init(java.lang.String imageServiceSource, java.lang.String serviceProperties, IAISClientObjectX parentClientObject) init
boolean	setProperty(java.lang.String name, java.lang.String value) Set the value of the given property
void	setServiceProperties(java.lang.String pVal) setServiceProperties

Field Detail

IIDe97d7801_6643_4529_b88f_9318a38206e6

static final int IIDe97d7801_6643_4529_b88f_9318a38206e6

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

init

boolean init(java.lang.String imageServiceSource,
             java.lang.String serviceProperties,
             IAISClientObjectX parentClientObject)
             throws java.io.IOException,
                    AutomationException

init

Parameters:

imageServiceSource - The imageServiceSource (in)

serviceProperties - The serviceProperties (in)

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

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceInfo

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

getServiceInfo

Returns:

The serviceInfoXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetaData

java.lang.String getMetaData(java.lang.String requestString)
                             throws java.io.IOException,
                                    AutomationException

getMetaData

Parameters:

requestString - The requestString (in)

Returns:

The metadata

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceProperties

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

getServiceProperties

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setServiceProperties

void setServiceProperties(java.lang.String pVal)
                          throws java.io.IOException,
                                 AutomationException

setServiceProperties

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyServiceProperties

boolean applyServiceProperties()
                               throws java.io.IOException,
                                      AutomationException

applyServiceProperties

Returns:

The retStatus

Throws:

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

extractAoi

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:

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

AutomationException - If the ArcObject component throws an exception.

getBufferSize

int getBufferSize()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

The bufferSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageInBuffer

boolean getImageInBuffer(int bufferPtr)
                         throws java.io.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.

Parameters:

bufferPtr - The bufferPtr (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageMetadata

java.lang.String getImageMetadata(java.lang.String levelOfDetail)
                                  throws java.io.IOException,
                                         AutomationException

getImageMetadata

Parameters:

levelOfDetail - The levelOfDetail (in)

Returns:

The imageMetaData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

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

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

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperty

boolean setProperty(java.lang.String name,
                    java.lang.String value)
                    throws java.io.IOException,
                           AutomationException

Set the value of the given property

Parameters:

name - The name (in)

value - The value (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperty

java.lang.String getProperty(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

Get the value of the given property

Parameters:

name - The name (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws java.io.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.

Throws:

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

AutomationException - If the ArcObject component throws an exception.