com.esri.arcgis.carto

Class GeoImageDescription

java.lang.Object

com.esri.arcgis.carto.GeoImageDescription

All Implemented Interfaces:

IGeoImageDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

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

COM Class 'GeoImageDescription'. Generated 9/24/2024 11:01:27 AM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'A class that specifies an image to read from an ArcGIS server image service.' 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 =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IGeoImageDescription

IID, IID03b73b41_d7df_4a25_a1c1_82f126f4d2f3, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
GeoImageDescription() Constructs a GeoImageDescription using ArcGIS Engine.
GeoImageDescription(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GeoImageDescription theGeoImageDescription = (GeoImageDescription) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
ILongArray	getBandSelection() The band selection.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCompression() The compression.
int	getCompressionQuality() The compression quality.
IEnvelope	getExtent() The extent.
IGeoTransformation	getGeoTransformation() The geographic transformation required to transform from the source to the requested GCS.
int	getHeight() The Height in pixels.
int	getInterpolation() The interpolation method.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getMosaicProperties() The mosaic properties.
IMosaicRule	getMosaicRule() The mosaic rule.
java.lang.Object	getNoData() The output NoData (background) value.
int	getNoDataInterpretation() The NoData interpretation.
int	getPixelType() The data type of the pixels.
IRenderingRule	getRenderingRule() The rendering rule.
int	getResamplingHint() The raster resampling hint.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The Spatial Reference.
java.lang.String	getViewpointProperties() The viewpoint properties.
int	getWidth() The Width in pixels.
int	hashCode() the hashcode for this object
boolean	isBSQ() Indicates if output should be generated in BSQ pxiel interleave format.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBandSelectionByRef(ILongArray ppBandIDs) The band selection.
void	setBSQ(boolean pBSQ) Indicates if output should be generated in BSQ pxiel interleave format.
void	setCompression(java.lang.String pCompression) The compression.
void	setCompressionQuality(int pQuality) The compression quality.
void	setExtentByRef(IEnvelope ppExtent) The extent.
void	setGeoTransformationByRef(IGeoTransformation geotransform) The geographic transformation required to transform from the source to the requested GCS.
void	setHeight(int pNumRows) The Height in pixels.
void	setInterpolation(int pInterpolation) The interpolation method.
void	setMosaicProperties(java.lang.String pMosaicProperties) The mosaic properties.
void	setMosaicRuleByRef(IMosaicRule ppMosaicRule) The mosaic rule.
void	setNoData(java.lang.Object pNoData) The output NoData (background) value.
void	setNoDataInterpretation(int pNoDataInterpretation) The NoData interpretation.
void	setPixelType(int pPixelType) The data type of the pixels.
void	setRenderingRuleByRef(IRenderingRule ppRenderingRule) The rendering rule.
void	setResamplingHint(int pHint) The raster resampling hint.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The Spatial Reference.
void	setViewpointProperties(java.lang.String pViewpointProperties) The viewpoint properties.
void	setWidth(int pNumCols) The Width in pixels.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GeoImageDescription

public GeoImageDescription()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a GeoImageDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeoImageDescription

public GeoImageDescription(java.lang.Object obj)
                    throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The Spatial Reference.

Specified by:

getSpatialReference in interface IGeoImageDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws java.io.IOException,
                                     AutomationException

The Spatial Reference.

Specified by:

setSpatialReferenceByRef in interface IGeoImageDescription

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent.

Specified by:

getExtent in interface IGeoImageDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope ppExtent)
                    throws java.io.IOException,
                           AutomationException

The extent.

Specified by:

setExtentByRef in interface IGeoImageDescription

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException

The Width in pixels.

Specified by:

getWidth in interface IGeoImageDescription

Returns:

The pNumCols

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pNumCols)
              throws java.io.IOException,
                     AutomationException

The Width in pixels.

Specified by:

setWidth in interface IGeoImageDescription

Parameters:

pNumCols - The pNumCols (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException

The Height in pixels.

Specified by:

getHeight in interface IGeoImageDescription

Returns:

The pNumRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int pNumRows)
               throws java.io.IOException,
                      AutomationException

The Height in pixels.

Specified by:

setHeight in interface IGeoImageDescription

Parameters:

pNumRows - The pNumRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType()
                 throws java.io.IOException,
                        AutomationException

The data type of the pixels.

Specified by:

getPixelType in interface IGeoImageDescription

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws java.io.IOException,
                         AutomationException

The data type of the pixels.

Specified by:

setPixelType in interface IGeoImageDescription

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoData

public java.lang.Object getNoData()
                           throws java.io.IOException,
                                  AutomationException

The output NoData (background) value.

Specified by:

getNoData in interface IGeoImageDescription

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoData

public void setNoData(java.lang.Object pNoData)
               throws java.io.IOException,
                      AutomationException

The output NoData (background) value.

Specified by:

setNoData in interface IGeoImageDescription

Parameters:

pNoData - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInterpolation

public int getInterpolation()
                     throws java.io.IOException,
                            AutomationException

The interpolation method.

Specified by:

getInterpolation in interface IGeoImageDescription

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterpolation

public void setInterpolation(int pInterpolation)
                      throws java.io.IOException,
                             AutomationException

The interpolation method.

Specified by:

setInterpolation in interface IGeoImageDescription

Parameters:

pInterpolation - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompression

public java.lang.String getCompression()
                                throws java.io.IOException,
                                       AutomationException

The compression.

Specified by:

getCompression in interface IGeoImageDescription

Returns:

The pCompression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompression

