com.esri.arcgis.datasourcesraster

Class CalculateCellSizeRangesParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.CalculateCellSizeRangesParameters

All Implemented Interfaces:

ICalculateCellSizeRangesParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class CalculateCellSizeRangesParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, ICalculateCellSizeRangesParameters, ISelectionParameters

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

Description 'An object that controls how visibility ranges for 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.ICalculateCellSizeRangesParameters

IID, IID6b9ceb1d_7c5f_4de3_a1a8_843851fa1904, xxDummy

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
double	getCellSizeClusterTolerance() The factor controlling clustering of cell size values.
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.
double	getMaxOverviewFactor() The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.
double	getMaxRangeFactor() The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items.
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	isCalculateLevels() Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.
boolean	isCalculateMosaicCellSizes() Indicates whether mosaic dataset's maximum visible cell size is calculated.
boolean	isCalculateRasterMaxCellSizes() Indicates whether maximum visibility values are calculated for selected items.
boolean	isCalculateRasterMinCellSizes() Indicates whether minimum visibility values are calculated for selected items.
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isUpdateMissingValuesOnly() Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.
void	release() Release this COM object reference
void	setCalculateLevels(boolean pbCalculateLevels) Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.
void	setCalculateMosaicCellSizes(boolean pbDoMosaicCellSizeRanges) Indicates whether mosaic dataset's maximum visible cell size is calculated.
void	setCalculateRasterMaxCellSizes(boolean pbDoCalculateMax) Indicates whether maximum visibility values are calculated for selected items.
void	setCalculateRasterMinCellSizes(boolean pbDoCalculateMin) Indicates whether minimum visibility values are calculated for selected items.
void	setCellSizeClusterTolerance(double pCellSizeClusterTolerance) The factor controlling clustering of cell size values.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMaxOverviewFactor(double pMaxOverviewFactor) The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.
void	setMaxRangeFactor(double pMaxRangeFactor) The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items.
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	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	setUpdateMissingValuesOnly(boolean pbUpdateMissingValuesOnly) Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalculateCellSizeRangesParameters

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

Constructs a CalculateCellSizeRangesParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CalculateCellSizeRangesParameters

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

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

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

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

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.

setCalculateRasterMinCellSizes

public void setCalculateRasterMinCellSizes(boolean pbDoCalculateMin)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether minimum visibility values are calculated for selected items.

Specified by:

setCalculateRasterMinCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoCalculateMin - The pbDoCalculateMin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCalculateRasterMinCellSizes

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

Indicates whether minimum visibility values are calculated for selected items.

Specified by:

isCalculateRasterMinCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoCalculateMin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCalculateRasterMaxCellSizes

public void setCalculateRasterMaxCellSizes(boolean pbDoCalculateMax)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether maximum visibility values are calculated for selected items.

Specified by:

setCalculateRasterMaxCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoCalculateMax - The pbDoCalculateMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCalculateRasterMaxCellSizes

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

Indicates whether maximum visibility values are calculated for selected items.

Specified by:

isCalculateRasterMaxCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoCalculateMax

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCalculateMosaicCellSizes

public void setCalculateMosaicCellSizes(boolean pbDoMosaicCellSizeRanges)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether mosaic dataset's maximum visible cell size is calculated.

Specified by:

setCalculateMosaicCellSizes in interface ICalculateCellSizeRangesParameters

Parameters:

pbDoMosaicCellSizeRanges - The pbDoMosaicCellSizeRanges (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCalculateMosaicCellSizes

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

Indicates whether mosaic dataset's maximum visible cell size is calculated.

Specified by:

isCalculateMosaicCellSizes in interface ICalculateCellSizeRangesParameters

Returns:

The pbDoMosaicCellSizeRanges

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCalculateLevels

public void setCalculateLevels(boolean pbCalculateLevels)
                        throws java.io.IOException,
                               AutomationException

Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.

Specified by:

setCalculateLevels in interface ICalculateCellSizeRangesParameters

Parameters:

pbCalculateLevels - The pbCalculateLevels (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCalculateLevels

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

Indicates whether all unique cell size levels for the mosaic dataset are computed and stored.

Specified by:

isCalculateLevels in interface ICalculateCellSizeRangesParameters

Returns:

The pbCalculateLevels

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxRangeFactor

public void setMaxRangeFactor(double pMaxRangeFactor)
                       throws java.io.IOException,
                              AutomationException

The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items. The maximum pixel size values of such items are computed by multiplying the corresponding low

Specified by:

setMaxRangeFactor in interface ICalculateCellSizeRangesParameters

Parameters:

pMaxRangeFactor - The pMaxRangeFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxRangeFactor

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

The multiplicative factor used for computing maximum visibility of those items that don't their footprints completely covered by footprints of lower resolution items. The maximum pixel size values of such items are computed by multiplying the corresponding low

Specified by:

getMaxRangeFactor in interface ICalculateCellSizeRangesParameters

Returns:

The pMaxRangeFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxOverviewFactor

public void setMaxOverviewFactor(double pMaxOverviewFactor)
                          throws java.io.IOException,
                                 AutomationException

The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.

Specified by:

setMaxOverviewFactor in interface ICalculateCellSizeRangesParameters

Parameters:

pMaxOverviewFactor - The pMaxOverviewFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxOverviewFactor

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

The multiplicative factor used for computing the maximum visibility of the top-most (lowest resolution) overview items.

Specified by:

getMaxOverviewFactor in interface ICalculateCellSizeRangesParameters

Returns:

The pMaxOverviewFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCellSizeClusterTolerance

public void setCellSizeClusterTolerance(double pCellSizeClusterTolerance)
                                 throws java.io.IOException,
                                        AutomationException

The factor controlling clustering of cell size values. Two cell size values with a difference factor less than the value in this property are considered one.

Specified by:

setCellSizeClusterTolerance in interface ICalculateCellSizeRangesParameters

Parameters:

pCellSizeClusterTolerance - The pCellSizeClusterTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCellSizeClusterTolerance

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

The factor controlling clustering of cell size values. Two cell size values with a difference factor less than the value in this property are considered one.

Specified by:

getCellSizeClusterTolerance in interface ICalculateCellSizeRangesParameters

Returns:

The pCellSizeClusterTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateMissingValuesOnly

public void setUpdateMissingValuesOnly(boolean pbUpdateMissingValuesOnly)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

Specified by:

setUpdateMissingValuesOnly in interface ICalculateCellSizeRangesParameters

Parameters:

pbUpdateMissingValuesOnly - The pbUpdateMissingValuesOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateMissingValuesOnly

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

Indicates whether only those rows where MinPS or MaxPS is either null or -1 are updated.

Specified by:

isUpdateMissingValuesOnly in interface ICalculateCellSizeRangesParameters

Returns:

The pbUpdateMissingValuesOnly

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.