com.esri.arcgis.datasourcesraster

Class FileCrawler

java.lang.Object

com.esri.arcgis.datasourcesraster.FileCrawler

All Implemented Interfaces:

IDataSourceCrawler, IDataSourceCrawler2, IDataSourceCrawler3, IFileCrawler, IFileCrawler2, IFileCrawler3, IItemPaths, IItemPaths2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class FileCrawler
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, IDataSourceCrawler2, IDataSourceCrawler3, IFileCrawler, IFileCrawler2, IFileCrawler3, IItemPaths, IItemPaths2

COM Class 'FileCrawler'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A crawler for files that reside on the file-system.' 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.IDataSourceCrawler3

IID, IIDd3602eef_41d9_443f_a38b_a852af177c06, xxDummy

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

IID6585fbde_358f_40a7_8748_79f99b374f5f

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

IIDa1631439_6f80_4ac3_b559_0d1836f6b13a

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

IID, IID4f8a87c6_a3b1_4659_91cd_220d64b8607c, xxDummy

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

IIDa6abd342_be4e_4c34_8322_93f43009e667

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

IIDf8c71017_2a6c_4156_a443_1c33791ccc0a

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

IID, IID9c76b127_61ac_4e66_99b0_8c14a9a386ea, xxDummy

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

IIDcafd4e87_0672_43e0_b92d_175306c1a309

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getFilter() A string expression that allows the data source crawler to filter out invalid items.
IFolderSort	getFolderSort() The folder sorter object associated with the crawler.
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.
java.lang.String	getPath() The file or folder path to crawl.
IStringArray	getPaths() The collection of file- or folder-paths to crawl.
IStringArray	getPathsEx(IItemPathsOptions pOptions) Returns all paths associated with the object.
IPropertySet	getProperties() Additional properties associated with the data source crawler.
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	isCanMergeItems() Indicates whether the crawler is capable of merging related data source items into one composite crawled item.
boolean	isMergeItems() Indicates whether the crawler merges related data source items into one composite crawled item.
boolean	isRecurse() Indicates whether folders are recursively traversed.
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	setFilter(java.lang.String pFilter) A string expression that allows the data source crawler to filter out invalid items.
void	setFolderSortByRef(IFolderSort ppFolderSort) The folder sorter object associated with the crawler.
void	setMergeItems(boolean pbMergeItems) Indicates whether the crawler merges related data source items into one composite crawled item.
void	setPath(java.lang.String pFileOrFolderPath) The file or folder path to crawl.
void	setPathsByRef(IStringArray ppFileOrFolderPaths) The collection of file- or folder-paths to crawl.
void	setPropertiesByRef(IPropertySet ppProperties) Additional properties associated with the data source crawler.
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

FileCrawler

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

Constructs a FileCrawler using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FileCrawler

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

isCanMergeItems

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

Indicates whether the crawler is capable of merging related data source items into one composite crawled item.

Specified by:

isCanMergeItems in interface IDataSourceCrawler2

Returns:

The pbCanMergeItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMergeItems

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

Indicates whether the crawler merges related data source items into one composite crawled item.

Specified by:

isMergeItems in interface IDataSourceCrawler2

Returns:

The pbMergeItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMergeItems

public void setMergeItems(boolean pbMergeItems)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the crawler merges related data source items into one composite crawled item.

Specified by:

setMergeItems in interface IDataSourceCrawler2

Parameters:

pbMergeItems - The pbMergeItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppProperties)
                        throws java.io.IOException,
                               AutomationException

Additional properties associated with the data source crawler.

Specified by:

setPropertiesByRef in interface IDataSourceCrawler3

Parameters:

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

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

Additional properties associated with the data source crawler.

Specified by:

getProperties in interface IDataSourceCrawler3

Returns:

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

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.

setFolderSortByRef

public void setFolderSortByRef(IFolderSort ppFolderSort)
                        throws java.io.IOException,
                               AutomationException

The folder sorter object associated with the crawler.

Specified by:

setFolderSortByRef in interface IFileCrawler2

Parameters:

ppFolderSort - A reference to a com.esri.arcgis.datasourcesraster.IFolderSort (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolderSort

public IFolderSort getFolderSort()
                          throws java.io.IOException,
                                 AutomationException

The folder sorter object associated with the crawler.

Specified by:

getFolderSort in interface IFileCrawler2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPathsByRef

public void setPathsByRef(IStringArray ppFileOrFolderPaths)
                   throws java.io.IOException,
                          AutomationException

The collection of file- or folder-paths to crawl.

Specified by:

setPathsByRef in interface IFileCrawler3

Parameters:

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

getPaths

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

The collection of file- or folder-paths to crawl.

Specified by:

getPaths in interface IFileCrawler3

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.

getPathsEx

public IStringArray getPathsEx(IItemPathsOptions pOptions)
                        throws java.io.IOException,
                               AutomationException

Returns all paths associated with the object.

Specified by:

getPathsEx in interface IItemPaths2

Parameters:

pOptions - A reference to a com.esri.arcgis.datasourcesraster.IItemPathsOptions (in)

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.