com.esri.arcgis.datasourcesraster

Interface ITableCrawler

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITableCrawler2, ITableCrawler3

All Known Implementing Classes:

ITableCrawler2Proxy, ITableCrawler3Proxy, ITableCrawlerProxy, TableCrawler

public interface ITableCrawler
extends java.io.Serializable

COM Interface 'ITableCrawler'. Generated 9/21/2023 10:01:49 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control a crawler capable of traversing tables.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID6e943337_d364_4b76_94cc_f7432305a851
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.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.
java.lang.String	getSourceField() The name of the field that references the raster dataset.
ITable	getTable() The table as a source of the data to crawl.
java.lang.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(java.lang.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(java.lang.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(java.lang.String pTimeStampField) The name of the field that contains time stamp value associated with the row.

Field Detail

IID6e943337_d364_4b76_94cc_f7432305a851

static final int IID6e943337_d364_4b76_94cc_f7432305a851

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

setCrawlerItemType

void setCrawlerItemType(int rhs1)
                 throws java.io.IOException,
                        AutomationException

The type of item returned by the crawler.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                  throws java.io.IOException,
                         AutomationException

The query filter associated with the specified 'Table'. Only rows that match the specified filter's criteria are returned by the crawler.

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

IQueryFilter getQueryFilter()
                     throws java.io.IOException,
                            AutomationException

The query filter associated with the specified 'Table'. Only rows that match the specified filter's criteria are returned by the crawler.

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                   throws java.io.IOException,
                          AutomationException

The selection set as a source of the data to crawl.

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

ISelectionSet getSelectionSet()
                       throws java.io.IOException,
                              AutomationException

The selection set as a source of the data to crawl.

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTableByRef

void setTableByRef(ITable ppTable)
            throws java.io.IOException,
                   AutomationException

The table as a source of the data to crawl.

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTable

ITable getTable()
         throws java.io.IOException,
                AutomationException

The table as a source of the data to crawl.

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSourceField

void setSourceField(java.lang.String pSourceField)
             throws java.io.IOException,
                    AutomationException

The name of the field that references the raster dataset.

Parameters:

pSourceField - The pSourceField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceField

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

The name of the field that references the raster dataset.

Returns:

The pSourceField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroupField

void setGroupField(java.lang.String pGroupField)
            throws java.io.IOException,
                   AutomationException

The name of the field that contains values that identify groups of related items.

Parameters:

pGroupField - The pGroupField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGroupField

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

The name of the field that contains values that identify groups of related items.

Returns:

The pGroupField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeStampField

void setTimeStampField(java.lang.String pTimeStampField)
                throws java.io.IOException,
                       AutomationException

The name of the field that contains time stamp value associated with the row.

Parameters:

pTimeStampField - The pTimeStampField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeStampField

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

The name of the field that contains time stamp value associated with the row.

Returns:

The pTimeStampField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOrderByGroup

void setOrderByGroup(boolean pbOrderByGroup)
              throws java.io.IOException,
                     AutomationException

Indicates whether the table crawler orders rows by values in the group name field.

Parameters:

pbOrderByGroup - The pbOrderByGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOrderByGroup

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

Indicates whether the table crawler orders rows by values in the group name field.

Returns:

The pbOrderByGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.