Class FileCrawlerClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[Guid("1B13F960-8914-4440-A2D5-08B1B16C916D")]
[ClassInterface(ClassInterfaceType.None)]
public class FileCrawlerClass : FileCrawler, IDataSourceCrawler3, IDataSourceCrawler2, IDataSourceCrawler, IFileCrawler3, IFileCrawler2, IFileCrawler, IItemPaths2, IItemPaths
Inheritance
FileCrawlerClass
Implements
Inherited Members

Constructors

FileCrawlerClass()

public FileCrawlerClass()

Explicit Interface Implementations

CanFilterByExpression

Indicates whether the data source crawler can filter items by a string expression like a wild-card filter or SQL Where Clause.

virtual bool CanFilterByExpression { get; }

Returns

bool

CanFilterByTime

Indicates whether the data source crawler can filter items by time using the 'TimeExtent' property.

virtual bool CanFilterByTime { get; }

Returns

bool

CanMergeItems

Indicates whether the crawler is capable of merging related data source items into one composite crawled item.

virtual bool CanMergeItems { get; }

Returns

bool

Crawl(ITrackCancel)

Traverses a data store and returns a enumeration of crawled data source items.

virtual IEnumVariantSimple Crawl(ITrackCancel pTrackCancel)

Parameters

pTrackCancel ITrackCancel

Returns

IEnumVariantSimple

CrawlerItemType

The type of the data source item returned by this crawler.

virtual esriCrawlerDataSourceType CrawlerItemType { get; }

Returns

esriCrawlerDataSourceType

Filter

A string expression that allows the data source crawler to filter out invalid items.

virtual string Filter { get; set; }

Returns

string

FolderSort

The folder sorter object associated with the crawler.

virtual IFolderSort FolderSort { get; set; }

Returns

IFolderSort

GetPaths()

Returns all paths associated with the object.

virtual IStringArray GetPaths()

Returns

IStringArray

GetPathsEx(IItemPathsOptions)

Returns all paths associated with the object.

virtual IStringArray GetPathsEx(IItemPathsOptions pOptions)

Parameters

pOptions IItemPathsOptions

Returns

IStringArray

IDataSourceCrawler2_CanFilterByExpression

virtual bool IDataSourceCrawler2_CanFilterByExpression { get; }

Returns

bool

IDataSourceCrawler2_CanFilterByTime

virtual bool IDataSourceCrawler2_CanFilterByTime { get; }

Returns

bool

IDataSourceCrawler2_Crawl(ITrackCancel)

virtual IEnumVariantSimple IDataSourceCrawler2_Crawl(ITrackCancel pTrackCancel)

Parameters

pTrackCancel ITrackCancel

Returns

IEnumVariantSimple

IDataSourceCrawler2_CrawlerItemType

virtual esriCrawlerDataSourceType IDataSourceCrawler2_CrawlerItemType { get; }

Returns

esriCrawlerDataSourceType

IDataSourceCrawler2_Filter

virtual string IDataSourceCrawler2_Filter { get; set; }

Returns

string

IDataSourceCrawler2_TimeExtent

virtual ITimeExtent IDataSourceCrawler2_TimeExtent { get; set; }

Returns

ITimeExtent

IDataSourceCrawler3_CanFilterByExpression

virtual bool IDataSourceCrawler3_CanFilterByExpression { get; }

Returns

bool

IDataSourceCrawler3_CanFilterByTime

virtual bool IDataSourceCrawler3_CanFilterByTime { get; }

Returns

bool

IDataSourceCrawler3_CanMergeItems

virtual bool IDataSourceCrawler3_CanMergeItems { get; }

Returns

bool

IDataSourceCrawler3_Crawl(ITrackCancel)

virtual IEnumVariantSimple IDataSourceCrawler3_Crawl(ITrackCancel pTrackCancel)

Parameters

pTrackCancel ITrackCancel

Returns

IEnumVariantSimple

IDataSourceCrawler3_CrawlerItemType

virtual esriCrawlerDataSourceType IDataSourceCrawler3_CrawlerItemType { get; }

Returns

esriCrawlerDataSourceType

IDataSourceCrawler3_Filter

virtual string IDataSourceCrawler3_Filter { get; set; }

Returns

string

IDataSourceCrawler3_MergeItems

virtual bool IDataSourceCrawler3_MergeItems { get; set; }

Returns

bool

IDataSourceCrawler3_TimeExtent

virtual ITimeExtent IDataSourceCrawler3_TimeExtent { get; set; }

Returns

ITimeExtent

IFileCrawler2_Path

virtual string IFileCrawler2_Path { get; set; }

Returns

string

IFileCrawler2_Recurse

virtual bool IFileCrawler2_Recurse { get; set; }

Returns

bool

IFileCrawler3_FolderSort

virtual IFolderSort IFileCrawler3_FolderSort { get; set; }

Returns

IFolderSort

IFileCrawler3_Path

virtual string IFileCrawler3_Path { get; set; }

Returns

string

IFileCrawler3_Recurse

virtual bool IFileCrawler3_Recurse { get; set; }

Returns

bool

IItemPaths2_GetPaths()

virtual IStringArray IItemPaths2_GetPaths()

Returns

IStringArray

IItemPaths2_ReplacePaths(IStringArray, IStringArray)

virtual void IItemPaths2_ReplacePaths(IStringArray pOldPaths, IStringArray pNewPaths)

Parameters

pOldPaths IStringArray
pNewPaths IStringArray

MergeItems

Indicates whether the crawler merges related data source items into one composite crawled item.

virtual bool MergeItems { get; set; }

Returns

bool

Path

The file or folder path to crawl.

virtual string Path { get; set; }

Returns

string

Paths

The collection of file- or folder-paths to crawl.

virtual IStringArray Paths { get; set; }

Returns

IStringArray

Properties

Additional properties associated with the data source crawler.

virtual IPropertySet Properties { get; set; }

Returns

IPropertySet

Recurse

Indicates whether folders are recursively traversed.

virtual bool Recurse { get; set; }

Returns

bool

ReplacePaths(IStringArray, IStringArray)

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

virtual void ReplacePaths(IStringArray pOldPaths, IStringArray pNewPaths)

Parameters

pOldPaths IStringArray
pNewPaths IStringArray

TimeExtent

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

virtual ITimeExtent TimeExtent { get; set; }

Returns

ITimeExtent