com.esri.arcgis.datasourcesraster
Interface ISynchronizeParameters2

All Superinterfaces:
ISynchronizeParameters, Serializable
All Known Implementing Classes:
AddRastersParameters, SynchronizeParameters

public interface ISynchronizeParameters2
extends ISynchronizeParameters, 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
 IPropertySet getAuxiliaryFieldValues()
          A field value property set that maps field names to possible metadata values.
 ICachedRasterFunctionArguments getCacheParameters()
          The parameters used for defining cache of the selected mosaic dataset items.
 IStringArray getExcludedFields()
          The collection of field names that are excluded from being updated during synchronization.
 IGeodataXform getGeodataXform()
          The georefencing of the raster item.
 int getGeodataXformApplyMethod()
          The method used for applying the GeodataXform.
 double getMaximumCellSizeFactor()
          The maximum visible pixel size factor.
 double getMinimumCellSizeFactor()
          The minimum visible pixel size factor.
 boolean isDefineCache()
          Indicates whether an attempt is made to define cache of the selected mosaic dataset items.
 boolean isForceDefaultSpatialReference()
          Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.
 boolean isRebuildDataSource()
          Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.
 boolean isRefreshCache()
          Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.
 boolean isUpdateExistingItems()
          Indicates whether mosaic dataset items are updated as part of the synchronization operation.
 void setAuxiliaryFieldValuesByRef(IPropertySet ppFieldValues)
          A field value property set that maps field names to possible metadata values.
 void setCacheParametersByRef(ICachedRasterFunctionArguments ppParameters)
          The parameters used for defining cache of the selected mosaic dataset items.
 void setDefineCache(boolean pbDefineCache)
          Indicates whether an attempt is made to define cache of the selected mosaic dataset items.
 void setExcludedFieldsByRef(IStringArray ppExcludedFields)
          The collection of field names that are excluded from being updated during synchronization.
 void setForceDefaultSpatialReference(boolean pbForceDefaultSpatialReference)
          Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.
 void setGeodataXformApplyMethod(int pMethod)
          The method used for applying the GeodataXform.
 void setGeodataXformByRef(IGeodataXform ppXf)
          The georefencing of the raster item.
 void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
          The maximum visible pixel size factor.
 void setMinimumCellSizeFactor(double pMinCellSizeFactor)
          The minimum visible pixel size factor.
 void setRebuildDataSource(boolean pbRebuildDataSource)
          Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.
 void setRefreshCache(boolean pbRefreshCache)
          Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.
 void setUpdateExistingItems(boolean pbUpdateExistingItems)
          Indicates whether mosaic dataset items are updated as part of the synchronization operation.
 
Methods inherited from interface com.esri.arcgis.datasourcesraster.ISynchronizeParameters
getDefaultSpatialReference, getDensificationFactor, getMaximumHighCellSize, getMaximumPyramidLevel, getMinimumColumns, getMinimumRows, getThumbnailBuilder, isBuildPyramids, isBuildThumbnail, isComputeStatistics, isRemoveInvalidItems, isResetVisibility, isSyncOnlyStaleItems, setBuildPyramids, setBuildThumbnail, setComputeStatistics, setDefaultSpatialReferenceByRef, setDensificationFactor, setMaximumHighCellSize, setMaximumPyramidLevel, setMinimumColumns, setMinimumRows, setRemoveInvalidItems, setResetVisibility, setSyncOnlyStaleItems, setThumbnailBuilderByRef
 

Method Detail

setAuxiliaryFieldValuesByRef

void setAuxiliaryFieldValuesByRef(IPropertySet ppFieldValues)
                                  throws IOException,
                                         AutomationException
A field value property set that maps field names to possible metadata values. These values take precedence over the metadata from the dataset.

Product Availability

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

Parameters:
ppFieldValues - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAuxiliaryFieldValues

IPropertySet getAuxiliaryFieldValues()
                                     throws IOException,
                                            AutomationException
A field value property set that maps field names to possible metadata values. These values take precedence over the metadata from the dataset.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumCellSizeFactor

double getMinimumCellSizeFactor()
                                throws IOException,
                                       AutomationException
The minimum visible pixel size factor.

Product Availability

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

Returns:
The pMinCellSizeFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

void setMinimumCellSizeFactor(double pMinCellSizeFactor)
                              throws IOException,
                                     AutomationException
The minimum visible pixel size factor.

Product Availability

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

Parameters:
pMinCellSizeFactor - The pMinCellSizeFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

double getMaximumCellSizeFactor()
                                throws IOException,
                                       AutomationException
