com.esri.arcgis.datasourcesraster

Class SynchronizeParameters

java.lang.Object

com.esri.arcgis.datasourcesraster.SynchronizeParameters

All Implemented Interfaces:

IBuildPyramidsParameters, ICalculateStatisticsParameters, IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, ISelectionParameters, ISynchronizeParameters, ISynchronizeParameters2, ISynchronizeParameters3, ISynchronizeParameters4, ISynchronizeParameters5, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class SynchronizeParameters
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IMosaicDatasetOperationParameters2, ISynchronizeParameters, ISynchronizeParameters2, ISynchronizeParameters3, ISynchronizeParameters4, ISynchronizeParameters5, IBuildPyramidsParameters, ICalculateStatisticsParameters, ISelectionParameters, IThreadedOperationParameters

COM Class 'SynchronizeParameters'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An object that controls how items in a mosaic dataset are synchronized.' 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.IMosaicDatasetOperationParameters2

IID, IID38662eb1_a3ae_42ab_a7d6_1f87ef453b32, xxDummy

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

IID379006f4_6f75_4c3b_b783_0c2e88a7b280

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

IID, IIDc68e8c4a_964c_44e9_bcce_9574621e05f9, xxDummy

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

IID273e8947_7166_4388_b024_7da20fcd7e77

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

IID59414e9a_d8d5_4e32_a1bc_0f5c5d086faa

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

IIDa1234642_e293_419a_b650_6ca72c69d9d7

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

IID241b22c3_75ef_468b_a4a3_758fd9da08df

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

IID, IIDa4a2e058_841d_43fc_a6b6_0783e5473a84, xxDummy

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

IID, IIDce8ed17c_1c4d_4eec_8259_77b784cd8de9, xxDummy

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

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

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

IID, IIDb4a72532_b2fd_41ee_9216_2fa2921af897, xxDummy

Constructor Summary

Constructors

Constructor and Description
SynchronizeParameters() Constructs a SynchronizeParameters using ArcGIS Engine.
SynchronizeParameters(java.lang.Object obj) Construct a SynchronizeParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
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.
static java.lang.String	getClsid() getClsid.
int	getCompressionQuality() The pyramid compression quality.
int	getCompressionType() The pyramid compression type.
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.
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.
java.lang.Object	getIgnoreValues() The ignore values for statistics.
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	getMaximumCellSizeFactor() The maximum visible pixel size factor.
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.
double	getMinimumCellSizeFactor() The minimum visible pixel size factor.
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.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
int	getPixelCacheCompression() The pixel cache compression type.
int	getPixelCacheCompressionQuality() The pixel cache compression quality.
java.lang.String	getPixelCacheLocation() The pixel cache location.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
int	getPyramidLevel() The number of pyramid levels.
int	getPyramidResampleType() The method used for pyramid resampling.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	getRecommendedNumThreads(int[] pRecommendedNumThreads) The number of parallel threads of execution recommended by the system.
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.
java.lang.String	getServerName() The URL to the server object name where parts of the operation may be remotely executed.
IRasterThumbnailBuilder	getThumbnailBuilder() The thumbnail builder object associated with this operation.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
int	hashCode() the hashcode for this object
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	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
boolean	isDefineCache() Indicates whether an attempt is made to define cache of the selected mosaic dataset items.
boolean	isEstimateStatistics() Indicates whether the operation estimates statistics associated with the mosaic dataset and function templates.
boolean	isForceDefaultSpatialReference() Indicates whether to overwrite the native spatial reference in a dataset with the one specified in the default spatial reference property.
boolean	isPixelCacheEnabled() Indicates whether to create and embed MRF as raster value.
boolean	isPrepareResults() Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results 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	isRefreshMensurationCapabilities() Indicates whether mensuration capabilities of the mosaic dataset is rebuilt using information stored in the function raster of selected items.
boolean	isRefreshMultidimensionalInfo() Indicates whether multidimensional info is rebuilt using applicable auxiliary fields (like Variable and Dimensions) from the mosaic catalog.
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.
boolean	isUpdateExistingItems() Indicates whether mosaic dataset items are updated as part of the synchronization operation.
void	release() Release this COM object reference
void	setAuxiliaryFieldValuesByRef(IPropertySet ppFieldValues) A field value property set that maps field names to possible metadata values.
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	setCacheParametersByRef(ICachedRasterFunctionArguments ppParameters) The parameters used for defining cache of the selected mosaic dataset items.
void	setCompressionQuality(int value) The pyramid compression quality.
void	setCompressionType(int pType) The pyramid compression type.
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	setDefineCache(boolean pbDefineCache) Indicates whether an attempt is made to define cache of the selected mosaic dataset items.
void	setDensificationFactor(double pDensificationFactor) The maximum segment length value as a factor of each incoming dataset fooprint's average dimension.
void	setEstimateStatistics(boolean pbEstimateStatistics) Indicates whether the operation estimates statistics associated with the mosaic dataset and function templates.
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	setIgnoreValues(java.lang.Object vIgnoreValues) The ignore values for statistics.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMaximumCellSizeFactor(double pMaxCellSizeFactor) The maximum visible pixel size factor.
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	setMinimumCellSizeFactor(double pMinCellSizeFactor) The minimum visible pixel size factor.
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	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setPixelCacheCompression(int pCompressionType) The pixel cache compression type.
void	setPixelCacheCompressionQuality(int pCompressionQuality) The pixel cache compression quality.
void	setPixelCacheEnabled(boolean pbPixelCacheEnabled) Indicates whether to create and embed MRF as raster value.
void	setPixelCacheLocation(java.lang.String pPixelCacheLocation) The pixel cache location.
void	setPrepareResults(boolean pbPrepareResults) Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setPyramidLevel(int pLevel) The number of pyramid levels.
void	setPyramidResampleType(int pMethod) The method used for pyramid resampling.
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	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	setRefreshMensurationCapabilities(boolean pbRefreshMensurationCapabilities) Indicates whether mensuration capabilities of the mosaic dataset is rebuilt using information stored in the function raster of selected items.
void	setRefreshMultidimensionalInfo(boolean pbRefreshMultidimensionalInfo) Indicates whether multidimensional info is rebuilt using applicable auxiliary fields (like Variable and Dimensions) from the mosaic catalog.
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	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	setServerName(java.lang.String pServerUrl) The URL to the server object name where parts of the operation may be remotely executed.
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.
void	setUpdateExistingItems(boolean pbUpdateExistingItems) Indicates whether mosaic dataset items are updated as part of the synchronization operation.
void	setXSkipFactor(int xSkipFactor) The X skip factor for statistics.
void	setYSkipFactor(int ySkipFactor) The Y skip factor for statistics.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizeParameters

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

