com.esri.arcgis.datasourcesraster
Class ArrayCrawler

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

All Implemented Interfaces:

IArrayCrawler, IDataSourceCrawler, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArrayCrawler
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, IArrayCrawler

A crawler for an array of strings.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArrayCrawler()
Constructs a ArrayCrawler using ArcGIS Engine.

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

Method Summary

IEnumVariantSimple	crawl(ITrackCancel pTrackCancel) Traverses a data store and returns a enumeration of crawled data source items.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCrawlerItemType() The type of the data source item returned by this crawler.
IStringArray	getDataSourceItems() The array of data source items to traverse.
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.
int	hashCode() the hashcode for this object
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	setCrawlerItemType(int rhs1) The data source type associated with this crawler.
void	setDataSourceItemsByRef(IStringArray ppDataSourceItems) The array of data source items to traverse.
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.

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

ArrayCrawler

public ArrayCrawler()
             throws IOException,
                    UnknownHostException

Constructs a ArrayCrawler using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArrayCrawler

public ArrayCrawler(Object obj)
             throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ArrayCrawler theArrayCrawler = (ArrayCrawler) 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

getCrawlerItemType

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

Specified by:

getCrawlerItemType in interface IDataSourceCrawler

Returns:

A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

crawl

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

Specified by:

crawl in interface IDataSourceCrawler

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

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

Specified by:

isCanFilterByTime in interface IDataSourceCrawler

Returns:

The pbCanFilterByTime

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

Specified by:

setTimeExtentByRef in interface IDataSourceCrawler

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

Specified by:

getTimeExtent in interface IDataSourceCrawler

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

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

Specified by:

isCanFilterByExpression in interface IDataSourceCrawler

Returns:

The pbCanFilterByExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilter

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

Specified by:

setFilter in interface IDataSourceCrawler

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

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.

Specified by:

getFilter in interface IDataSourceCrawler

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCrawlerItemType

public void setCrawlerItemType(int rhs1)
                        throws IOException,
                               AutomationException

The data source type associated with this crawler.

Product Availability

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

Specified by:

setCrawlerItemType in interface IArrayCrawler

Parameters:

rhs1 - A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSourceItemsByRef

public void setDataSourceItemsByRef(IStringArray ppDataSourceItems)
                             throws IOException,
                                    AutomationException

The array of data source items to traverse.

Product Availability

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

Specified by:

setDataSourceItemsByRef in interface IArrayCrawler

Parameters:

ppDataSourceItems - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceItems

public IStringArray getDataSourceItems()
                                throws IOException,
                                       AutomationException

The array of data source items to traverse.

Product Availability

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

Specified by:

getDataSourceItems in interface IArrayCrawler

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.