com.esri.arcgis.carto
Class ImageServiceInfo

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

All Implemented Interfaces:

IImageServiceInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class ImageServiceInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageServiceInfo, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

A class that provides information on an ArcGIS server image service.

Description

This object is new at ArcGIS 9.3.

Remarks

ImageServerInfo is a value object returned from IImageServer::ServiceInfo, and it supports IImageServiceInfo interface. It contains information that describes an image service. The interface provides access to image service information, such as native spatial reference, extent, cellsize, band statistics and etc, about an image service. There is no colormap, histogram, and attribute table.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ImageServiceInfo()
Constructs a ImageServiceInfo using ArcGIS Engine.

ImageServiceInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageServiceInfo theImageServiceInfo = (ImageServiceInfo) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
int	getBandCount() The number of bands.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getCopyrightText() Copyright information associated with the image service.
String	getDefaultServiceProperties() The default service properties.
String	getDescription() The description of the image service.
IEnvelope	getExtent() The extent of the image service.
double	getMaximumPixelSize() The maximum visible pixel size.
int	getMaxNCols() The maximum number of colums this service supports.
int	getMaxNRows() The maximum number of rows this service supports.
double	getMinimumPixelSize() The minimum visible pixel size.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getName() The name of the image service.
Object	getNoData() The NoData (background) value of the image service.
void	getPixelSize(double[] pDx, double[] pDy) Gets the pxiel size of the image service, in its native units.
int	getPixelType() The pixel type of the image service.
int	getServiceDataType() The data type of the image service.
int	getServiceSourceType() The image service data source type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the image service.
void	getStatistics(int iBand, double[] pMin, double[] pMax, double[] pMean, double[] pStdv) Gets the statistics of a given band.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCopyrightText(String pCopyright) Copyright information associated with the image service.
void	setDefaultServiceProperties(String pServiceProperties) The default service properties.
void	setServiceDataType(int pDataType) The data type of the image service.
void	setServiceSourceType(int pServiceSourceType) The image service data source type.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ImageServiceInfo

public ImageServiceInfo()
                 throws IOException,
                        UnknownHostException

Constructs a ImageServiceInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImageServiceInfo

public ImageServiceInfo(Object obj)
                 throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the image service.

Product Availability

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

Specified by:

getName in interface IImageServiceInfo

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the image service.

Product Availability

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

Specified by:

getDescription in interface IImageServiceInfo

Returns:

The pDescrition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the image service.

Product Availability

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

Specified by:

getSpatialReference in interface IImageServiceInfo

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the image service.

Product Availability

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

Specified by:

getExtent in interface IImageServiceInfo

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelSize

public void getPixelSize(double[] pDx,
                         double[] pDy)
                  throws IOException,
                         AutomationException

Gets the pxiel size of the image service, in its native units.

Product Availability

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

Specified by:

getPixelSize in interface IImageServiceInfo

Parameters:

pDx - The pDx (out: use single element array)

pDy - The pDy (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatistics

public void getStatistics(int iBand,
                          double[] pMin,
                          double[] pMax,
                          double[] pMean,
                          double[] pStdv)
                   throws IOException,
                          AutomationException

Gets the statistics of a given band.

Product Availability

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

Specified by:

getStatistics in interface IImageServiceInfo

Parameters:

iBand - The iBand (in)

pMin - The pMin (out: use single element array)

pMax - The pMax (out: use single element array)

pMean - The pMean (out: use single element array)

pStdv - The pStdv (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandCount

public int getBandCount()
                 throws IOException,
                        AutomationException

The number of bands.

Product Availability

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

Specified by:

getBandCount in interface IImageServiceInfo

Returns:

The pBandCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws IOException,
                        AutomationException

The pixel type of the image service.

Product Availability

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

Specified by:

getPixelType in interface IImageServiceInfo

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoData

public Object getNoData()
                 throws IOException,
                        AutomationException

The NoData (background) value of the image service.

Product Availability

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

Specified by:

getNoData in interface IImageServiceInfo

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumPixelSize

public double getMaximumPixelSize()
                           throws IOException,
                                  AutomationException

The maximum visible pixel size.

Product Availability

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

Specified by:

getMaximumPixelSize in interface IImageServiceInfo

Returns:

The pMaxPixelSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumPixelSize

public double getMinimumPixelSize()
                           throws IOException,
                                  AutomationException

The minimum visible pixel size.

Product Availability

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

Specified by:

getMinimumPixelSize in interface IImageServiceInfo

Returns:

The pMinPixelSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

public String getCopyrightText()
                        throws IOException,
                               AutomationException

Copyright information associated with the image service.

Product Availability

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

Specified by:

getCopyrightText in interface IImageServiceInfo

Returns:

The pCopyright

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCopyrightText

public void setCopyrightText(String pCopyright)
                      throws IOException,
                             AutomationException

Copyright information associated with the image service.

Product Availability

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

Specified by:

setCopyrightText in interface IImageServiceInfo

Parameters:

pCopyright - The pCopyright (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceDataType

public int getServiceDataType()
                       throws IOException,
                              AutomationException

The data type of the image service.

Product Availability

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

Specified by:

getServiceDataType in interface IImageServiceInfo

Returns:

A com.esri.arcgis.carto.esriImageServiceDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceDataType

public void setServiceDataType(int pDataType)
                        throws IOException,
                               AutomationException

The data type of the image service.

Product Availability

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

Specified by:

setServiceDataType in interface IImageServiceInfo

Parameters:

pDataType - A com.esri.arcgis.carto.esriImageServiceDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultServiceProperties

public void setDefaultServiceProperties(String pServiceProperties)
                                 throws IOException,
                                        AutomationException

The default service properties.

Product Availability

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

Specified by:

setDefaultServiceProperties in interface IImageServiceInfo

Parameters:

pServiceProperties - The pServiceProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultServiceProperties

public String getDefaultServiceProperties()
                                   throws IOException,
                                          AutomationException

The default service properties.

Product Availability

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

Specified by:

getDefaultServiceProperties in interface IImageServiceInfo

Returns:

The pServiceProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxNCols

public int getMaxNCols()
                throws IOException,
                       AutomationException

The maximum number of colums this service supports.

Product Availability

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

Specified by:

getMaxNCols in interface IImageServiceInfo

Returns:

The pMaxNCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxNRows

public int getMaxNRows()
                throws IOException,
                       AutomationException

The maximum number of rows this service supports.

Product Availability

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

Specified by:

getMaxNRows in interface IImageServiceInfo

Returns:

The pMaxNRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceSourceType

public int getServiceSourceType()
                         throws IOException,
                                AutomationException

The image service data source type.

Product Availability

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

Specified by:

getServiceSourceType in interface IImageServiceInfo

Returns:

A com.esri.arcgis.carto.esriImageServiceSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceSourceType

public void setServiceSourceType(int pServiceSourceType)
                          throws IOException,
                                 AutomationException

The image service data source type.

Product Availability

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

Specified by:

setServiceSourceType in interface IImageServiceInfo

Parameters:

pServiceSourceType - A com.esri.arcgis.carto.esriImageServiceSourceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException