com.esri.arcgis.datasourcesraster
Interface IDataSourceCrawler

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IDataSourceCrawler2, IDataSourceCrawler3

All Known Implementing Classes:

ArrayCrawler, CsvCrawler, FileCrawler, GenericObjectCrawler, IDataSourceCrawler2Proxy, IDataSourceCrawler3Proxy, IDataSourceCrawlerProxy, IkonosFileCrawler, KompsatFileCrawler, NitfCrawler, PixFileCrawler, PleiadesFileCrawler, QuickBirdFileCrawler, RasterDatasetCrawler, ScientificDataCrawler, Spot6FileCrawler, TableCrawler

public interface IDataSourceCrawler
extends java.io.Serializable

COM Interface 'IDataSourceCrawler'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control a data source crawler.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDa1631439_6f80_4ac3_b559_0d1836f6b13a
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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(java.lang.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.

Field Detail

IIDa1631439_6f80_4ac3_b559_0d1836f6b13a

static final int IIDa1631439_6f80_4ac3_b559_0d1836f6b13a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getCrawlerItemType

int getCrawlerItemType()
                       throws java.io.IOException,
                              AutomationException

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

Returns:

A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

crawl

IEnumVariantSimple crawl(ITrackCancel pTrackCancel)
                         throws java.io.IOException,
                                AutomationException

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

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanFilterByTime

boolean isCanFilterByTime()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The pbCanFilterByTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws java.io.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?G?^??

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeExtent

ITimeExtent getTimeExtent()
                          throws java.io.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?G?^??

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanFilterByExpression

boolean isCanFilterByExpression()
                                throws java.io.IOException,
                                       AutomationException

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

Returns:

The pbCanFilterByExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFilter

void setFilter(java.lang.String pFilter)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

pFilter - The pFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilter

java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException

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

Returns:

The pFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.