com.esri.arcgis.datasourcesraster
Interface ITableCrawler

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITableCrawler2

All Known Implementing Classes:

ITableCrawlerProxy, TableCrawler

public interface ITableCrawler
extends Serializable

Provides access to members that control a crawler capable of traversing tables.

Product Availability

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

Method Summary

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.
String	getTimeStampField() The name of the field that contains time stamp value associated with the row.
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	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	setTimeStampField(String pTimeStampField) The name of the field that contains time stamp value associated with the row.

Method Detail

setCrawlerItemType

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Parameters:

pSourceField - The pSourceField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceField

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.

Returns:

The pSourceField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupField

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.

Parameters:

pGroupField - The pGroupField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupField

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.

Returns:

The pGroupField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeStampField

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.

Parameters:

pTimeStampField - The pTimeStampField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeStampField

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.

Returns:

The pTimeStampField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderByGroup

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.

Parameters:

pbOrderByGroup - The pbOrderByGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOrderByGroup

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.

Returns:

The pbOrderByGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.