com.esri.arcgis.datasourcesraster
Class AddRastersParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.AddRastersParameters

All Implemented Interfaces:

IAddRastersParameters, IBuildPyramidsParameters, ICalculateStatisticsParameters, IMosaicDatasetOperationParameters, ISynchronizeParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AddRastersParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IAddRastersParameters, ISynchronizeParameters, IBuildPyramidsParameters, ICalculateStatisticsParameters, IThreadedOperationParameters

An object that controls how rasters are added to a mosaic dataset.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AddRastersParameters()
Constructs a AddRastersParameters using ArcGIS Engine.

AddRastersParameters(Object obj)
Construct a AddRastersParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCompressionQuality() The pyramid compression quality.
int	getCompressionType() The pyramid compression type.
IDataSourceCrawler	getCrawler() The data source crawler that provides incoming data source items.
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.
int	getDuplicateItemsAction() Indicates how incoming duplicates items are handled.
String	getFilter() Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items created by the crawler.
Object	getIgnoreValues() The ignore values for statistics.
double	getMaximumHighCellSize() The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item.
int	getMaximumPyramidLevel() The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item.
int	getMinimumColumns() The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
int	getMinimumRows() The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
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.
IRasterType	getRasterType() The raster type used for constructing raster datasets using incoming data source items.
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.
String	getServerName() The host machine name where parts of the operation are remotely executed.
IRasterThumbnailBuilder	getThumbnailBuilder() The thumbnail builder object associated with this operation.
ITimeExtent	getTimeExtent() The range of allowed time value for Item URIs.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
int	hashCode() the hashcode for this object
boolean	isAllowInPlaceSync() Inidicates whether to allow items to be build as soon as they are added to the mosaic dataset (as long as the raster type allows in-place synchronization).
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	isRemoveInvalidItems() Indicates whether invalid items are removed from the mosaic dataset.
boolean	isResetVisibility() Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.
boolean	isSynchronizeItems() Indicates whether catalog items are synchronized once added to the mosaic dataset.
boolean	isSyncOnlyStaleItems() Indicates if only those items found to be stale are synchronized.
void	setAllowInPlaceSync(boolean pbAllowInPlaceSync) Inidicates whether to allow items to be build as soon as they are added to the mosaic dataset (as long as the raster type allows in-place synchronization).
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	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	setCrawlerByRef(IDataSourceCrawler ppCrawler) The data source crawler that provides incoming data source items.
void	setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) The default spatial reference used by all raster types for those dataset which do not have an associated native spatial reference.
void	setDensificationFactor(double pDensificationFactor) The maximum segment length value as a factor of each incoming dataset fooprint's average dimension.
void	setDuplicateItemsAction(int pAction) Indicates how incoming duplicates items are handled.
void	setFilter(String pFilter) Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items created by the crawler.
void	setIgnoreValues(Object vIgnoreValues) The ignore values for statistics.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMaximumHighCellSize(double pMaximumHighCellSize) The maximum allowed computed value for the high pixel size for the function raster dataset associated with a synchronized item.
void	setMaximumPyramidLevel(int pMaximumPyramidLevel) The maximum number of pyramid levels to use from the function raster dataset associated with a synchronized item.
void	setMinimumColumns(int pMinimumColumns) The minimum number of pixel columnns allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
void	setMinimumRows(int pMinimumRows) The minimum number of pixel rows allowed at the top-most pyramid level in the function raster dataset associated with a synchronized item.
void	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	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	setRasterTypeByRef(IRasterType ppRasterType) The raster type used for constructing raster datasets using incoming data source items.
void	setRemoveInvalidItems(boolean pbRemoveInvalidItems) Indicates whether invalid items are removed from the mosaic dataset.
void	setResetVisibility(boolean pbResetVisibility) Indicates whether each selected item's visibility values (MinPS and MaxPS) are reset to null.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setServerName(String pServerName) The host machine name where parts of the operation are remotely executed.
void	setSynchronizeItems(boolean pbSynchronizeItems) Indicates whether catalog items are synchronized once added to the mosaic dataset.
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	setTimeExtentByRef(ITimeExtent ppTimeExtent) The range of allowed time value for Item URIs.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AddRastersParameters

public AddRastersParameters()
                     throws IOException,
                            UnknownHostException

Constructs a AddRastersParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AddRastersParameters

public AddRastersParameters(Object obj)
                     throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AddRastersParameters theAddRastersParameters = (AddRastersParameters) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

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.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws 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.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws 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.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

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

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

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.

