com.esri.arcgis.carto
Class GeoImageDescription

java.lang.Object
  extended by com.esri.arcgis.carto.GeoImageDescription
All Implemented Interfaces:
IGeoImageDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

A class that specifies an image to read from an ArcGIS server image service.

Description

This object is new at ArcGIS 9.3.

Remarks

GeoImageDescription specifies an image to fetch from an image service, including spatial reference, cellsize, extent, compression and quality, NoData (background) value, band selection, and etc.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GeoImageDescription()
          Constructs a GeoImageDescription using ArcGIS Engine.
GeoImageDescription(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoImageDescription theGeoImageDescription = (GeoImageDescription) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 ILongArray getBandSelection()
          The band selection.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getCompression()
          The compression.
 int getCompressionQuality()
          The compression quality.
 IEnvelope getExtent()
          The extent.
 int getHeight()
          The Height in pixels.
 int getInterpolation()
          The interpolation method.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 String getMosaicProperties()
          The mosaic properties.
 Object getNoData()
          The output NoData (background) value.
 int getPixelType()
          The data type of the pixels.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The Spatial Reference.
 String getViewpointProperties()
          The viewpoint properties.
 int getWidth()
          The Width in pixels.
 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 setBandSelectionByRef(ILongArray ppBandIDs)
          The band selection.
 void setCompression(String pCompression)
          The compression.
 void setCompressionQuality(int pQuality)
          The compression quality.
 void setExtentByRef(IEnvelope ppExtent)
          The extent.
 void setHeight(int pNumRows)
          The Height in pixels.
 void setInterpolation(int pInterpolation)
          The interpolation method.
 void setMosaicProperties(String pMosaicProperties)
          The mosaic properties.
 void setNoData(Object pNoData)
          The output NoData (background) value.
 void setPixelType(int pPixelType)
          The data type of the pixels.
 void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
          The Spatial Reference.
 void setViewpointProperties(String pViewpointProperties)
          The viewpoint properties.
 void setWidth(int pNumCols)
          The Width in pixels.
 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

GeoImageDescription

public GeoImageDescription()
                    throws IOException,
                           UnknownHostException
Constructs a GeoImageDescription using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GeoImageDescription

public GeoImageDescription(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoImageDescription theGeoImageDescription = (GeoImageDescription) obj;

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

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The Spatial Reference.

Product Availability

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

Specified by:
getSpatialReference in interface IGeoImageDescription
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.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException
The Spatial Reference.

Product Availability

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

Specified by:
setSpatialReferenceByRef in interface IGeoImageDescription
Parameters:
ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent.

Product Availability

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

Specified by:
getExtent in interface IGeoImageDescription
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.

setExtentByRef

public void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException
The extent.

Product Availability

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

Specified by:
setExtentByRef in interface IGeoImageDescription
Parameters:
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
The Width in pixels.

Product Availability

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

Specified by:
getWidth in interface IGeoImageDescription
Returns:
The pNumCols
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pNumCols)
              throws IOException,
                     AutomationException
The Width in pixels.

Product Availability

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

Specified by:
setWidth in interface IGeoImageDescription
Parameters:
pNumCols - The pNumCols (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
The Height in pixels.

Product Availability

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

Specified by:
getHeight in interface IGeoImageDescription
Returns:
The pNumRows
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int pNumRows)
               throws IOException,
                      AutomationException
The Height in pixels.

Product Availability

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

Specified by:
setHeight in interface IGeoImageDescription
Parameters:
pNumRows - The pNumRows (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws IOException,
                        AutomationException
The data type of the pixels.

Product Availability

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

Specified by:
getPixelType in interface IGeoImageDescription
Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException
The data type of the pixels.

Product Availability

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

Specified by:
setPixelType in interface IGeoImageDescription
Parameters:
pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoData

public Object getNoData()
                 throws IOException,
                        AutomationException
The output NoData (background) value.

Product Availability

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

Specified by:
getNoData in interface IGeoImageDescription
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoData

public void setNoData(Object pNoData)
               throws IOException,
                      AutomationException
The output NoData (background) value.

Product Availability

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

Specified by:
setNoData in interface IGeoImageDescription
Parameters:
pNoData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInterpolation

public int getInterpolation()
                     throws IOException,
                            AutomationException
The interpolation method.

Product Availability

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

Specified by:
getInterpolation in interface IGeoImageDescription
Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInterpolation

public void setInterpolation(int pInterpolation)
                      throws IOException,
                             AutomationException
The interpolation method.

Product Availability

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

Specified by:
setInterpolation in interface IGeoImageDescription
Parameters:
pInterpolation - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompression

public String getCompression()
                      throws IOException,
                             AutomationException
The compression.

Product Availability

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

Specified by:
getCompression in interface IGeoImageDescription
Returns:
The pCompression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompression

public void setCompression(String pCompression)
                    throws IOException,
                           AutomationException
The compression.

Product Availability

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

Specified by:
setCompression in interface IGeoImageDescription
Parameters:
pCompression - The pCompression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

public int getCompressionQuality()
                          throws IOException,
                                 AutomationException
The compression quality.

Product Availability

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

Specified by:
getCompressionQuality in interface IGeoImageDescription
Returns:
The pQuality
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int pQuality)
                           throws IOException,
                                  AutomationException
The compression quality.

Product Availability

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

Specified by:
setCompressionQuality in interface IGeoImageDescription
Parameters:
pQuality - The pQuality (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandSelection

public ILongArray getBandSelection()
                            throws IOException,
                                   AutomationException
The band selection.

Product Availability

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

Specified by:
getBandSelection in interface IGeoImageDescription
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandSelectionByRef

public void setBandSelectionByRef(ILongArray ppBandIDs)
                           throws IOException,
                                  AutomationException
The band selection.

Product Availability

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

Specified by:
setBandSelectionByRef in interface IGeoImageDescription
Parameters:
ppBandIDs - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicProperties

public void setMosaicProperties(String pMosaicProperties)
                         throws IOException,
                                AutomationException
The mosaic properties.

Product Availability

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

Specified by:
setMosaicProperties in interface IGeoImageDescription
Parameters:
pMosaicProperties - The pMosaicProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicProperties

public String getMosaicProperties()
                           throws IOException,
                                  AutomationException
The mosaic properties.

Product Availability

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

Specified by:
getMosaicProperties in interface IGeoImageDescription
Returns:
The pMosaicProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setViewpointProperties

public void setViewpointProperties(String pViewpointProperties)
                            throws IOException,
                                   AutomationException
The viewpoint properties.

Product Availability

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

Specified by:
setViewpointProperties in interface IGeoImageDescription
Parameters:
pViewpointProperties - The pViewpointProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewpointProperties

public String getViewpointProperties()
                              throws IOException,
                                     AutomationException
The viewpoint properties.

Product Availability

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

Specified by:
getViewpointProperties in interface IGeoImageDescription
Returns:
The pViewpointProperties
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