com.esri.arcgis.datasourcesraster

Interface ISynchronizeParameters

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ISynchronizeParameters2, ISynchronizeParameters3, ISynchronizeParameters4, ISynchronizeParameters5, ISynchronizeParameters6

All Known Implementing Classes:

AddRastersParameters, ISynchronizeParameters2Proxy, ISynchronizeParameters3Proxy, ISynchronizeParameters4Proxy, ISynchronizeParameters5Proxy, ISynchronizeParameters6Proxy, ISynchronizeParametersProxy, SynchronizeParameters

public interface ISynchronizeParameters
extends java.io.Serializable

COM Interface 'ISynchronizeParameters'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control parameters for synchronizing items in 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID241b22c3_75ef_468b_a4a3_758fd9da08df
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
ISpatialReference	getDefaultSpatialReference() The default spatial reference used by all raster types for those dataset which do not have an associated native spatial reference.
double	getDensificationFactor() The maximum segment length value as a factor of each incoming dataset fooprint's average dimension.
double	getMaximumHighCellSize() The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item.
int	getMaximumPyramidLevel() The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item.
int	getMinimumColumns() The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
int	getMinimumRows() The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
IRasterThumbnailBuilder	getThumbnailBuilder() The thumbnail builder object associated with this operation.
boolean	isBuildPyramids() Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.
boolean	isBuildThumbnail() Indicates whether items thumbnails are built and saved.
boolean	isComputeStatistics() Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.
boolean	isRemoveInvalidItems() Indicates whether items with category set to 'Incomplete' or items that cannot be rebuilt using their corresponding data sources are removed from the mosaic dataset.
boolean	isResetVisibility() Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.
boolean	isSyncOnlyStaleItems() Indicates if only those items found to be stale are synchronized.
void	setBuildPyramids(boolean pbBuildPyramids) Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.
void	setBuildThumbnail(boolean pbBuildThumbnail) Indicates whether items thumbnails are built and saved.
void	setComputeStatistics(boolean pbComputeStatistics) Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.
void	setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) The default spatial reference used by all raster types for those dataset which do not have an associated native spatial reference.
void	setDensificationFactor(double pDensificationFactor) The maximum segment length value as a factor of each incoming dataset fooprint's average dimension.
void	setMaximumHighCellSize(double pMaximumHighCellSize) The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item.
void	setMaximumPyramidLevel(int pMaximumPyramidLevel) The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item.
void	setMinimumColumns(int pMinimumColumns) The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
void	setMinimumRows(int pMinimumRows) The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
void	setRemoveInvalidItems(boolean pbRemoveInvalidItems) Indicates whether items with category set to 'Incomplete' or items that cannot be rebuilt using their corresponding data sources are removed from the mosaic dataset.
void	setResetVisibility(boolean pbResetVisibility) Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.
void	setSyncOnlyStaleItems(boolean pbSyncOnlyStaleItems) Indicates if only those items found to be stale are synchronized.
void	setThumbnailBuilderByRef(IRasterThumbnailBuilder ppThumbnailBuilder) The thumbnail builder object associated with this operation.

Field Detail

IID241b22c3_75ef_468b_a4a3_758fd9da08df

static final int IID241b22c3_75ef_468b_a4a3_758fd9da08df

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setDefaultSpatialReferenceByRef

void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
                              throws java.io.IOException,
                                     AutomationException

The default spatial reference used by all raster types for those dataset which do not have an associated native spatial reference.

Parameters:

ppDefaultSrs - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

ISpatialReference getDefaultSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The default spatial reference used by all raster types for those dataset which do not have an associated native spatial reference.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSyncOnlyStaleItems

void setSyncOnlyStaleItems(boolean pbSyncOnlyStaleItems)
                    throws java.io.IOException,
                           AutomationException

Indicates if only those items found to be stale are synchronized.

Parameters:

pbSyncOnlyStaleItems - The pbSyncOnlyStaleItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSyncOnlyStaleItems

boolean isSyncOnlyStaleItems()
                      throws java.io.IOException,
                             AutomationException

Indicates if only those items found to be stale are synchronized.

Returns:

The pbSyncOnlyStaleItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveInvalidItems

void setRemoveInvalidItems(boolean pbRemoveInvalidItems)
                    throws java.io.IOException,
                           AutomationException

Indicates whether items with category set to 'Incomplete' or items that cannot be rebuilt using their corresponding data sources are removed from the mosaic dataset.

Parameters:

pbRemoveInvalidItems - The pbRemoveInvalidItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveInvalidItems

boolean isRemoveInvalidItems()
                      throws java.io.IOException,
                             AutomationException

Indicates whether items with category set to 'Incomplete' or items that cannot be rebuilt using their corresponding data sources are removed from the mosaic dataset.

