com.esri.arcgis.carto
Class ImageView

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

All Implemented Interfaces:

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

public class ImageView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageView, IXMLSerialize, IXMLVersionSupport, IPersistStream, IPersist, ISupportErrorInfo, Externalizable

An image view object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ImageView()
Constructs a ImageView using ArcGIS Engine.

ImageView(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageView theImageView = (ImageView) 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	getDescription() The image view description.
IEnvelope	getExtent() The image view extent.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IMosaicRule	getMosaicRule() The image view mosaic rule.
String	getName() The image view name.
void	getPixelSize(double[] pDx, double[] pDy) The pxiel size in its native units.
int	getPixelType() The pixel type.
IRenderingRule	getRenderingRule() The image view rendering rule.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getVID() The image view ID.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAdaptive() Indicates if view properties are adaptive to view content.
void	isDirty() isDirty
void	load(IStream pstm) load
void	putPixelSize(double dx, double dy) The pxiel size in its native units.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAdaptive(boolean pAdpative) Indicates if view properties are adaptive to view content.
void	setBandCount(int pNumBands) The number of bands.
void	setDescription(String pDescription) The image view description.
void	setExtentByRef(IEnvelope ppExtent) The image view extent.
void	setMosaicRuleByRef(IMosaicRule ppMosaicRule) The image view mosaic rule.
void	setName(String pName) The image view name.
void	setPixelType(int pPixelType) The pixel type.
void	setRenderingRuleByRef(IRenderingRule ppRenderingRule) The image view rendering rule.
void	setVID(String pVID) The image view ID.
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

ImageView

public ImageView()
          throws IOException,
                 UnknownHostException

Constructs a ImageView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImageView

public ImageView(Object obj)
          throws IOException

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

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

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

getVID

public String getVID()
              throws IOException,
                     AutomationException

The image view ID.

Product Availability

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

Specified by:

getVID in interface IImageView

Returns:

The pVID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVID

public void setVID(String pVID)
            throws IOException,
                   AutomationException

The image view ID.

Product Availability

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

Specified by:

setVID in interface IImageView

Parameters:

pVID - The pVID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The image view name.

Product Availability

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

Specified by:

getName in interface IImageView

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

The image view name.

Product Availability

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

Specified by:

setName in interface IImageView

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The image view description.

Product Availability

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

Specified by:

getDescription in interface IImageView

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The image view description.

Product Availability

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

Specified by:

setDescription in interface IImageView

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The image view extent.

Product Availability

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

Specified by:

getExtent in interface IImageView

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 image view extent.

Product Availability

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

Specified by:

setExtentByRef in interface IImageView

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.

getPixelSize

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

The pxiel size in its native units.

Product Availability

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

Specified by:

getPixelSize in interface IImageView

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.

putPixelSize

public void putPixelSize(double dx,
                         double dy)
                  throws IOException,
                         AutomationException

The pxiel size in its native units.

Product Availability

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

Specified by:

putPixelSize in interface IImageView

Parameters:

dx - The dx (in)

dy - The dy (in)

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 IImageView

Returns:

The pNumBands

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandCount

public void setBandCount(int pNumBands)
                  throws IOException,
                         AutomationException

The number of bands.

Product Availability

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

Specified by:

setBandCount in interface IImageView

Parameters:

pNumBands - The pNumBands (in)

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.

Product Availability

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

Specified by:

getPixelType in interface IImageView

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 pixel type.

Product Availability

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

Specified by:

setPixelType in interface IImageView

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.

getMosaicRule

public IMosaicRule getMosaicRule()
                          throws IOException,
                                 AutomationException

The image view mosaic rule.

Product Availability

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

Specified by:

getMosaicRule in interface IImageView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicRuleByRef

public void setMosaicRuleByRef(IMosaicRule ppMosaicRule)
                        throws IOException,
                               AutomationException

The image view mosaic rule.

Product Availability

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

Specified by:

setMosaicRuleByRef in interface IImageView

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderingRule

public IRenderingRule getRenderingRule()
                                throws IOException,
                                       AutomationException

The image view rendering rule.

Product Availability

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

Specified by:

getRenderingRule in interface IImageView

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderingRuleByRef

public void setRenderingRuleByRef(IRenderingRule ppRenderingRule)
                           throws IOException,
                                  AutomationException

The image view rendering rule.

Product Availability

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

Specified by:

setRenderingRuleByRef in interface IImageView

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAdaptive

public boolean isAdaptive()
                   throws IOException,
                          AutomationException

Indicates if view properties are adaptive to view content.

Product Availability

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

Specified by:

isAdaptive in interface IImageView

Returns:

The pAdpative

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdaptive

public void setAdaptive(boolean pAdpative)
                 throws IOException,
                        AutomationException

Indicates if view properties are adaptive to view content.

Product Availability

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

Specified by:

setAdaptive in interface IImageView

Parameters:

pAdpative - The pAdpative (in)

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.

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

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