com.esri.arcgis.datasourcesraster

Class TableCrawler

java.lang.Object

com.esri.arcgis.datasourcesraster.TableCrawler

All Implemented Interfaces:

IDataSourceCrawler, IItemPaths, ITableCrawler, ITableCrawler2, ITableCrawler3, com.esri.arcgis.interop.RemoteObjRef, IObjectConstruct, IObjectUpdate, java.io.Serializable

public class TableCrawler
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, ITableCrawler, ITableCrawler2, ITableCrawler3, IItemPaths, IObjectConstruct, IObjectUpdate

COM Class 'TableCrawler'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A crawler for 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IDataSourceCrawler

IID, IIDa1631439_6f80_4ac3_b559_0d1836f6b13a, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ITableCrawler3

IID, IID557a0ce7_5525_4ebf_87e4_cea03954bbae, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ITableCrawler2

IIDc0463461_e1e9_46be_8006_0f6c1f49f8d1

Fields inherited from interface com.esri.arcgis.datasourcesraster.ITableCrawler

IID6e943337_d364_4b76_94cc_f7432305a851

Fields inherited from interface com.esri.arcgis.datasourcesraster.IItemPaths

IID, IIDcafd4e87_0672_43e0_b92d_175306c1a309, xxDummy

Fields inherited from interface com.esri.arcgis.system.IObjectUpdate

IID, IIDd641f414_1004_4e73_9386_f6ea543e2d95, xxDummy

Constructor Summary

Constructors

Constructor and Description
TableCrawler() Constructs a TableCrawler using ArcGIS Engine.
TableCrawler(java.lang.Object obj) Construct a TableCrawler using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
void	construct(IPropertySet props) Two phase object construction.
IEnumVariantSimple	crawl(ITrackCancel pTrackCancel) Traverses a data store and returns a enumeration of crawled data source items.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getBlockField() The name of the field that contains values that identify blocks of related items.
static java.lang.String	getClsid() getClsid.
int	getCrawlerItemType() The type of the data source item returned by this crawler.
java.lang.String	getFilter() A string expression that allows the data source crawler to filter out invalid items.
java.lang.String	getGroupField() The name of the field that contains values that identify groups of related items.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getMaximumMergeItemsCount() The maximum number of crawled rows allowed in a merged record.
IMosaicDataset	getMosaicDataset() The mosaic datset being crawled by the crawler.
IStringArray	getPaths() Returns all paths associated with the object.
IQueryFilter	getQueryFilter() The query filter associated with the specified 'Table'.
IRow	getRow(int oID) Returns the requested row in the table being crawled.
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.
ITimeExtent	getTimeExtent() The range of allowed time value associated with crawled data source items.
java.lang.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	isHasThumbnail() Indicates whether the input mosaic dataset has thumbnail.
boolean	isOrderByGroup() Indicates whether the table crawler orders rows by values in the group name field.
void	release() Release this COM object reference
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	setBlockField(java.lang.String pBlockField) The name of the field that contains values that identify blocks of related items.
void	setCrawlerItemType(int rhs1) The type of item returned by the crawler.
void	setFilter(java.lang.String pFilter) A string expression that allows the data source crawler to filter out invalid items.
void	setGroupField(java.lang.String pGroupField) The name of the field that contains values that identify groups of related items.
void	setMaximumMergeItemsCount(int pMaximumMergeItemsCount) The maximum number of crawled rows allowed in a merged record.
void	setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) The mosaic datset being crawled by the crawler.
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	setTimeExtentByRef(ITimeExtent ppTimeExtent) The range of allowed time value associated with crawled data source items.
void	setTimeStampField(java.lang.String pTimeStampField) The name of the field that contains time stamp value associated with the row.
void	update(IPropertySet props) Updates object's properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableCrawler

public TableCrawler()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a TableCrawler using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TableCrawler

public TableCrawler(java.lang.Object obj)
             throws java.io.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:

java.io.IOException - if there are interop problems TableCrawler theTableCrawler = (TableCrawler) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getCrawlerItemType

public int getCrawlerItemType()
                       throws java.io.IOException,
                              AutomationException

The type of the data source item returned by this crawler.

Specified by:

getCrawlerItemType in interface IDataSourceCrawler

Returns:

A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

crawl

public IEnumVariantSimple crawl(ITrackCancel pTrackCancel)
                         throws java.io.IOException,
                                AutomationException

Traverses a data store and returns a enumeration of crawled data source items.

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:

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

AutomationException - If the ArcObject component throws an exception.

isCanFilterByTime

public boolean isCanFilterByTime()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the data source crawler can filter items by time using the 'TimeExtent' property.

Specified by:

isCanFilterByTime in interface IDataSourceCrawler

Returns:

The pbCanFilterByTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

public void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws java.io.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

Specified by:

setTimeExtentByRef in interface IDataSourceCrawler