Constructs a SynchronizeParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SynchronizeParameters

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems SynchronizeParameters theSynchronizeParameters = (SynchronizeParameters) obj;

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.

setPrepareResults

public void setPrepareResults(boolean pbPrepareResults)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.

Specified by:

setPrepareResults in interface IMosaicDatasetOperationParameters2

Parameters:

pbPrepareResults - The pbPrepareResults (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPrepareResults

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

Indicates whether the result associated with the mosaic dataset operation will be generated and made available in the Results property.

Specified by:

isPrepareResults in interface IMosaicDatasetOperationParameters2

Returns:

The pbPrepareResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSpatialReferenceByRef

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

Specified by:

setDefaultSpatialReferenceByRef in interface ISynchronizeParameters

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

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

Specified by:

getDefaultSpatialReference in interface ISynchronizeParameters

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

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

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

Specified by:

setSyncOnlyStaleItems in interface ISynchronizeParameters

Parameters:

pbSyncOnlyStaleItems - The pbSyncOnlyStaleItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSyncOnlyStaleItems

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

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

Specified by:

isSyncOnlyStaleItems in interface ISynchronizeParameters

Returns:

The pbSyncOnlyStaleItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveInvalidItems

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

Specified by:

setRemoveInvalidItems in interface ISynchronizeParameters

Parameters:

pbRemoveInvalidItems - The pbRemoveInvalidItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveInvalidItems

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

Specified by:

isRemoveInvalidItems in interface ISynchronizeParameters

Returns:

The pbRemoveInvalidItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumPyramidLevel

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

Specified by:

setMaximumPyramidLevel in interface ISynchronizeParameters

Parameters:

pMaximumPyramidLevel - The pMaximumPyramidLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

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

Specified by:

getMaximumPyramidLevel in interface ISynchronizeParameters

Returns:

The pMaximumPyramidLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumRows

public 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

Specified by:

setMinimumRows in interface ISynchronizeParameters

Parameters:

pMinimumRows - The pMinimumRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumRows

public 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

Specified by:

getMinimumRows in interface ISynchronizeParameters

Returns:

The pMinimumRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumColumns

public 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

Specified by:

setMinimumColumns in interface ISynchronizeParameters

Parameters:

pMinimumColumns - The pMinimumColumns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumColumns

public 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

Specified by:

getMinimumColumns in interface ISynchronizeParameters

Returns:

The pMinimumColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumHighCellSize

public 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

Specified by:

setMaximumHighCellSize in interface ISynchronizeParameters

Parameters:

pMaximumHighCellSize - The pMaximumHighCellSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumHighCellSize

public 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

Specified by:

getMaximumHighCellSize in interface ISynchronizeParameters

Returns:

The pMaximumHighCellSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

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

Specified by:

setComputeStatistics in interface ISynchronizeParameters

Parameters:

pbComputeStatistics - The pbComputeStatistics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

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

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

Specified by:

isComputeStatistics in interface ISynchronizeParameters

Returns:

The pbComputeStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

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

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

Specified by:

setBuildPyramids in interface ISynchronizeParameters

Parameters:

pbBuildPyramids - The pbBuildPyramids (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

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

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

Specified by:

isBuildPyramids in interface ISynchronizeParameters

Returns:

The pbBuildPyramids

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

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

Indicates whether items thumbnails are built and saved.

Specified by:

setBuildThumbnail in interface ISynchronizeParameters

Parameters:

pbBuildThumbnail - The pbBuildThumbnail (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

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

Indicates whether items thumbnails are built and saved.

Specified by:

isBuildThumbnail in interface ISynchronizeParameters

Returns:

The pbBuildThumbnail

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setThumbnailBuilderByRef

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

Specified by:

setThumbnailBuilderByRef in interface ISynchronizeParameters

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

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

Specified by:

getThumbnailBuilder in interface ISynchronizeParameters

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

public 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

Specified by:

setDensificationFactor in interface ISynchronizeParameters

Parameters:

pDensificationFactor - The pDensificationFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDensificationFactor

public 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

Specified by:

getDensificationFactor in interface ISynchronizeParameters

Returns:

The pDensificationFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResetVisibility

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

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

Specified by:

setResetVisibility in interface ISynchronizeParameters

Parameters:

pbResetVisibility - The pbResetVisibility (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isResetVisibility

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

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

Specified by:

isResetVisibility in interface ISynchronizeParameters

Returns:

The pbResetVisibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryFieldValuesByRef

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

Specified by:

setAuxiliaryFieldValuesByRef in interface ISynchronizeParameters2

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

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

Specified by:

getAuxiliaryFieldValues in interface ISynchronizeParameters2

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

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

The minimum visible pixel size factor.

Specified by:

getMinimumCellSizeFactor in interface ISynchronizeParameters2

Returns:

The pMinCellSizeFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSizeFactor

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

The minimum visible pixel size factor.

Specified by:

setMinimumCellSizeFactor in interface ISynchronizeParameters2

Parameters:

pMinCellSizeFactor - The pMinCellSizeFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSizeFactor

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

The maximum visible pixel size factor.

Specified by:

getMaximumCellSizeFactor in interface ISynchronizeParameters2

Returns:

The pMaxCellSizeFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeFactor

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

The maximum visible pixel size factor.

Specified by:

setMaximumCellSizeFactor in interface ISynchronizeParameters2

Parameters:

pMaxCellSizeFactor - The pMaxCellSizeFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRebuildDataSource

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

Specified by:

setRebuildDataSource in interface ISynchronizeParameters2

Parameters:

pbRebuildDataSource - The pbRebuildDataSource (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRebuildDataSource

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

Specified by:

isRebuildDataSource in interface ISynchronizeParameters2

Returns:

The pbRebuildDataSource

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExcludedFieldsByRef

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

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

Specified by:

setExcludedFieldsByRef in interface ISynchronizeParameters2

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

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

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

Specified by:

getExcludedFields in interface ISynchronizeParameters2

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

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

Specified by:

setRefreshCache in interface ISynchronizeParameters2

Parameters:

pbRefreshCache - The pbRefreshCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefreshCache

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

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

Specified by:

isRefreshCache in interface ISynchronizeParameters2

Returns:

The pbRefreshCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefineCache

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

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

Specified by:

setDefineCache in interface ISynchronizeParameters2

Parameters:

pbDefineCache - The pbDefineCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDefineCache

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

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

Specified by:

isDefineCache in interface ISynchronizeParameters2

Returns:

The pbDefineCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheParameters

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

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

Specified by:

getCacheParameters in interface ISynchronizeParameters2

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

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

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

Specified by:

setCacheParametersByRef in interface ISynchronizeParameters2

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

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

The georefencing of the raster item.

Specified by:

getGeodataXform in interface ISynchronizeParameters2

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

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

The georefencing of the raster item.

Specified by:

setGeodataXformByRef in interface ISynchronizeParameters2

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

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

The method used for applying the GeodataXform.

Specified by:

getGeodataXformApplyMethod in interface ISynchronizeParameters2

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

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

The method used for applying the GeodataXform.

Specified by:

setGeodataXformApplyMethod in interface ISynchronizeParameters2

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

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

Specified by:

setForceDefaultSpatialReference in interface ISynchronizeParameters2

Parameters:

pbForceDefaultSpatialReference - The pbForceDefaultSpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isForceDefaultSpatialReference

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

Specified by:

isForceDefaultSpatialReference in interface ISynchronizeParameters2

Returns:

The pbForceDefaultSpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateExistingItems

public 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

Specified by:

setUpdateExistingItems in interface ISynchronizeParameters2

Parameters:

pbUpdateExistingItems - The pbUpdateExistingItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdateExistingItems

public 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

Specified by:

isUpdateExistingItems in interface ISynchronizeParameters2

Returns:

The pbUpdateExistingItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshMultidimensionalInfo

public void setRefreshMultidimensionalInfo(boolean pbRefreshMultidimensionalInfo)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether multidimensional info is rebuilt using applicable auxiliary fields (like Variable and Dimensions) from the mosaic catalog.

Specified by:

setRefreshMultidimensionalInfo in interface ISynchronizeParameters3

Parameters:

pbRefreshMultidimensionalInfo - The pbRefreshMultidimensionalInfo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefreshMultidimensionalInfo

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

Indicates whether multidimensional info is rebuilt using applicable auxiliary fields (like Variable and Dimensions) from the mosaic catalog.

Specified by:

isRefreshMultidimensionalInfo in interface ISynchronizeParameters3

Returns:

The pbRefreshMultidimensionalInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshMensurationCapabilities

public void setRefreshMensurationCapabilities(boolean pbRefreshMensurationCapabilities)
                                       throws java.io.IOException,
                                              AutomationException

Indicates whether mensuration capabilities of the mosaic dataset is rebuilt using information stored in the function raster of selected items.

Specified by:

setRefreshMensurationCapabilities in interface ISynchronizeParameters3

Parameters:

pbRefreshMensurationCapabilities - The pbRefreshMensurationCapabilities (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefreshMensurationCapabilities

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

Indicates whether mensuration capabilities of the mosaic dataset is rebuilt using information stored in the function raster of selected items.

Specified by:

isRefreshMensurationCapabilities in interface ISynchronizeParameters3

Returns:

The pbRefreshMensurationCapabilities

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEstimateStatistics

public void setEstimateStatistics(boolean pbEstimateStatistics)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the operation estimates statistics associated with the mosaic dataset and function templates.

Specified by:

setEstimateStatistics in interface ISynchronizeParameters4

Parameters:

pbEstimateStatistics - The pbEstimateStatistics (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEstimateStatistics

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

Indicates whether the operation estimates statistics associated with the mosaic dataset and function templates.

Specified by:

isEstimateStatistics in interface ISynchronizeParameters4

Returns:

The pbEstimateStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelCacheEnabled

public void setPixelCacheEnabled(boolean pbPixelCacheEnabled)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to create and embed MRF as raster value.

Specified by:

setPixelCacheEnabled in interface ISynchronizeParameters5

Parameters:

pbPixelCacheEnabled - The pbPixelCacheEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPixelCacheEnabled

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

Indicates whether to create and embed MRF as raster value.

Specified by:

isPixelCacheEnabled in interface ISynchronizeParameters5

Returns:

The pbPixelCacheEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelCacheLocation

public void setPixelCacheLocation(java.lang.String pPixelCacheLocation)
                           throws java.io.IOException,
                                  AutomationException

The pixel cache location.

Specified by:

setPixelCacheLocation in interface ISynchronizeParameters5

Parameters:

pPixelCacheLocation - The pPixelCacheLocation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelCacheLocation

public java.lang.String getPixelCacheLocation()
                                       throws java.io.IOException,
                                              AutomationException

The pixel cache location.

Specified by:

getPixelCacheLocation in interface ISynchronizeParameters5

Returns:

The pPixelCacheLocation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelCacheCompression

public void setPixelCacheCompression(int pCompressionType)
                              throws java.io.IOException,
                                     AutomationException

The pixel cache compression type.

Specified by:

setPixelCacheCompression in interface ISynchronizeParameters5

Parameters:

pCompressionType - A com.esri.arcgis.geodatabase.esriRasterCompressionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelCacheCompression

public int getPixelCacheCompression()
                             throws java.io.IOException,
                                    AutomationException

The pixel cache compression type.

Specified by:

getPixelCacheCompression in interface ISynchronizeParameters5

Returns:

A com.esri.arcgis.geodatabase.esriRasterCompressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelCacheCompressionQuality

public void setPixelCacheCompressionQuality(int pCompressionQuality)
                                     throws java.io.IOException,
                                            AutomationException

The pixel cache compression quality.

Specified by:

setPixelCacheCompressionQuality in interface ISynchronizeParameters5

Parameters:

pCompressionQuality - The pCompressionQuality (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelCacheCompressionQuality

public int getPixelCacheCompressionQuality()
                                    throws java.io.IOException,
                                           AutomationException

The pixel cache compression quality.

Specified by:

getPixelCacheCompressionQuality in interface ISynchronizeParameters5

Returns:

The pCompressionQuality

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidResampleType

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

The method used for pyramid resampling.

Specified by:

setPyramidResampleType in interface IBuildPyramidsParameters

Parameters:

pMethod - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidResampleType

public int getPyramidResampleType()
                           throws java.io.IOException,
                                  AutomationException

The method used for pyramid resampling.

Specified by:

getPyramidResampleType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

public void setPyramidLevel(int pLevel)
                     throws java.io.IOException,
                            AutomationException

The number of pyramid levels.

Specified by:

setPyramidLevel in interface IBuildPyramidsParameters

Parameters:

pLevel - The pLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

public int getPyramidLevel()
                    throws java.io.IOException,
                           AutomationException

The number of pyramid levels.

Specified by:

getPyramidLevel in interface IBuildPyramidsParameters

Returns:

The pLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(int pType)
                        throws java.io.IOException,
                               AutomationException

The pyramid compression type.

Specified by:

setCompressionType in interface IBuildPyramidsParameters

Parameters:

pType - A com.esri.arcgis.geodatabase.esriRasterCompressionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionType

public int getCompressionType()
                       throws java.io.IOException,
                              AutomationException

The pyramid compression type.

Specified by:

getCompressionType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.esriRasterCompressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int value)
                           throws java.io.IOException,
                                  AutomationException

The pyramid compression quality.

Specified by:

setCompressionQuality in interface IBuildPyramidsParameters

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

public int getCompressionQuality()
                          throws java.io.IOException,
                                 AutomationException

The pyramid compression quality.

Specified by:

getCompressionQuality in interface IBuildPyramidsParameters

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

public int getXSkipFactor()
                   throws java.io.IOException,
                          AutomationException

The X skip factor for statistics.

Specified by:

getXSkipFactor in interface ICalculateStatisticsParameters

Returns:

The xSkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
                    throws java.io.IOException,
                           AutomationException

The X skip factor for statistics.

Specified by:

setXSkipFactor in interface ICalculateStatisticsParameters

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

public int getYSkipFactor()
                   throws java.io.IOException,
                          AutomationException

The Y skip factor for statistics.

Specified by:

getYSkipFactor in interface ICalculateStatisticsParameters

Returns:

The ySkipFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
                    throws java.io.IOException,
                           AutomationException

The Y skip factor for statistics.

Specified by:

setYSkipFactor in interface ICalculateStatisticsParameters

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

public java.lang.Object getIgnoreValues()
                                 throws java.io.IOException,
                                        AutomationException

The ignore values for statistics.

Specified by:

getIgnoreValues in interface ICalculateStatisticsParameters

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

public void setIgnoreValues(java.lang.Object vIgnoreValues)
                     throws java.io.IOException,
                            AutomationException

The ignore values for statistics.

Specified by:

setIgnoreValues in interface ICalculateStatisticsParameters

Parameters:

vIgnoreValues - A Variant (in)

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.

setServerName

public void setServerName(java.lang.String pServerUrl)
                   throws java.io.IOException,
                          AutomationException

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerUrl - The pServerUrl (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerName

public java.lang.String getServerName()
                               throws java.io.IOException,
                                      AutomationException

The URL to the server object name where parts of the operation may be remotely executed.

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerUrl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws java.io.IOException,
                          AutomationException

The number of parallel threads that execute parts of the associated operation.

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumThreads

public int getNumThreads()
                  throws java.io.IOException,
                         AutomationException

The number of parallel threads that execute parts of the associated operation.

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws java.io.IOException,
                                     AutomationException

The number of parallel threads of execution recommended by the system.

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.