com.esri.arcgis.datasourcesraster
Interface IDataSourceCrawler

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArrayCrawler, FileCrawler, IDataSourceCrawlerProxy, RasterDatasetCrawler, TableCrawler

public interface IDataSourceCrawler
extends Serializable

Provides access to members that control a data source crawler.

Product Availability

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


Method Summary
 IEnumVariantSimple crawl(ITrackCancel pTrackCancel)
          Traverses a data store and returns a enumeration of crawled data source items.
 int getCrawlerItemType()
          The type of the data source item returned by this crawler.
 String getFilter()
          A string expression that allows the data source crawler to filter out invalid items.
 ITimeExtent getTimeExtent()
          The range of allowed time value associated with crawled data source items.
 boolean isCanFilterByExpression()
          Indicates whether the data source crawler can filter items by a string expression like a wild-card filter or SQL Where Clause.
 boolean isCanFilterByTime()
          Indicates whether the data source crawler can filter items by time using the 'TimeExtent' property.
 void setFilter(String pFilter)
          A string expression that allows the data source crawler to filter out invalid items.
 void setTimeExtentByRef(ITimeExtent ppTimeExtent)
          The range of allowed time value associated with crawled data source items.
 

Method Detail

getCrawlerItemType

int getCrawlerItemType()
                       throws IOException,
                              AutomationException
The type of the data source item returned by this crawler.

Product Availability

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

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

crawl

IEnumVariantSimple crawl(ITrackCancel pTrackCancel)
                         throws IOException,
                                AutomationException
Traverses a data store and returns a enumeration of crawled data source items.

Product Availability

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

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

isCanFilterByTime

boolean isCanFilterByTime()
                          throws IOException,
                                 AutomationException
Indicates whether the data source crawler can filter items by time using the 'TimeExtent' property.

Product Availability

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

Returns:
The pbCanFilterByTime
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 associated with crawled data source items. Items with time stamps that don't lie within the specified range are filtered out. This value is used only if the crawler can filter by time as indicated by the 'CanFilterByTime' proper????&

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 associated with crawled data source items. Items with time stamps that don't lie within the specified range are filtered out. This value is used only if the crawler can filter by time as indicated by the 'CanFilterByTime' proper????&

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.

isCanFilterByExpression

boolean isCanFilterByExpression()
                                throws IOException,
                                       AutomationException
Indicates whether the data source crawler can filter items by a string expression like a wild-card filter or SQL Where Clause.

Product Availability

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

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

setFilter

void setFilter(String pFilter)
               throws IOException,
                      AutomationException
A string expression that allows the data source crawler to filter out invalid items.

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
A string expression that allows the data source crawler to filter out invalid items.

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.