com.esri.arcgis.datasourcesraster

Class BuildFootprintsParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.BuildFootprintsParameters

All Implemented Interfaces:

IBuildFootprintsByGeometryParameters, IBuildFootprintsByRadiometryParameters, IBuildFootprintsByRadiometryParameters2, IBuildFootprintsByShrinkingParameters, IBuildFootprintsParameters, IBuildFootprintsParameters2, IMosaicDatasetOperationParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class BuildFootprintsParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IBuildFootprintsParameters, IBuildFootprintsParameters2, IBuildFootprintsByRadiometryParameters, IBuildFootprintsByRadiometryParameters2, IBuildFootprintsByGeometryParameters, IBuildFootprintsByShrinkingParameters, ISelectionParameters, IThreadedOperationParameters

COM Class 'BuildFootprintsParameters'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An object that controls how footrints of items in a mosaic dataset are computed.' 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.IMosaicDatasetOperationParameters

IID, IID379006f4_6f75_4c3b_b783_0c2e88a7b280, xxDummy

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

IID, IID74648190_ba1d_499b_97e1_7bad62ae4357, xxDummy

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

IID9f80035d_a4e5_4d7e_af00_9bf94ed5c4b2

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

IID, IID5ba3d476_d8ae_4e69_810c_57a8ecf2bfd0, xxDummy

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

IIDa32544a5_baba_47d6_b3a8_ed87afe334f6

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

IID, IID79d6fe35_a7f6_4975_84ec_ea08d359864d, xxDummy

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

IID, IID61988965_736b_42c2_86c8_0d989995e82f, xxDummy

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

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

IID, IIDb4a72532_b2fd_41ee_9216_2fa2921af897, xxDummy

Constructor Summary

Constructors

Constructor and Description
BuildFootprintsParameters() Constructs a BuildFootprintsParameters using ArcGIS Engine.
BuildFootprintsParameters(java.lang.Object obj) Construct a BuildFootprintsParameters 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.
int	getFootprintSimplificationMethod() The method that determines how footprint geometry is simplified.
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.
int	getMaximumSliverSize() The maximum allowed size (in pixels) below which a polygon may be considered as a sliver.
double	getMaximumValidDataValue() The maximum valid pixel value.
int	getMaximumVertices() The maximum number of vertices in the computed footprint geometry.
int	getMethod() The method that determines how item footprints are computed.
double	getMinimumCircularity() The circularity value below which a polygon is considered a sliver.
int	getMinimumRegionSize() The minimum number of pixels used for computing valid region.
double	getMinimumValidDataValue() The minimum valid pixel value.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
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.
void	getRecommendedNumThreads(int[] pRecommendedNumThreads) The number of parallel threads of execution recommended by the system.
int	getRequestSize() The recommended number of pixels (in any one dimension) of the resampled raster requested off the dataset associated with each selected item.
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.
java.lang.String	getServerName() The URL to the server object name where parts of the operation may be remotely executed.
double	getShrinkDistance() The shrink distance in the coordinate system of the geometry column of the mosaic catalog.
double	getSnapEdgesTolerance() The minimum distance below which points in the footprint geometry are snapped to the envelope of the raster.
int	getSnapEdgesToleranceInPixels() The minimum distance (in resampled pixels) below which points in the footprint geometry are snapped to the envelope of the raster.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
void	release() Release this COM object reference
void	setFootprintSimplificationMethod(int pSimplificationMethod) The method that determines how footprint geometry is simplified.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMaximumSliverSize(int pMaxSliverSize) The maximum allowed size (in pixels) below which a polygon may be considered as a sliver.
void	setMaximumValidDataValue(double pMaximumDataValue) The maximum valid pixel value.
void	setMaximumVertices(int pMaximumVertices) The maximum number of vertices in the computed footprint geometry.
void	setMethod(int method) The method that determines how item footprints are computed.
void	setMinimumCircularity(double pMinimumDataValue) The circularity value below which a polygon is considered a sliver.
void	setMinimumRegionSize(int pMinimumRegionSize) The minimum number of pixels used for computing valid region.
void	setMinimumValidDataValue(double pMinimumDataValue) The minimum valid pixel value.
void	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
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	setRequestSize(int pRequestSize) The recommended number of pixels (in any one dimension) of the resampled raster requested off the dataset associated with each selected item.
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	setServerName(java.lang.String pServerUrl) The URL to the server object name where parts of the operation may be remotely executed.
void	setShrinkDistance(double pShrinkDistance) The shrink distance in the coordinate system of the geometry column of the mosaic catalog.
void	setSnapEdgesTolerance(double pTolerance) The minimum distance below which points in the footprint geometry are snapped to the envelope of the raster.
void	setSnapEdgesToleranceInPixels(int pToleranceInPixels) The minimum distance (in resampled pixels) below which points in the footprint geometry are snapped to the envelope of the raster.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildFootprintsParameters

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