public void setCompression(java.lang.String pCompression)
                    throws java.io.IOException,
                           AutomationException

The compression.

Specified by:

setCompression in interface IGeoImageDescription

Parameters:

pCompression - The pCompression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

public int getCompressionQuality()
                          throws java.io.IOException,
                                 AutomationException

The compression quality.

Specified by:

getCompressionQuality in interface IGeoImageDescription

Returns:

The pQuality

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int pQuality)
                           throws java.io.IOException,
                                  AutomationException

The compression quality.

Specified by:

setCompressionQuality in interface IGeoImageDescription

Parameters:

pQuality - The pQuality (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandSelection

public ILongArray getBandSelection()
                            throws java.io.IOException,
                                   AutomationException

The band selection.

Specified by:

getBandSelection in interface IGeoImageDescription

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandSelectionByRef

public void setBandSelectionByRef(ILongArray ppBandIDs)
                           throws java.io.IOException,
                                  AutomationException

The band selection.

Specified by:

setBandSelectionByRef in interface IGeoImageDescription

Parameters:

ppBandIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMosaicProperties

public void setMosaicProperties(java.lang.String pMosaicProperties)
                         throws java.io.IOException,
                                AutomationException

The mosaic properties.

Specified by:

setMosaicProperties in interface IGeoImageDescription

Parameters:

pMosaicProperties - The pMosaicProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMosaicProperties

public java.lang.String getMosaicProperties()
                                     throws java.io.IOException,
                                            AutomationException

The mosaic properties.

Specified by:

getMosaicProperties in interface IGeoImageDescription

Returns:

The pMosaicProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setViewpointProperties

public void setViewpointProperties(java.lang.String pViewpointProperties)
                            throws java.io.IOException,
                                   AutomationException

The viewpoint properties.

Specified by:

setViewpointProperties in interface IGeoImageDescription

Parameters:

pViewpointProperties - The pViewpointProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getViewpointProperties

public java.lang.String getViewpointProperties()
                                        throws java.io.IOException,
                                               AutomationException

The viewpoint properties.

Specified by:

getViewpointProperties in interface IGeoImageDescription

Returns:

The pViewpointProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMosaicRule

public IMosaicRule getMosaicRule()
                          throws java.io.IOException,
                                 AutomationException

The mosaic rule.

Specified by:

getMosaicRule in interface IGeoImageDescription

Returns:

A reference to a com.esri.arcgis.carto.IMosaicRule

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMosaicRuleByRef

public void setMosaicRuleByRef(IMosaicRule ppMosaicRule)
                        throws java.io.IOException,
                               AutomationException

The mosaic rule.

Specified by:

setMosaicRuleByRef in interface IGeoImageDescription

Parameters:

ppMosaicRule - A reference to a com.esri.arcgis.carto.IMosaicRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderingRule

public IRenderingRule getRenderingRule()
                                throws java.io.IOException,
                                       AutomationException

The rendering rule.

Specified by:

getRenderingRule in interface IGeoImageDescription

Returns:

A reference to a com.esri.arcgis.carto.IRenderingRule

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRenderingRuleByRef

public void setRenderingRuleByRef(IRenderingRule ppRenderingRule)
                           throws java.io.IOException,
                                  AutomationException

The rendering rule.

Specified by:

setRenderingRuleByRef in interface IGeoImageDescription

Parameters:

ppRenderingRule - A reference to a com.esri.arcgis.carto.IRenderingRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBSQ

public boolean isBSQ()
              throws java.io.IOException,
                     AutomationException

Indicates if output should be generated in BSQ pxiel interleave format.

Specified by:

isBSQ in interface IGeoImageDescription

Returns:

The pBSQ

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBSQ

public void setBSQ(boolean pBSQ)
            throws java.io.IOException,
                   AutomationException

Indicates if output should be generated in BSQ pxiel interleave format.

Specified by:

setBSQ in interface IGeoImageDescription

Parameters:

pBSQ - The pBSQ (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataInterpretation

public int getNoDataInterpretation()
                            throws java.io.IOException,
                                   AutomationException

The NoData interpretation.

Specified by:

getNoDataInterpretation in interface IGeoImageDescription

Returns:

A com.esri.arcgis.datasourcesraster.esriNoDataInterpretation constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataInterpretation

public void setNoDataInterpretation(int pNoDataInterpretation)
                             throws java.io.IOException,
                                    AutomationException

The NoData interpretation.

Specified by:

setNoDataInterpretation in interface IGeoImageDescription

Parameters:

pNoDataInterpretation - A com.esri.arcgis.datasourcesraster.esriNoDataInterpretation constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformation

public IGeoTransformation getGeoTransformation()
                                        throws java.io.IOException,
                                               AutomationException

The geographic transformation required to transform from the source to the requested GCS.

Specified by:

getGeoTransformation in interface IGeoImageDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationByRef

public void setGeoTransformationByRef(IGeoTransformation geotransform)
                               throws java.io.IOException,
                                      AutomationException

The geographic transformation required to transform from the source to the requested GCS.

Specified by:

setGeoTransformationByRef in interface IGeoImageDescription

Parameters:

geotransform - A reference to a com.esri.arcgis.geometry.IGeoTransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingHint

public int getResamplingHint()
                      throws java.io.IOException,
                             AutomationException

The raster resampling hint.

Specified by:

getResamplingHint in interface IGeoImageDescription

Returns:

A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingHint

public void setResamplingHint(int pHint)
                       throws java.io.IOException,
                              AutomationException

The raster resampling hint.

Specified by:

setResamplingHint in interface IGeoImageDescription

Parameters:

pHint - A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException