com.esri.arcgis.datasourcesraster
Class RemoveItemsParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.RemoveItemsParameters

All Implemented Interfaces:

IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, IRemoveItemsParameters, IRemoveItemsParameters2, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

An object that controls how items are removed from a mosaic dataset.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RemoveItemsParameters()
Constructs a RemoveItemsParameters using ArcGIS Engine.

RemoveItemsParameters(Object obj)
Construct a RemoveItemsParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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	isRemoveItem() Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.
boolean	isRemoveUnreferencedInstances() Indicates whether to remove the raster type instances for those which don't have any associated catalog items.
boolean	isTouchAffectedOverviewItems() Indicates whether to update the time stamp of all overview items affected by the removal of selected primary items.
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	setRemoveItem(boolean pbRemoveItem) Indicates whether selected mosaic dataset items are deleted from the mosaic dataset.
void	setRemoveUnreferencedInstances(boolean pbRemoveUnreferencedInstances) Indicates whether to remove the raster type instances for those which don't have any associated catalog items.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RemoveItemsParameters

public RemoveItemsParameters()
                      throws IOException,
                             UnknownHostException

Constructs a RemoveItemsParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RemoveItemsParameters

public RemoveItemsParameters(Object obj)
                      throws 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:

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

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

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws 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.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws 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.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrepareResults

public void setPrepareResults(boolean pbPrepareResults)
                       throws IOException,
                              AutomationException

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

Product Availability

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

Specified by:

setPrepareResults in interface IMosaicDatasetOperationParameters2

Parameters:

pbPrepareResults - The pbPrepareResults (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrepareResults

public boolean isPrepareResults()
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:

isPrepareResults in interface IMosaicDatasetOperationParameters2

Returns:

The pbPrepareResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeleteOverviewImages

public void setDeleteOverviewImages(boolean pbDeleteOverviewImages)
                             throws 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????&

Product Availability

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

Specified by:

setDeleteOverviewImages in interface IRemoveItemsParameters

Parameters:

pbDeleteOverviewImages - The pbDeleteOverviewImages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeleteOverviewImages

public boolean isDeleteOverviewImages()
                               throws 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????&

Product Availability

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

Specified by:

isDeleteOverviewImages in interface IRemoveItemsParameters

Returns:

The pbDeleteOverviewImages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveUnreferencedInstances

public void setRemoveUnreferencedInstances(boolean pbRemoveUnreferencedInstances)
                                    throws IOException,
                                           AutomationException

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

Product Availability

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

Specified by:

setRemoveUnreferencedInstances in interface IRemoveItemsParameters

Parameters:

pbRemoveUnreferencedInstances - The pbRemoveUnreferencedInstances (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveUnreferencedInstances

public boolean isRemoveUnreferencedInstances()
                                      throws IOException,
                                             AutomationException

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

Product Availability

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

Specified by:

isRemoveUnreferencedInstances in interface IRemoveItemsParameters

Returns:

The pbRemoveUnreferencedInstances

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTouchAffectedOverviewItems

public void setTouchAffectedOverviewItems(boolean pbTouchAffectedOverviewItems)
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Specified by:

setTouchAffectedOverviewItems in interface IRemoveItemsParameters

Parameters:

pbTouchAffectedOverviewItems - The pbTouchAffectedOverviewItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTouchAffectedOverviewItems

public boolean isTouchAffectedOverviewItems()
                                     throws IOException,
                                            AutomationException

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

Product Availability

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

Specified by:

isTouchAffectedOverviewItems in interface IRemoveItemsParameters

Returns:

The pbTouchAffectedOverviewItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveBrokenItemsOnly

public void setRemoveBrokenItemsOnly(boolean pbRemoveBrokenItemsOnly)
                              throws IOException,
                                     AutomationException

Indicates whether only catalog items with broken paths are removed.

Product Availability

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

Specified by:

setRemoveBrokenItemsOnly in interface IRemoveItemsParameters

Parameters:

pbRemoveBrokenItemsOnly - The pbRemoveBrokenItemsOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveBrokenItemsOnly

public boolean isRemoveBrokenItemsOnly()
                                throws IOException,
                                       AutomationException

Indicates whether only catalog items with broken paths are removed.

Product Availability

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

Specified by:

isRemoveBrokenItemsOnly in interface IRemoveItemsParameters

Returns:

The pbRemoveBrokenItemsOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeleteItemCache

public void setDeleteItemCache(boolean pbDeleteItemCache)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

setDeleteItemCache in interface IRemoveItemsParameters2

Parameters:

pbDeleteItemCache - The pbDeleteItemCache (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeleteItemCache

public boolean isDeleteItemCache()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

isDeleteItemCache in interface IRemoveItemsParameters2

Returns:

The pbDeleteItemCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveItem

public void setRemoveItem(boolean pbRemoveItem)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

setRemoveItem in interface IRemoveItemsParameters2

Parameters:

pbRemoveItem - The pbRemoveItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveItem

public boolean isRemoveItem()
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:

isRemoveItem in interface IRemoveItemsParameters2

Returns:

The pbRemoveItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

getSelectionSet in interface ISelectionParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws 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.

Product Availability

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

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws 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.

Product Availability

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

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.