Constructs a BuildFootprintsParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BuildFootprintsParameters

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems BuildFootprintsParameters theBuildFootprintsParameters = (BuildFootprintsParameters) 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.

setMethod

public void setMethod(int method)
               throws java.io.IOException,
                      AutomationException

The method that determines how item footprints are computed.

Specified by:

setMethod in interface IBuildFootprintsParameters

Parameters:

method - A com.esri.arcgis.datasourcesraster.esriBuildFootprintsMethods constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMethod

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

The method that determines how item footprints are computed.

Specified by:

getMethod in interface IBuildFootprintsParameters

Returns:

A com.esri.arcgis.datasourcesraster.esriBuildFootprintsMethods constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFootprintSimplificationMethod

public void setFootprintSimplificationMethod(int pSimplificationMethod)
                                      throws java.io.IOException,
                                             AutomationException

The method that determines how footprint geometry is simplified.

Specified by:

setFootprintSimplificationMethod in interface IBuildFootprintsParameters2

Parameters:

pSimplificationMethod - A com.esri.arcgis.datasourcesraster.esriGeometrySimplificationMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFootprintSimplificationMethod

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

The method that determines how footprint geometry is simplified.

Specified by:

getFootprintSimplificationMethod in interface IBuildFootprintsParameters2

Returns:

A com.esri.arcgis.datasourcesraster.esriGeometrySimplificationMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumValidDataValue

public void setMinimumValidDataValue(double pMinimumDataValue)
                              throws java.io.IOException,
                                     AutomationException

The minimum valid pixel value.

Specified by:

setMinimumValidDataValue in interface IBuildFootprintsByRadiometryParameters

Parameters:

pMinimumDataValue - The pMinimumDataValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumValidDataValue

public double getMinimumValidDataValue()
                                throws java.io.IOException,
                                       AutomationException

The minimum valid pixel value.

Specified by:

getMinimumValidDataValue in interface IBuildFootprintsByRadiometryParameters

Returns:

The pMinimumDataValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumValidDataValue

public void setMaximumValidDataValue(double pMaximumDataValue)
                              throws java.io.IOException,
                                     AutomationException

The maximum valid pixel value.

Specified by:

setMaximumValidDataValue in interface IBuildFootprintsByRadiometryParameters

Parameters:

pMaximumDataValue - The pMaximumDataValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumValidDataValue

public double getMaximumValidDataValue()
                                throws java.io.IOException,
                                       AutomationException

The maximum valid pixel value.

Specified by:

getMaximumValidDataValue in interface IBuildFootprintsByRadiometryParameters

Returns:

The pMaximumDataValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequestSize

public void setRequestSize(int pRequestSize)
                    throws java.io.IOException,
                           AutomationException

The recommended number of pixels (in any one dimension) of the resampled raster requested off the dataset associated with each selected item. A lower value in this parameter translates to a lower resolution raster and results in a coarser footprint geometry.

Specified by:

setRequestSize in interface IBuildFootprintsByRadiometryParameters

Parameters:

pRequestSize - The pRequestSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequestSize

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

The recommended number of pixels (in any one dimension) of the resampled raster requested off the dataset associated with each selected item. A lower value in this parameter translates to a lower resolution raster and results in a coarser footprint geometry.

Specified by:

getRequestSize in interface IBuildFootprintsByRadiometryParameters

Returns:

The pRequestSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumVertices

public void setMaximumVertices(int pMaximumVertices)
                        throws java.io.IOException,
                               AutomationException

The maximum number of vertices in the computed footprint geometry.

Specified by:

setMaximumVertices in interface IBuildFootprintsByGeometryParameters

Specified by:

setMaximumVertices in interface IBuildFootprintsByRadiometryParameters

Parameters:

