com.esri.arcgis.datasourcesraster
Interface ISynchronizeParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

AddRastersParameters, ISynchronizeParametersProxy, SynchronizeParameters

public interface ISynchronizeParameters
extends Serializable

Provides access to members that control parameters for synchronizing items in a mosaic dataset.

Product Availability

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

Method Summary

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 invalid items 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 invalid items 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.

Method Detail

setDefaultSpatialReferenceByRef

void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
                                     throws IOException,
                                            AutomationException

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

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

ISpatialReference getDefaultSpatialReference()
                                             throws IOException,
                                                    AutomationException

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

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSyncOnlyStaleItems

void setSyncOnlyStaleItems(boolean pbSyncOnlyStaleItems)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Parameters:

pbSyncOnlyStaleItems - The pbSyncOnlyStaleItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSyncOnlyStaleItems

boolean isSyncOnlyStaleItems()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Returns:

The pbSyncOnlyStaleItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveInvalidItems

void setRemoveInvalidItems(boolean pbRemoveInvalidItems)
                           throws IOException,
                                  AutomationException

Indicates whether invalid items are removed from the mosaic dataset.

Product Availability

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

Parameters:

pbRemoveInvalidItems - The pbRemoveInvalidItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveInvalidItems

boolean isRemoveInvalidItems()
                             throws IOException,
                                    AutomationException

Indicates whether invalid items are removed from the mosaic dataset.

Product Availability

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

Returns:

The pbRemoveInvalidItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumPyramidLevel

void setMaximumPyramidLevel(int pMaximumPyramidLevel)
                            throws 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.

Product Availability

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

Parameters:

pMaximumPyramidLevel - The pMaximumPyramidLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

int getMaximumPyramidLevel()
                           throws 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.

Product Availability

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

Returns:

The pMaximumPyramidLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumRows

void setMinimumRows(int pMinimumRows)
                    throws 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 ????&

Product Availability

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

Parameters:

pMinimumRows - The pMinimumRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumRows

int getMinimumRows()
                   throws 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 ????&

Product Availability

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

Returns:

The pMinimumRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumColumns

void setMinimumColumns(int pMinimumColumns)
                       throws 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????&

Product Availability

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

Parameters:

pMinimumColumns - The pMinimumColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumColumns

int getMinimumColumns()
                      throws 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????&

Product Availability

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

Returns:

The pMinimumColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumHighCellSize

void setMaximumHighCellSize(double pMaximumHighCellSize)
                            throws 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????&

Product Availability

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

Parameters:

pMaximumHighCellSize - The pMaximumHighCellSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumHighCellSize

double getMaximumHighCellSize()
                              throws 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????&

Product Availability

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

Returns:

The pMaximumHighCellSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

void setComputeStatistics(boolean pbComputeStatistics)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Parameters:

pbComputeStatistics - The pbComputeStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

boolean isComputeStatistics()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Returns:

The pbComputeStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

void setBuildPyramids(boolean pbBuildPyramids)
                      throws IOException,
                             AutomationException

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

Product Availability

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

Parameters:

pbBuildPyramids - The pbBuildPyramids (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

boolean isBuildPyramids()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

The pbBuildPyramids

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

void setBuildThumbnail(boolean pbBuildThumbnail)
                       throws IOException,
                              AutomationException

Indicates whether items thumbnails are built and saved.

Product Availability

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

Parameters:

pbBuildThumbnail - The pbBuildThumbnail (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

boolean isBuildThumbnail()
                         throws IOException,
                                AutomationException

Indicates whether items thumbnails are built and saved.

Product Availability

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

Returns:

The pbBuildThumbnail

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailBuilderByRef

void setThumbnailBuilderByRef(IRasterThumbnailBuilder ppThumbnailBuilder)
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnailBuilder

IRasterThumbnailBuilder getThumbnailBuilder()
                                            throws IOException,
                                                   AutomationException

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

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDensificationFactor

void setDensificationFactor(double pDensificationFactor)
                            throws 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????&

Product Availability

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

Parameters:

pDensificationFactor - The pDensificationFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDensificationFactor

double getDensificationFactor()
                              throws 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????&

Product Availability

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

Returns:

The pDensificationFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResetVisibility

void setResetVisibility(boolean pbResetVisibility)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Parameters:

pbResetVisibility - The pbResetVisibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResetVisibility

boolean isResetVisibility()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Returns:

The pbResetVisibility

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.