com.esri.arcgis.datasourcesraster

Class ImageViewOperationParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.ImageViewOperationParameters

All Implemented Interfaces:

IImageViewOperationParameters, IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, IMosaicDatasetOperationParameters3, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ImageViewOperationParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageViewOperationParameters, IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, IMosaicDatasetOperationParameters3

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

Description 'An object that controls image view operations on a mosaic dataset.' 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 inherited from interface com.esri.arcgis.datasourcesraster.IImageViewOperationParameters

IID, IID9cf99e96_a05c_409d_b194_486a73f0b731, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters3

IID, IID0f656cef_47b0_46dc_a9fa_be3c31103086, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters2

IID38662eb1_a3ae_42ab_a7d6_1f87ef453b32

Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters

IID379006f4_6f75_4c3b_b783_0c2e88a7b280

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
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.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isPrepareResults() Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.
boolean	isRefresh() Indicates whether the geodatabase data dictionary should be refreshed by the operation.
boolean	isRemoveOrphanItems() Indicates whether member items that are orphaned by the removal of an image view are also removed from the mosaic dataset.
boolean	isUpdateMembership() Indicates whether the view membership table associated with the mosaic dataset is updated.
void	release() Release this COM object reference
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setPrepareResults(boolean pbPrepareResults) Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setRefresh(boolean pbRefresh) Indicates whether the geodatabase data dictionary should be refreshed by the operation.
void	setRemoveOrphanItems(boolean pbRemoveOrphanItems) Indicates whether member items that are orphaned by the removal of an image view are also removed from the mosaic dataset.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setUpdateMembership(boolean pbUpdateMembership) Indicates whether the view membership table associated with the mosaic dataset is updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageViewOperationParameters

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

Constructs a ImageViewOperationParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ImageViewOperationParameters

public ImageViewOperationParameters(java.lang.Object obj)
                             throws java.io.IOException

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

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

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

setUpdateMembership

public void setUpdateMembership(boolean pbUpdateMembership)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the view membership table associated with the mosaic dataset is updated.

Specified by:

setUpdateMembership in interface IImageViewOperationParameters

Parameters:

pbUpdateMembership - The pbUpdateMembership (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateMembership

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

Indicates whether the view membership table associated with the mosaic dataset is updated.

Specified by:

isUpdateMembership in interface IImageViewOperationParameters

Returns:

The pbUpdateMembership

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveOrphanItems

public void setRemoveOrphanItems(boolean pbRemoveOrphanItems)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether member items that are orphaned by the removal of an image view are also removed from the mosaic dataset.

Specified by:

setRemoveOrphanItems in interface IImageViewOperationParameters

Parameters:

pbRemoveOrphanItems - The pbRemoveOrphanItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveOrphanItems

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

Indicates whether member items that are orphaned by the removal of an image view are also removed from the mosaic dataset.

Specified by:

isRemoveOrphanItems in interface IImageViewOperationParameters

Returns:

The pbRemoveOrphanItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws java.io.IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws java.io.IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws java.io.IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws java.io.IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

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

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws java.io.IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws java.io.IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrepareResults

public void setPrepareResults(boolean pbPrepareResults)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.

Specified by:

setPrepareResults in interface IMosaicDatasetOperationParameters2

Parameters:

pbPrepareResults - The pbPrepareResults (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPrepareResults

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

Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.

Specified by:

isPrepareResults in interface IMosaicDatasetOperationParameters2

Returns:

The pbPrepareResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefresh

public void setRefresh(boolean pbRefresh)
                throws java.io.IOException,
                       AutomationException

Indicates whether the geodatabase data dictionary should be refreshed by the operation.

Specified by:

setRefresh in interface IMosaicDatasetOperationParameters3

Parameters:

pbRefresh - The pbRefresh (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefresh

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

Indicates whether the geodatabase data dictionary should be refreshed by the operation.

Specified by:

isRefresh in interface IMosaicDatasetOperationParameters3

Returns:

The pbRefresh

Throws:

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

AutomationException - If the ArcObject component throws an exception.