setCrawlerByRef

public void setCrawlerByRef(IDataSourceCrawler ppCrawler)
                     throws IOException,
                            AutomationException

The data source crawler that provides incoming data source items.

Product Availability

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

Specified by:

setCrawlerByRef in interface IAddRastersParameters

Parameters:

ppCrawler - A reference to a com.esri.arcgis.datasourcesraster.IDataSourceCrawler (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCrawler

public IDataSourceCrawler getCrawler()
                              throws IOException,
                                     AutomationException

The data source crawler that provides incoming data source items.

Product Availability

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

Specified by:

getCrawler in interface IAddRastersParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypeByRef

public void setRasterTypeByRef(IRasterType ppRasterType)
                        throws IOException,
                               AutomationException

The raster type used for constructing raster datasets using incoming data source items.

Product Availability

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

Specified by:

setRasterTypeByRef in interface IAddRastersParameters

Parameters:

ppRasterType - A reference to a com.esri.arcgis.datasourcesraster.IRasterType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterType

public IRasterType getRasterType()
                          throws IOException,
                                 AutomationException

The raster type used for constructing raster datasets using incoming data source items.

Product Availability

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

Specified by:

getRasterType in interface IAddRastersParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDuplicateItemsAction

public void setDuplicateItemsAction(int pAction)
                             throws IOException,
                                    AutomationException

Indicates how incoming duplicates items are handled. Item URIs with the same key value are assumed to be duplicate.

Product Availability

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

Specified by:

setDuplicateItemsAction in interface IAddRastersParameters

Parameters:

pAction - A com.esri.arcgis.datasourcesraster.esriDuplicateItemsAction constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDuplicateItemsAction

public int getDuplicateItemsAction()
                            throws IOException,
                                   AutomationException

Indicates how incoming duplicates items are handled. Item URIs with the same key value are assumed to be duplicate.

Product Availability

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

Specified by:

getDuplicateItemsAction in interface IAddRastersParameters

Returns:

A com.esri.arcgis.datasourcesraster.esriDuplicateItemsAction constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSynchronizeItems

public void setSynchronizeItems(boolean pbSynchronizeItems)
                         throws IOException,
                                AutomationException

Indicates whether catalog items are synchronized once added to the mosaic dataset.

Product Availability

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

Specified by:

setSynchronizeItems in interface IAddRastersParameters

Parameters:

pbSynchronizeItems - The pbSynchronizeItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSynchronizeItems

public boolean isSynchronizeItems()
                           throws IOException,
                                  AutomationException

Indicates whether catalog items are synchronized once added to the mosaic dataset.

Product Availability

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

Specified by:

isSynchronizeItems in interface IAddRastersParameters

Returns:

The pbSynchronizeItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowInPlaceSync

public void setAllowInPlaceSync(boolean pbAllowInPlaceSync)
                         throws IOException,
                                AutomationException

Inidicates whether to allow items to be build as soon as they are added to the mosaic dataset (as long as the raster type allows in-place synchronization).

Product Availability

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

Specified by:

setAllowInPlaceSync in interface IAddRastersParameters

Parameters:

pbAllowInPlaceSync - The pbAllowInPlaceSync (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowInPlaceSync

public boolean isAllowInPlaceSync()
                           throws IOException,
                                  AutomationException

Inidicates whether to allow items to be build as soon as they are added to the mosaic dataset (as long as the raster type allows in-place synchronization).

Product Availability

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

Specified by:

isAllowInPlaceSync in interface IAddRastersParameters

Returns:

The pbAllowInPlaceSync

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilter

public void setFilter(String pFilter)
               throws IOException,
                      AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items created by the crawler. No item URIs are requested for those data sources don't match the specified regular expression.

Product Availability

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

Specified by:

setFilter in interface IAddRastersParameters

Parameters:

pFilter - The pFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items created by the crawler. No item URIs are requested for those data sources don't match the specified regular expression.

Product Availability

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

Specified by:

getFilter in interface IAddRastersParameters

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

public void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws IOException,
                               AutomationException

The range of allowed time value for Item URIs. Item URIs with 'SourceTimeStamp' that don't lie within the specified range are filtered out.

Product Availability

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

Specified by:

setTimeExtentByRef in interface IAddRastersParameters

Parameters:

ppTimeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtent

public ITimeExtent getTimeExtent()
                          throws IOException,
                                 AutomationException

The range of allowed time value for Item URIs. Item URIs with 'SourceTimeStamp' that don't lie within the specified range are filtered out.

Product Availability

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

Specified by:

getTimeExtent in interface IAddRastersParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSpatialReferenceByRef

public void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
                                     throws IOException,
                                            AutomationException

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

Product Availability

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

Specified by:

setDefaultSpatialReferenceByRef in interface ISynchronizeParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

public ISpatialReference getDefaultSpatialReference()
                                             throws IOException,
                                                    AutomationException

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

Product Availability

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

Specified by:

getDefaultSpatialReference in interface ISynchronizeParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSyncOnlyStaleItems

public void setSyncOnlyStaleItems(boolean pbSyncOnlyStaleItems)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

setSyncOnlyStaleItems in interface ISynchronizeParameters

Parameters:

pbSyncOnlyStaleItems - The pbSyncOnlyStaleItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSyncOnlyStaleItems

public boolean isSyncOnlyStaleItems()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Specified by:

isSyncOnlyStaleItems in interface ISynchronizeParameters

Returns:

The pbSyncOnlyStaleItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveInvalidItems

public void setRemoveInvalidItems(boolean pbRemoveInvalidItems)
                           throws IOException,
                                  AutomationException

Indicates whether invalid items are removed from the mosaic dataset.

Product Availability

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

Specified by:

setRemoveInvalidItems in interface ISynchronizeParameters

Parameters:

pbRemoveInvalidItems - The pbRemoveInvalidItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveInvalidItems

public boolean isRemoveInvalidItems()
                             throws IOException,
                                    AutomationException

Indicates whether invalid items are removed from the mosaic dataset.

Product Availability

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

Specified by:

isRemoveInvalidItems in interface ISynchronizeParameters

Returns:

The pbRemoveInvalidItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumPyramidLevel

public void setMaximumPyramidLevel(int pMaximumPyramidLevel)
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

setMaximumPyramidLevel in interface ISynchronizeParameters

Parameters:

pMaximumPyramidLevel - The pMaximumPyramidLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

public int getMaximumPyramidLevel()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

getMaximumPyramidLevel in interface ISynchronizeParameters

Returns:

The pMaximumPyramidLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumRows

public void setMinimumRows(int pMinimumRows)
                    throws IOException,
                           AutomationException

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

Product Availability

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

Specified by:

setMinimumRows in interface ISynchronizeParameters

Parameters:

pMinimumRows - The pMinimumRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumRows

public int getMinimumRows()
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

getMinimumRows in interface ISynchronizeParameters

Returns:

The pMinimumRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumColumns

public void setMinimumColumns(int pMinimumColumns)
                       throws IOException,
                              AutomationException

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

Product Availability

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

Specified by:

setMinimumColumns in interface ISynchronizeParameters

Parameters:

pMinimumColumns - The pMinimumColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumColumns

public int getMinimumColumns()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Specified by:

getMinimumColumns in interface ISynchronizeParameters

Returns:

The pMinimumColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumHighCellSize

public void setMaximumHighCellSize(double pMaximumHighCellSize)
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

setMaximumHighCellSize in interface ISynchronizeParameters

Parameters:

pMaximumHighCellSize - The pMaximumHighCellSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumHighCellSize

public double getMaximumHighCellSize()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

getMaximumHighCellSize in interface ISynchronizeParameters

Returns:

The pMaximumHighCellSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setComputeStatistics

public void setComputeStatistics(boolean pbComputeStatistics)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

setComputeStatistics in interface ISynchronizeParameters

Parameters:

pbComputeStatistics - The pbComputeStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isComputeStatistics

public boolean isComputeStatistics()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

isComputeStatistics in interface ISynchronizeParameters

Returns:

The pbComputeStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramids

public void setBuildPyramids(boolean pbBuildPyramids)
                      throws IOException,
                             AutomationException

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

Product Availability

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

Specified by:

setBuildPyramids in interface ISynchronizeParameters

Parameters:

pbBuildPyramids - The pbBuildPyramids (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramids

public boolean isBuildPyramids()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

isBuildPyramids in interface ISynchronizeParameters

Returns:

The pbBuildPyramids

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildThumbnail

public void setBuildThumbnail(boolean pbBuildThumbnail)
                       throws IOException,
                              AutomationException

Indicates whether items thumbnails are built and saved.

Product Availability

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

Specified by:

setBuildThumbnail in interface ISynchronizeParameters

Parameters:

pbBuildThumbnail - The pbBuildThumbnail (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildThumbnail

public boolean isBuildThumbnail()
                         throws IOException,
                                AutomationException

Indicates whether items thumbnails are built and saved.

Product Availability

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

Specified by:

isBuildThumbnail in interface ISynchronizeParameters

Returns:

The pbBuildThumbnail

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnailBuilderByRef

public void setThumbnailBuilderByRef(IRasterThumbnailBuilder ppThumbnailBuilder)
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

setThumbnailBuilderByRef in interface ISynchronizeParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnailBuilder

public IRasterThumbnailBuilder getThumbnailBuilder()
                                            throws IOException,
                                                   AutomationException

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

Product Availability

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

Specified by:

getThumbnailBuilder in interface ISynchronizeParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDensificationFactor

public void setDensificationFactor(double pDensificationFactor)
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

setDensificationFactor in interface ISynchronizeParameters

Parameters:

pDensificationFactor - The pDensificationFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDensificationFactor

public double getDensificationFactor()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

getDensificationFactor in interface ISynchronizeParameters

Returns:

The pDensificationFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResetVisibility

public void setResetVisibility(boolean pbResetVisibility)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

setResetVisibility in interface ISynchronizeParameters

Parameters:

pbResetVisibility - The pbResetVisibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResetVisibility

public boolean isResetVisibility()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

isResetVisibility in interface ISynchronizeParameters

Returns:

The pbResetVisibility

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidResampleType

public void setPyramidResampleType(int pMethod)
                            throws IOException,
                                   AutomationException

The method used for pyramid resampling.

Product Availability

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

Specified by:

setPyramidResampleType in interface IBuildPyramidsParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidResampleType

public int getPyramidResampleType()
                           throws IOException,
                                  AutomationException

The method used for pyramid resampling.

Product Availability

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

Specified by:

getPyramidResampleType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

public void setPyramidLevel(int pLevel)
                     throws IOException,
                            AutomationException

The number of pyramid levels.

Product Availability

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

Specified by:

setPyramidLevel in interface IBuildPyramidsParameters

Parameters:

pLevel - The pLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

public int getPyramidLevel()
                    throws IOException,
                           AutomationException

The number of pyramid levels.

Product Availability

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

Specified by:

getPyramidLevel in interface IBuildPyramidsParameters

Returns:

The pLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(int pType)
                        throws IOException,
                               AutomationException

The pyramid compression type.

Product Availability

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

Specified by:

setCompressionType in interface IBuildPyramidsParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

public int getCompressionType()
                       throws IOException,
                              AutomationException

The pyramid compression type.

Product Availability

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

Specified by:

getCompressionType in interface IBuildPyramidsParameters

Returns:

A com.esri.arcgis.geodatabase.esriRasterCompressionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int value)
                           throws IOException,
                                  AutomationException

The pyramid compression quality.

Product Availability

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

Specified by:

setCompressionQuality in interface IBuildPyramidsParameters

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

public int getCompressionQuality()
                          throws IOException,
                                 AutomationException

The pyramid compression quality.

Product Availability

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

Specified by:

getCompressionQuality in interface IBuildPyramidsParameters

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

public int getXSkipFactor()
                   throws IOException,
                          AutomationException

The X skip factor for statistics.

Product Availability

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

Specified by:

getXSkipFactor in interface ICalculateStatisticsParameters

Returns:

The xSkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
                    throws IOException,
                           AutomationException

The X skip factor for statistics.

Product Availability

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

Specified by:

setXSkipFactor in interface ICalculateStatisticsParameters

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

public int getYSkipFactor()
                   throws IOException,
                          AutomationException

The Y skip factor for statistics.

Product Availability

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

Specified by:

getYSkipFactor in interface ICalculateStatisticsParameters

Returns:

The ySkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
                    throws IOException,
                           AutomationException

The Y skip factor for statistics.

Product Availability

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

Specified by:

setYSkipFactor in interface ICalculateStatisticsParameters

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

public Object getIgnoreValues()
                       throws IOException,
                              AutomationException

The ignore values for statistics.

Product Availability

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

Specified by:

getIgnoreValues in interface ICalculateStatisticsParameters

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

public void setIgnoreValues(Object vIgnoreValues)
                     throws IOException,
                            AutomationException

The ignore values for statistics.

Product Availability

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

Specified by:

setIgnoreValues in interface ICalculateStatisticsParameters

Parameters:

vIgnoreValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pServerName)
                   throws IOException,
                          AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerName - The pServerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumThreads

public int getNumThreads()
                  throws IOException,
                         AutomationException

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

Product Availability

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

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

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

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

Product Availability

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

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.