pMaximumVertices - The pMaximumVertices (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumVertices

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

The maximum number of vertices in the computed footprint geometry.

Specified by:

getMaximumVertices in interface IBuildFootprintsByGeometryParameters

Specified by:

getMaximumVertices in interface IBuildFootprintsByRadiometryParameters

Returns:

The pMaximumVertices

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumRegionSize

public void setMinimumRegionSize(int pMinimumRegionSize)
                          throws java.io.IOException,
                                 AutomationException

The minimum number of pixels used for computing valid region.

Specified by:

setMinimumRegionSize in interface IBuildFootprintsByRadiometryParameters

Parameters:

pMinimumRegionSize - The pMinimumRegionSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumRegionSize

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

The minimum number of pixels used for computing valid region.

Specified by:

getMinimumRegionSize in interface IBuildFootprintsByRadiometryParameters

Returns:

The pMinimumRegionSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumCircularity

public void setMinimumCircularity(double pMinimumDataValue)
                           throws java.io.IOException,
                                  AutomationException

The circularity value below which a polygon is considered a sliver.

Specified by:

setMinimumCircularity in interface IBuildFootprintsByRadiometryParameters2

Parameters:

pMinimumDataValue - The pMinimumDataValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumCircularity

public double getMinimumCircularity()
                             throws java.io.IOException,
                                    AutomationException

The circularity value below which a polygon is considered a sliver.

Specified by:

getMinimumCircularity in interface IBuildFootprintsByRadiometryParameters2

Returns:

The pMinimumDataValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumSliverSize

public void setMaximumSliverSize(int pMaxSliverSize)
                          throws java.io.IOException,
                                 AutomationException

The maximum allowed size (in pixels) below which a polygon may be considered as a sliver.

Specified by:

setMaximumSliverSize in interface IBuildFootprintsByRadiometryParameters2

Parameters:

pMaxSliverSize - The pMaxSliverSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumSliverSize

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

The maximum allowed size (in pixels) below which a polygon may be considered as a sliver.

Specified by:

getMaximumSliverSize in interface IBuildFootprintsByRadiometryParameters2

Returns:

The pMaxSliverSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShrinkDistance

public void setShrinkDistance(double pShrinkDistance)
                       throws java.io.IOException,
                              AutomationException

The shrink distance in the coordinate system of the geometry column of the mosaic catalog.

Specified by:

setShrinkDistance in interface IBuildFootprintsByShrinkingParameters

Parameters:

pShrinkDistance - The pShrinkDistance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShrinkDistance

public double getShrinkDistance()
                         throws java.io.IOException,
                                AutomationException

The shrink distance in the coordinate system of the geometry column of the mosaic catalog.

Specified by:

getShrinkDistance in interface IBuildFootprintsByShrinkingParameters

Returns:

The pShrinkDistance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapEdgesTolerance

public void setSnapEdgesTolerance(double pTolerance)
                           throws java.io.IOException,
                                  AutomationException

The minimum distance below which points in the footprint geometry are snapped to the envelope of the raster.

Specified by:

setSnapEdgesTolerance in interface IBuildFootprintsByShrinkingParameters

Parameters:

pTolerance - The pTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapEdgesTolerance

public double getSnapEdgesTolerance()
                             throws java.io.IOException,
                                    AutomationException

The minimum distance below which points in the footprint geometry are snapped to the envelope of the raster.

Specified by:

getSnapEdgesTolerance in interface IBuildFootprintsByShrinkingParameters

Returns:

The pTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapEdgesToleranceInPixels

public void setSnapEdgesToleranceInPixels(int pToleranceInPixels)
                                   throws java.io.IOException,
                                          AutomationException

The minimum distance (in resampled pixels) below which points in the footprint geometry are snapped to the envelope of the raster.

Specified by:

setSnapEdgesToleranceInPixels in interface IBuildFootprintsByShrinkingParameters

Parameters:

pToleranceInPixels - The pToleranceInPixels (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapEdgesToleranceInPixels

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

The minimum distance (in resampled pixels) below which points in the footprint geometry are snapped to the envelope of the raster.

Specified by:

getSnapEdgesToleranceInPixels in interface IBuildFootprintsByShrinkingParameters

Returns:

The pToleranceInPixels

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.

setServerName

public void setServerName(java.lang.String pServerUrl)
                   throws java.io.IOException,
                          AutomationException

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerUrl - The pServerUrl (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerName

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

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerUrl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws java.io.IOException,
                          AutomationException

The number of parallel threads that execute parts of the associated operation.

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumThreads

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

The number of parallel threads that execute parts of the associated operation.

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws java.io.IOException,
                                     AutomationException

The number of parallel threads of execution recommended by the system.

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.