Returns:

The pbRemoveInvalidItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumPyramidLevel

void setMaximumPyramidLevel(int pMaximumPyramidLevel)
                     throws java.io.IOException,
                            AutomationException

The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item. A value of -1 indicates all available levels.

Parameters:

pMaximumPyramidLevel - The pMaximumPyramidLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

int getMaximumPyramidLevel()
                    throws java.io.IOException,
                           AutomationException

The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item. A value of -1 indicates all available levels.

Returns:

The pMaximumPyramidLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumRows

void setMinimumRows(int pMinimumRows)
             throws java.io.IOException,
                    AutomationException

The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item. Higher values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints on

Parameters:

pMinimumRows - The pMinimumRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumRows

int getMinimumRows()
            throws java.io.IOException,
                   AutomationException

The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item. Higher values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints on

Returns:

The pMinimumRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumColumns

void setMinimumColumns(int pMinimumColumns)
                throws java.io.IOException,
                       AutomationException

The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item. Higher values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints

Parameters:

pMinimumColumns - The pMinimumColumns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumColumns

int getMinimumColumns()
               throws java.io.IOException,
                      AutomationException

The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item. Higher values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints

Returns:

The pMinimumColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumHighCellSize

void setMaximumHighCellSize(double pMaximumHighCellSize)
                     throws java.io.IOException,
                            AutomationException

The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item. Lower values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints on the resultin

Parameters:

pMaximumHighCellSize - The pMaximumHighCellSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumHighCellSize

double getMaximumHighCellSize()
                       throws java.io.IOException,
                              AutomationException

The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item. Lower values in this property indicate fewer pyramid levels. A value of zero indicates an absence of any constraints on the resultin

Returns:

The pMaximumHighCellSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

void setComputeStatistics(boolean pbComputeStatistics)
                   throws java.io.IOException,
                          AutomationException

Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.

Parameters:

pbComputeStatistics - The pbComputeStatistics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

boolean isComputeStatistics()
                     throws java.io.IOException,
                            AutomationException

Indicates whether histogram statistics are computed for each raster dataset associated with each selected catalog item.

Returns:

The pbComputeStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

void setBuildPyramids(boolean pbBuildPyramids)
               throws java.io.IOException,
                      AutomationException

Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.

Parameters:

pbBuildPyramids - The pbBuildPyramids (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

boolean isBuildPyramids()
                 throws java.io.IOException,
                        AutomationException

Indicates whether pyramids are built for each raster dataset associated with each selected catalog item.

Returns:

The pbBuildPyramids

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

void setBuildThumbnail(boolean pbBuildThumbnail)
                throws java.io.IOException,
                       AutomationException

Indicates whether items thumbnails are built and saved.

Parameters:

pbBuildThumbnail - The pbBuildThumbnail (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

boolean isBuildThumbnail()
                  throws java.io.IOException,
                         AutomationException

Indicates whether items thumbnails are built and saved.

Returns:

The pbBuildThumbnail

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setThumbnailBuilderByRef

void setThumbnailBuilderByRef(IRasterThumbnailBuilder ppThumbnailBuilder)
                       throws java.io.IOException,
                              AutomationException

The thumbnail builder object associated with this operation. If not specified, a default builder is used for generating item thumbnails.

Parameters:

ppThumbnailBuilder - A reference to a com.esri.arcgis.datasourcesraster.IRasterThumbnailBuilder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnailBuilder

IRasterThumbnailBuilder getThumbnailBuilder()
                                     throws java.io.IOException,
                                            AutomationException

The thumbnail builder object associated with this operation. If not specified, a default builder is used for generating item thumbnails.

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterThumbnailBuilder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDensificationFactor

void setDensificationFactor(double pDensificationFactor)
                     throws java.io.IOException,
                            AutomationException

The maximum segment length value as a factor of each incoming dataset fooprint's average dimension. Footprint polygon is densified only if the spatial reference of the footprint geometry differs form the spatial reference of the geometry column of the mosaic c

Parameters:

pDensificationFactor - The pDensificationFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDensificationFactor

double getDensificationFactor()
                       throws java.io.IOException,
                              AutomationException

The maximum segment length value as a factor of each incoming dataset fooprint's average dimension. Footprint polygon is densified only if the spatial reference of the footprint geometry differs form the spatial reference of the geometry column of the mosaic c

Returns:

The pDensificationFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResetVisibility

void setResetVisibility(boolean pbResetVisibility)
                 throws java.io.IOException,
                        AutomationException

Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.

Parameters:

pbResetVisibility - The pbResetVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isResetVisibility

boolean isResetVisibility()
                   throws java.io.IOException,
                          AutomationException

Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.

Returns:

The pbResetVisibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.