The maximum visible pixel size factor.

Product Availability

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

Returns:
The pMaxCellSizeFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
                              throws IOException,
                                     AutomationException
The maximum visible pixel size factor.

Product Availability

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

Parameters:
pMaxCellSizeFactor - The pMaxCellSizeFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRebuildDataSource

void setRebuildDataSource(boolean pbRebuildDataSource)
                          throws IOException,
                                 AutomationException
Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.

Product Availability

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

Parameters:
pbRebuildDataSource - The pbRebuildDataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRebuildDataSource

boolean isRebuildDataSource()
                            throws IOException,
                                   AutomationException
Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.

Product Availability

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

Returns:
The pbRebuildDataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludedFieldsByRef

void setExcludedFieldsByRef(IStringArray ppExcludedFields)
                            throws IOException,
                                   AutomationException
The collection of field names that are excluded from being updated during synchronization.

Product Availability

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

Parameters:
ppExcludedFields - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludedFields

IStringArray getExcludedFields()
                               throws IOException,
                                      AutomationException
The collection of field names that are excluded from being updated during synchronization.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRefreshCache

void setRefreshCache(boolean pbRefreshCache)
                     throws IOException,
                            AutomationException
Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.

Product Availability

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

Parameters:
pbRefreshCache - The pbRefreshCache (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRefreshCache

boolean isRefreshCache()
                       throws IOException,
                              AutomationException
Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.

Product Availability

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

Returns:
The pbRefreshCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefineCache

void setDefineCache(boolean pbDefineCache)
                    throws IOException,
                           AutomationException
Indicates whether an attempt is made to define cache of the selected mosaic dataset items.

Product Availability

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

Parameters:
pbDefineCache - The pbDefineCache (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDefineCache

boolean isDefineCache()
                      throws IOException,
                             AutomationException
Indicates whether an attempt is made to define cache of the selected mosaic dataset items.

Product Availability

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

Returns:
The pbDefineCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheParameters

ICachedRasterFunctionArguments getCacheParameters()
                                                  throws IOException,
                                                         AutomationException
The parameters used for defining cache of the selected mosaic dataset items.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.datasourcesraster.ICachedRasterFunctionArguments
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheParametersByRef

void setCacheParametersByRef(ICachedRasterFunctionArguments ppParameters)
                             throws IOException,
                                    AutomationException
The parameters used for defining cache of the selected mosaic dataset items.

Product Availability

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

Parameters:
ppParameters - A reference to a com.esri.arcgis.datasourcesraster.ICachedRasterFunctionArguments (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXform

IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException
The georefencing of the raster item.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IGeodataXform
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

void setGeodataXformByRef(IGeodataXform ppXf)
                          throws IOException,
                                 AutomationException
The georefencing of the raster item.

Product Availability

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

Parameters:
ppXf - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXformApplyMethod

int getGeodataXformApplyMethod()
                               throws IOException,
                                      AutomationException
The method used for applying the GeodataXform.

Product Availability

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

Returns:
A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodataXformApplyMethod

void setGeodataXformApplyMethod(int pMethod)
                                throws IOException,
                                       AutomationException
The method used for applying the GeodataXform.

Product Availability

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

Parameters:
pMethod - A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setForceDefaultSpatialReference

void setForceDefaultSpatialReference(boolean pbForceDefaultSpatialReference)
                                     throws IOException,
                                            AutomationException
Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.

Product Availability

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

Parameters:
pbForceDefaultSpatialReference - The pbForceDefaultSpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isForceDefaultSpatialReference

boolean isForceDefaultSpatialReference()
                                       throws IOException,
                                              AutomationException
Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.

Product Availability

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

Returns:
The pbForceDefaultSpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpdateExistingItems

void setUpdateExistingItems(boolean pbUpdateExistingItems)
                            throws IOException,
                                   AutomationException
Indicates whether mosaic dataset items are updated as part of the synchronization operation. Setting this property to false would ensure that no item is updated regardless of whether it is rebuilt. This property can be used in conjunction with the 'RemoveInval????&

Product Availability

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

Parameters:
pbUpdateExistingItems - The pbUpdateExistingItems (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUpdateExistingItems

boolean isUpdateExistingItems()
                              throws IOException,
                                     AutomationException
Indicates whether mosaic dataset items are updated as part of the synchronization operation. Setting this property to false would ensure that no item is updated regardless of whether it is rebuilt. This property can be used in conjunction with the 'RemoveInval????&

Product Availability

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

Returns:
The pbUpdateExistingItems
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.