com.esri.arcgis.datasourcesraster

Interface ISynchronizeParameters2

All Superinterfaces:

ISynchronizeParameters, java.io.Serializable

All Known Subinterfaces:

ISynchronizeParameters3, ISynchronizeParameters4, ISynchronizeParameters5, ISynchronizeParameters6

All Known Implementing Classes:

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

public interface ISynchronizeParameters2
extends ISynchronizeParameters, java.io.Serializable

COM Interface 'ISynchronizeParameters2'. Generated 9/21/2023 10:01:49 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	IIDa1234642_e293_419a_b650_6ca72c69d9d7
static int	xxDummy Deprecated. Internal use only

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

IID241b22c3_75ef_468b_a4a3_758fd9da08df

Method Summary

Modifier and Type	Method and Description
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

Field Detail

IIDa1234642_e293_419a_b650_6ca72c69d9d7

static final int IIDa1234642_e293_419a_b650_6ca72c69d9d7

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

setAuxiliaryFieldValuesByRef

void setAuxiliaryFieldValuesByRef(IPropertySet ppFieldValues)
                           throws java.io.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.

Parameters:

ppFieldValues - 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.

getAuxiliaryFieldValues

IPropertySet getAuxiliaryFieldValues()
                              throws java.io.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.

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.

getMinimumCellSizeFactor

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

The minimum visible pixel size factor.

Returns:

The pMinCellSizeFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

void setMinimumCellSizeFactor(double pMinCellSizeFactor)
                       throws java.io.IOException,
                              AutomationException

The minimum visible pixel size factor.

Parameters:

pMinCellSizeFactor - The pMinCellSizeFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

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

The maximum visible pixel size factor.

Returns:

The pMaxCellSizeFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

void setMaximumCellSizeFactor(double pMaxCellSizeFactor)
                       throws java.io.IOException,
                              AutomationException

The maximum visible pixel size factor.

Parameters:

pMaxCellSizeFactor - The pMaxCellSizeFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRebuildDataSource

void setRebuildDataSource(boolean pbRebuildDataSource)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.

Parameters:

pbRebuildDataSource - The pbRebuildDataSource (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRebuildDataSource

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

Indicates whether the original datasource added to the mosaic dataset will be rebuilt in order to update the metadata fields.

Returns:

The pbRebuildDataSource

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExcludedFieldsByRef

void setExcludedFieldsByRef(IStringArray ppExcludedFields)
                     throws java.io.IOException,
                            AutomationException

The collection of field names that are excluded from being updated during synchronization.

Parameters:

ppExcludedFields - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludedFields

IStringArray getExcludedFields()
                        throws java.io.IOException,
                               AutomationException

The collection of field names that are excluded from being updated during synchronization.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshCache

void setRefreshCache(boolean pbRefreshCache)
              throws java.io.IOException,
                     AutomationException

Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.

Parameters:

pbRefreshCache - The pbRefreshCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefreshCache

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

Indicates whether an attempt is made to refresh the cache of the selected mosaic dataset items.

Returns:

The pbRefreshCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefineCache

void setDefineCache(boolean pbDefineCache)
             throws java.io.IOException,
                    AutomationException

Indicates whether an attempt is made to define cache of the selected mosaic dataset items.

Parameters:

pbDefineCache - The pbDefineCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDefineCache

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

Indicates whether an attempt is made to define cache of the selected mosaic dataset items.

Returns:

The pbDefineCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheParameters

ICachedRasterFunctionArguments getCacheParameters()
                                           throws java.io.IOException,
                                                  AutomationException

The parameters used for defining cache of the selected mosaic dataset items.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheParametersByRef

void setCacheParametersByRef(ICachedRasterFunctionArguments ppParameters)
                      throws java.io.IOException,
                             AutomationException

The parameters used for defining cache of the selected mosaic dataset items.

Parameters:

ppParameters - A reference to a com.esri.arcgis.datasourcesraster.ICachedRasterFunctionArguments (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodataXform

IGeodataXform getGeodataXform()
                       throws java.io.IOException,
                              AutomationException

The georefencing of the raster item.

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeodataXform

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

void setGeodataXformByRef(IGeodataXform ppXf)
                   throws java.io.IOException,
                          AutomationException

The georefencing of the raster item.

Parameters:

ppXf - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodataXformApplyMethod

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

The method used for applying the GeodataXform.

Returns:

A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeodataXformApplyMethod

void setGeodataXformApplyMethod(int pMethod)
                         throws java.io.IOException,
                                AutomationException

The method used for applying the GeodataXform.

Parameters:

pMethod - A com.esri.arcgis.datasourcesraster.esriGeodataXformApplyMethod constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setForceDefaultSpatialReference

void setForceDefaultSpatialReference(boolean pbForceDefaultSpatialReference)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.

Parameters:

pbForceDefaultSpatialReference - The pbForceDefaultSpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isForceDefaultSpatialReference

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

Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.

Returns:

The pbForceDefaultSpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateExistingItems

void setUpdateExistingItems(boolean pbUpdateExistingItems)
                     throws java.io.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

Parameters:

pbUpdateExistingItems - The pbUpdateExistingItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateExistingItems

boolean isUpdateExistingItems()
                       throws java.io.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

Returns:

The pbUpdateExistingItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.