com.esri.arcgis.datasourcesraster
Class TableCrawler

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.TableCrawler
All Implemented Interfaces:
IDataSourceCrawler, ITableCrawler, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TableCrawler
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, ITableCrawler

A cralwer for tables.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TableCrawler()
          Constructs a TableCrawler using ArcGIS Engine.
TableCrawler(Object obj)
          Construct a TableCrawler 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.
 String getFilter()
          A string expression that allows the data source crawler to filter out invalid items.
 String getGroupField()
          The name of the field that contains values that identify groups of related items.
 IQueryFilter getQueryFilter()
          The query filter associated with the specified 'Table'.
 ISelectionSet getSelectionSet()
          The selection set as a source of the data to crawl.
 String getSourceField()
          The name of the field that references the raster dataset.
 ITable getTable()
          The table as a source of the data to crawl.
 ITimeExtent getTimeExtent()
          The range of allowed time value associated with crawled data source items.
 String getTimeStampField()
          The name of the field that contains time stamp value associated with the row.
 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.
 boolean isOrderByGroup()
          Indicates whether the table crawler orders rows by values in the group name field.
 void setCrawlerItemType(int rhs1)
          The type of item returned by the crawler.
 void setFilter(String pFilter)
          A string expression that allows the data source crawler to filter out invalid items.
 void setGroupField(String pGroupField)
          The name of the field that contains values that identify groups of related items.
 void setOrderByGroup(boolean pbOrderByGroup)
          Indicates whether the table crawler orders rows by values in the group name field.
 void setQueryFilterByRef(IQueryFilter ppQueryFilter)
          The query filter associated with the specified 'Table'.
 void setSelectionSetByRef(ISelectionSet ppSelectionSet)
          The selection set as a source of the data to crawl.
 void setSourceField(String pSourceField)
          The name of the field that references the raster dataset.
 void setTableByRef(ITable ppTable)
          The table as a source of the data to crawl.
 void setTimeExtentByRef(ITimeExtent ppTimeExtent)
          The range of allowed time value associated with crawled data source items.
 void setTimeStampField(String pTimeStampField)
          The name of the field that contains time stamp value associated with the row.
 
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

TableCrawler

public TableCrawler()
             throws IOException,
                    UnknownHostException
Constructs a TableCrawler using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TableCrawler

public TableCrawler(Object obj)
             throws IOException
Construct a TableCrawler using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TableCrawler.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems TableCrawler theTableCrawler = (TableCrawler) 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 type of item returned by the crawler.

Product Availability

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

Specified by:
setCrawlerItemType in interface ITableCrawler
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.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws IOException,
                                AutomationException
The query filter associated with the specified 'Table'. Only rows that match the specified filter's criteria are returned by the crawler.

Product Availability

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

Specified by:
setQueryFilterByRef in interface ITableCrawler
Parameters:
ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException
The query filter associated with the specified 'Table'. Only rows that match the specified filter's criteria are returned by the crawler.

Product Availability

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

Specified by:
getQueryFilter in interface ITableCrawler
Returns:
A reference to a com.esri.arcgis.geodatabase.IQueryFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException
The selection set as a source of the data to crawl.

Product Availability

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

Specified by:
setSelectionSetByRef in interface ITableCrawler
Parameters:
ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
The selection set as a source of the data to crawl.

Product Availability

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

Specified by:
getSelectionSet in interface ITableCrawler
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException
The table as a source of the data to crawl.

Product Availability

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

Specified by:
setTableByRef in interface ITableCrawler
Parameters:
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException
The table as a source of the data to crawl.

Product Availability

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

Specified by:
getTable in interface ITableCrawler
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceField

public void setSourceField(String pSourceField)
                    throws IOException,
                           AutomationException
The name of the field that references the raster dataset.

Product Availability

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

Specified by:
setSourceField in interface ITableCrawler
Parameters:
pSourceField - The pSourceField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceField

public String getSourceField()
                      throws IOException,
                             AutomationException
The name of the field that references the raster dataset.

Product Availability

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

Specified by:
getSourceField in interface ITableCrawler
Returns:
The pSourceField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroupField

public void setGroupField(String pGroupField)
                   throws IOException,
                          AutomationException
The name of the field that contains values that identify groups of related items.

Product Availability

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

Specified by:
setGroupField in interface ITableCrawler
Parameters:
pGroupField - The pGroupField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGroupField

public String getGroupField()
                     throws IOException,
                            AutomationException
The name of the field that contains values that identify groups of related items.

Product Availability

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

Specified by:
getGroupField in interface ITableCrawler
Returns:
The pGroupField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeStampField

public void setTimeStampField(String pTimeStampField)
                       throws IOException,
                              AutomationException
The name of the field that contains time stamp value associated with the row.

Product Availability

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

Specified by:
setTimeStampField in interface ITableCrawler
Parameters:
pTimeStampField - The pTimeStampField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeStampField

public String getTimeStampField()
                         throws IOException,
                                AutomationException
The name of the field that contains time stamp value associated with the row.

Product Availability

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

Specified by:
getTimeStampField in interface ITableCrawler
Returns:
The pTimeStampField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrderByGroup

public void setOrderByGroup(boolean pbOrderByGroup)
                     throws IOException,
                            AutomationException
Indicates whether the table crawler orders rows by values in the group name field.

Product Availability

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

Specified by:
setOrderByGroup in interface ITableCrawler
Parameters:
pbOrderByGroup - The pbOrderByGroup (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOrderByGroup

public boolean isOrderByGroup()
                       throws IOException,
                              AutomationException
Indicates whether the table crawler orders rows by values in the group name field.

Product Availability

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

Specified by:
isOrderByGroup in interface ITableCrawler
Returns:
The pbOrderByGroup
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.