com.esri.arcgis.datasourcesraster

Class RemoveItemsParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.RemoveItemsParameters

All Implemented Interfaces:

IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, IRemoveItemsParameters, IRemoveItemsParameters2, IRemoveItemsParameters3, IRemoveItemsParameters4, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RemoveItemsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, IRemoveItemsParameters, IRemoveItemsParameters2, IRemoveItemsParameters3, IRemoveItemsParameters4, ISelectionParameters

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

Description 'An object that controls how items are removed from 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.IMosaicDatasetOperationParameters2

IID, IID38662eb1_a3ae_42ab_a7d6_1f87ef453b32, xxDummy

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

IID379006f4_6f75_4c3b_b783_0c2e88a7b280

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

IID, IID8189cbdf_485a_458f_a79c_cda4a8c2a954, xxDummy

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

IIDf0292ac5_4dba_4ca8_a7b8_452df0dc79d0

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

IID1392ac33_0be8_4c56_93b8_ae0644297c68

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

IIDa907cb6a_6cfc_4fb5_8d80_93ea185416d7

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

Constructors

Constructor and Description
RemoveItemsParameters() Constructs a RemoveItemsParameters using ArcGIS Engine.
RemoveItemsParameters(java.lang.Object obj) Construct a RemoveItemsParameters using a reference to such an object returned from ArcGIS Engine or Server.

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.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
ISelectionSet	getSelectionSet() The selection set that identifies the collection of catalog items on which to perform the associated operation.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isDeleteItemCache() Indicates whether the cache files associated with selected mosaic dataset items are deleted.
boolean	isDeleteOverviewImages() Indicates whether the raster dataset associated with selected overview items are deleted as well.
boolean	isPrepareResults() Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.
boolean	isRemoveBrokenItemsOnly() Indicates whether only catalog items with broken paths are removed.
boolean	isRemoveColorCorrection() Indicates whether color corrrection information is removed from the mosaic dataset and the dodging side-table truncated.
boolean	isRemoveItem() Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.
boolean	isRemoveSeamlines() Indicates whether seamline information is removed from the mosaic dataset and the seamlines side-table truncated.
boolean	isRemoveUnreferencedInstances() Indicates whether to remove the raster type instances for those which don't have any associated catalog items.
boolean	isResetRelativePath() Indicates whether the mosaic dataset's relative path is reset to the mosaic dataset's current workspace.
boolean	isTouchAffectedOverviewItems() Indicates whether to update the time stamp of all overview items affected by the removal of selected primary items.
void	release() Release this COM object reference
void	setDeleteItemCache(boolean pbDeleteItemCache) Indicates whether the cache files associated with selected mosaic dataset items are deleted.
void	setDeleteOverviewImages(boolean pbDeleteOverviewImages) Indicates whether the raster dataset associated with selected overview items are deleted as well.
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	setQueryFilterByRef(IQueryFilter ppQueryFilter) The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	setRemoveBrokenItemsOnly(boolean pbRemoveBrokenItemsOnly) Indicates whether only catalog items with broken paths are removed.
void	setRemoveColorCorrection(boolean pbRemoveColorCorrection) Indicates whether color corrrection information is removed from the mosaic dataset and the dodging side-table truncated.
void	setRemoveItem(boolean pbRemoveItem) Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.
void	setRemoveSeamlines(boolean pbRemoveSeamlines) Indicates whether seamline information is removed from the mosaic dataset and the seamlines side-table truncated.
void	setRemoveUnreferencedInstances(boolean pbRemoveUnreferencedInstances) Indicates whether to remove the raster type instances for those which don't have any associated catalog items.
void	setResetRelativePath(boolean pbResetRelativePath) Indicates whether the mosaic dataset's relative path is reset to the mosaic dataset's current workspace.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) The selection set that identifies the collection of catalog items on which to perform the associated operation.
void	setTouchAffectedOverviewItems(boolean pbTouchAffectedOverviewItems) Indicates whether to update the time stamp of all overview items affected by the removal of selected primary items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveItemsParameters

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

Constructs a RemoveItemsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RemoveItemsParameters

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems RemoveItemsParameters theRemoveItemsParameters = (RemoveItemsParameters) obj;

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

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.

setDeleteOverviewImages

public void setDeleteOverviewImages(boolean pbDeleteOverviewImages)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the raster dataset associated with selected overview items are deleted as well. Overview images created within the geodatabase are owned and managed by the mosaic dataset. These managed overview images are always deleted along with the corres

Specified by:

setDeleteOverviewImages in interface IRemoveItemsParameters

Parameters:

pbDeleteOverviewImages - The pbDeleteOverviewImages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDeleteOverviewImages

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

Indicates whether the raster dataset associated with selected overview items are deleted as well. Overview images created within the geodatabase are owned and managed by the mosaic dataset. These managed overview images are always deleted along with the corres

Specified by:

isDeleteOverviewImages in interface IRemoveItemsParameters

Returns:

The pbDeleteOverviewImages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveUnreferencedInstances

public void setRemoveUnreferencedInstances(boolean pbRemoveUnreferencedInstances)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether to remove the raster type instances for those which don't have any associated catalog items.

Specified by:

setRemoveUnreferencedInstances in interface IRemoveItemsParameters

Parameters:

pbRemoveUnreferencedInstances - The pbRemoveUnreferencedInstances (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveUnreferencedInstances

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

Indicates whether to remove the raster type instances for those which don't have any associated catalog items.

Specified by:

isRemoveUnreferencedInstances in interface IRemoveItemsParameters

Returns:

The pbRemoveUnreferencedInstances

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTouchAffectedOverviewItems

public void setTouchAffectedOverviewItems(boolean pbTouchAffectedOverviewItems)
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether to update the time stamp of all overview items affected by the removal of selected primary items.

Specified by:

setTouchAffectedOverviewItems in interface IRemoveItemsParameters

Parameters:

pbTouchAffectedOverviewItems - The pbTouchAffectedOverviewItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTouchAffectedOverviewItems

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

Indicates whether to update the time stamp of all overview items affected by the removal of selected primary items.

Specified by:

isTouchAffectedOverviewItems in interface IRemoveItemsParameters

Returns:

The pbTouchAffectedOverviewItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveBrokenItemsOnly

public void setRemoveBrokenItemsOnly(boolean pbRemoveBrokenItemsOnly)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether only catalog items with broken paths are removed.

Specified by:

setRemoveBrokenItemsOnly in interface IRemoveItemsParameters

Parameters:

pbRemoveBrokenItemsOnly - The pbRemoveBrokenItemsOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveBrokenItemsOnly

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

Indicates whether only catalog items with broken paths are removed.

Specified by:

isRemoveBrokenItemsOnly in interface IRemoveItemsParameters

Returns:

The pbRemoveBrokenItemsOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDeleteItemCache

public void setDeleteItemCache(boolean pbDeleteItemCache)
                        throws java.io.IOException,
                               AutomationException

Indicates whether the cache files associated with selected mosaic dataset items are deleted.

Specified by:

setDeleteItemCache in interface IRemoveItemsParameters2

Parameters:

pbDeleteItemCache - The pbDeleteItemCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDeleteItemCache

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

Indicates whether the cache files associated with selected mosaic dataset items are deleted.

Specified by:

isDeleteItemCache in interface IRemoveItemsParameters2

Returns:

The pbDeleteItemCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveItem

public void setRemoveItem(boolean pbRemoveItem)
                   throws java.io.IOException,
                          AutomationException

Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.

Specified by:

setRemoveItem in interface IRemoveItemsParameters2

Parameters:

pbRemoveItem - The pbRemoveItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveItem

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

Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.

Specified by:

isRemoveItem in interface IRemoveItemsParameters2

Returns:

The pbRemoveItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveColorCorrection

public void setRemoveColorCorrection(boolean pbRemoveColorCorrection)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether color corrrection information is removed from the mosaic dataset and the dodging side-table truncated.

Specified by:

setRemoveColorCorrection in interface IRemoveItemsParameters3

Parameters:

pbRemoveColorCorrection - The pbRemoveColorCorrection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveColorCorrection

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

Indicates whether color corrrection information is removed from the mosaic dataset and the dodging side-table truncated.

Specified by:

isRemoveColorCorrection in interface IRemoveItemsParameters3

Returns:

The pbRemoveColorCorrection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveSeamlines

public void setRemoveSeamlines(boolean pbRemoveSeamlines)
                        throws java.io.IOException,
                               AutomationException

Indicates whether seamline information is removed from the mosaic dataset and the seamlines side-table truncated.

Specified by:

setRemoveSeamlines in interface IRemoveItemsParameters3

Parameters:

pbRemoveSeamlines - The pbRemoveSeamlines (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveSeamlines

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

Indicates whether seamline information is removed from the mosaic dataset and the seamlines side-table truncated.

Specified by:

isRemoveSeamlines in interface IRemoveItemsParameters3

Returns:

The pbRemoveSeamlines

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResetRelativePath

public void setResetRelativePath(boolean pbResetRelativePath)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the mosaic dataset's relative path is reset to the mosaic dataset's current workspace.

Specified by:

setResetRelativePath in interface IRemoveItemsParameters4

Parameters:

pbResetRelativePath - The pbResetRelativePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isResetRelativePath

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

Indicates whether the mosaic dataset's relative path is reset to the mosaic dataset's current workspace.

Specified by:

isResetRelativePath in interface IRemoveItemsParameters4

Returns:

The pbResetRelativePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws java.io.IOException,
                                 AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:

getSelectionSet in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws java.io.IOException,
                                AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws java.io.IOException,
                                   AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.