com.esri.arcgis.datasourcesraster
Class ITableCrawlerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.ITableCrawlerProxy

All Implemented Interfaces:

ITableCrawler, Externalizable, Serializable

public class ITableCrawlerProxy
extends com.esri.arcgis.interop.Dispatch
implements ITableCrawler, Serializable

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

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITableCrawlerProxy()
	ITableCrawlerProxy(Object obj)
protected	ITableCrawlerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITableCrawlerProxy

public ITableCrawlerProxy()

ITableCrawlerProxy

public ITableCrawlerProxy(Object obj)
                   throws IOException

Throws:

IOException

ITableCrawlerProxy

protected ITableCrawlerProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.