com.esri.arcgis.datasourcesraster
Class RasterDatasetCrawler

java.lang.Object
  com.esri.arcgis.datasourcesraster.RasterDatasetCrawler

All Implemented Interfaces:

IDataSourceCrawler, IFileCrawler, IRasterDatasetCrawler, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RasterDatasetCrawler
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, IFileCrawler, IRasterDatasetCrawler

COM Class 'RasterDatasetCrawler'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'A crawler for raster datasets.' 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.IFileCrawler

IID, IIDf8c71017_2a6c_4156_a443_1c33791ccc0a, xxDummy

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

IID, IID31d3dce2_6908_44a1_bec5_0026ec05df76, xxDummy

Constructor Summary

RasterDatasetCrawler()
Constructs a RasterDatasetCrawler using ArcGIS Engine.

RasterDatasetCrawler(java.lang.Object obj)
Construct a RasterDatasetCrawler 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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getCrawlerItemType() The type of the data source item returned by this crawler.
IName	getDatasetName() The name object representing the raster dataset to crawl.
java.lang.String	getFilter() A string expression that allows the data source crawler to filter out invalid items.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getPath() The file or folder path to crawl.
IRasterDataset	getRasterDataset() The raster dataset to crawl.
ITimeExtent	getTimeExtent() The range of allowed time value associated with crawled data source items.
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	isRecurse() Indicates whether folders are recursively traversed.
void	release() Release a RasterDatasetCrawler.
void	setDatasetNameByRef(IName ppDatasetName) The name object representing the raster dataset to crawl.
void	setFilter(java.lang.String pFilter) A string expression that allows the data source crawler to filter out invalid items.
void	setPath(java.lang.String pFileOrFolderPath) The file or folder path to crawl.
void	setRasterDatasetByRef(IRasterDataset ppRasterDataset) The raster dataset to crawl.
void	setRecurse(boolean pbParseRecursively) Indicates whether folders are recursively traversed.
void	setTimeExtentByRef(ITimeExtent ppTimeExtent) The range of allowed time value associated with crawled data source items.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterDatasetCrawler

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

Constructs a RasterDatasetCrawler using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterDatasetCrawler

public RasterDatasetCrawler(java.lang.Object obj)
                     throws java.io.IOException

Construct a RasterDatasetCrawler using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterDatasetCrawler.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems RasterDatasetCrawler theRasterDatasetCrawler = (RasterDatasetCrawler) 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()

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a RasterDatasetCrawler.

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?G?^??

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?G?^??

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.

setPath

public void setPath(java.lang.String pFileOrFolderPath)
             throws java.io.IOException,
                    AutomationException

The file or folder path to crawl.

Specified by:

setPath in interface IFileCrawler

Parameters:

pFileOrFolderPath - The pFileOrFolderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

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

The file or folder path to crawl.

Specified by:

getPath in interface IFileCrawler

Returns:

The pFileOrFolderPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRecurse

public void setRecurse(boolean pbParseRecursively)
                throws java.io.IOException,
                       AutomationException

Indicates whether folders are recursively traversed.

Specified by:

setRecurse in interface IFileCrawler

Parameters:

pbParseRecursively - The pbParseRecursively (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRecurse

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

Indicates whether folders are recursively traversed.

Specified by:

isRecurse in interface IFileCrawler

Returns:

The pbParseRecursively

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterDatasetByRef

public void setRasterDatasetByRef(IRasterDataset ppRasterDataset)
                           throws java.io.IOException,
                                  AutomationException

The raster dataset to crawl.

Specified by:

setRasterDatasetByRef in interface IRasterDatasetCrawler

Parameters:

ppRasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws java.io.IOException,
                                       AutomationException

The raster dataset to crawl.

Specified by:

getRasterDataset in interface IRasterDatasetCrawler

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDatasetNameByRef

public void setDatasetNameByRef(IName ppDatasetName)
                         throws java.io.IOException,
                                AutomationException

The name object representing the raster dataset to crawl.

Specified by:

setDatasetNameByRef in interface IRasterDatasetCrawler

Parameters:

ppDatasetName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetName

public IName getDatasetName()
                     throws java.io.IOException,
                            AutomationException

The name object representing the raster dataset to crawl.

Specified by:

getDatasetName in interface IRasterDatasetCrawler

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.