com.esri.arcgis.datasourcesraster
Interface IAddRastersParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
AddRastersParameters, IAddRastersParametersProxy

public interface IAddRastersParameters
extends Serializable

Provides access to members that control parameters for adding rasters to a mosaic dataset.

Product Availability

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


Method Summary
 IDataSourceCrawler getCrawler()
          The data source crawler that provides incoming data source items.
 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.
 IRasterType getRasterType()
          The raster type used for constructing raster datasets using incoming data source items.
 ITimeExtent getTimeExtent()
          The range of allowed time value for Item URIs.
 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 isSynchronizeItems()
          Indicates whether catalog items are synchronized once added to the mosaic dataset.
 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 setCrawlerByRef(IDataSourceCrawler ppCrawler)
          The data source crawler that provides incoming data source items.
 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 setRasterTypeByRef(IRasterType ppRasterType)
          The raster type used for constructing raster datasets using incoming data source items.
 void setSynchronizeItems(boolean pbSynchronizeItems)
          Indicates whether catalog items are synchronized once added to the mosaic dataset.
 void setTimeExtentByRef(ITimeExtent ppTimeExtent)
          The range of allowed time value for Item URIs.
 

Method Detail

setCrawlerByRef

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

setSynchronizeItems

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.

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

isSynchronizeItems

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.

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

setAllowInPlaceSync

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.

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

isAllowInPlaceSync

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.

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

setFilter

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.

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

getFilter

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.

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

setTimeExtentByRef

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.

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

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.

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.