Parameters:

ppTimeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeExtent

public ITimeExtent getTimeExtent()
                          throws java.io.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

Specified by:

getTimeExtent in interface IDataSourceCrawler

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanFilterByExpression

public boolean isCanFilterByExpression()
                                throws java.io.IOException,
                                       AutomationException

Indicates whether the data source crawler can filter items by a string expression like a wild-card filter or SQL Where Clause.

Specified by:

isCanFilterByExpression in interface IDataSourceCrawler

Returns:

The pbCanFilterByExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFilter

public void setFilter(java.lang.String pFilter)
               throws java.io.IOException,
                      AutomationException

A string expression that allows the data source crawler to filter out invalid items.

Specified by:

setFilter in interface IDataSourceCrawler

Parameters:

pFilter - The pFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilter

public java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException

A string expression that allows the data source crawler to filter out invalid items.

Specified by:

getFilter in interface IDataSourceCrawler

Returns:

The pFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCrawlerItemType

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

The type of item returned by the crawler.

Specified by:

setCrawlerItemType in interface ITableCrawler

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

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

Specified by:

setQueryFilterByRef in interface ITableCrawler

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

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

Specified by:

getQueryFilter in interface ITableCrawler

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

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

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

Specified by:

setSelectionSetByRef in interface ITableCrawler

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

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

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

Specified by:

getSelectionSet in interface ITableCrawler

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

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

The table as a source of the data to crawl.

Specified by:

setTableByRef in interface ITableCrawler

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

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

The table as a source of the data to crawl.

Specified by:

getTable in interface ITableCrawler

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

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

The name of the field that references the raster dataset.

Specified by:

setSourceField in interface ITableCrawler

Parameters:

pSourceField - The pSourceField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceField

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

The name of the field that references the raster dataset.

Specified by:

getSourceField in interface ITableCrawler

Returns:

The pSourceField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroupField

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

Specified by:

setGroupField in interface ITableCrawler

Parameters:

pGroupField - The pGroupField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGroupField

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

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

Specified by:

getGroupField in interface ITableCrawler

Returns:

The pGroupField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeStampField

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

Specified by:

setTimeStampField in interface ITableCrawler

Parameters:

pTimeStampField - The pTimeStampField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeStampField

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

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

Specified by:

getTimeStampField in interface ITableCrawler

Returns:

The pTimeStampField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOrderByGroup

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

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

Specified by:

setOrderByGroup in interface ITableCrawler

Parameters:

pbOrderByGroup - The pbOrderByGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOrderByGroup

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

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

Specified by:

isOrderByGroup in interface ITableCrawler

Returns:

The pbOrderByGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBlockField

public void setBlockField(java.lang.String pBlockField)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

setBlockField in interface ITableCrawler2

Parameters:

pBlockField - The pBlockField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBlockField

public java.lang.String getBlockField()
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

getBlockField in interface ITableCrawler2

Returns:

The pBlockField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumMergeItemsCount

public void setMaximumMergeItemsCount(int pMaximumMergeItemsCount)
                               throws java.io.IOException,
                                      AutomationException

The maximum number of crawled rows allowed in a merged record.

Specified by:

setMaximumMergeItemsCount in interface ITableCrawler2

Parameters:

pMaximumMergeItemsCount - The pMaximumMergeItemsCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumMergeItemsCount

public int getMaximumMergeItemsCount()
                              throws java.io.IOException,
                                     AutomationException

The maximum number of crawled rows allowed in a merged record.

Specified by:

getMaximumMergeItemsCount in interface ITableCrawler2

Returns:

The pMaximumMergeItemsCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMosaicDatasetByRef

public void setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
                           throws java.io.IOException,
                                  AutomationException

The mosaic datset being crawled by the crawler.

Specified by:

setMosaicDatasetByRef in interface ITableCrawler2

Parameters:

ppMosaicDataset - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMosaicDataset

public IMosaicDataset getMosaicDataset()
                                throws java.io.IOException,
                                       AutomationException

The mosaic datset being crawled by the crawler.

Specified by:

getMosaicDataset in interface ITableCrawler2

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasThumbnail

public boolean isHasThumbnail()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the input mosaic dataset has thumbnail.

Specified by:

isHasThumbnail in interface ITableCrawler2

Returns:

The pbHasThumbnail

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException

Returns the requested row in the table being crawled.

Specified by:

getRow in interface ITableCrawler3

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws java.io.IOException,
                             AutomationException

Returns all paths associated with the object.

Specified by:

getPaths in interface IItemPaths

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws java.io.IOException,
                         AutomationException

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

Specified by:

replacePaths in interface IItemPaths

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws java.io.IOException,
                      AutomationException

Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IPropertySet props)
            throws java.io.IOException,
                   AutomationException

Updates object's properties.

Specified by:

update in interface IObjectUpdate

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.