com.esri.arcgis.datasourcesraster
Class FolderCrawler

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

All Implemented Interfaces:

IFileCrawler, IFileCrawler2, IFileCrawler3, IItemPaths, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class FolderCrawler
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFileCrawler, IFileCrawler2, IFileCrawler3, IItemPaths

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

Description 'A crawler for folders 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.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.IItemPaths

IID, IIDcafd4e87_0672_43e0_b92d_175306c1a309, xxDummy

Constructor Summary

FolderCrawler()
Constructs a FolderCrawler using ArcGIS Engine.

FolderCrawler(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FolderCrawler theFolderCrawler = (FolderCrawler) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IFolderSort	getFolderSort() The folder sorter object associated with the crawler.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getPath() The file or folder path to crawl.
IStringArray	getPaths() The collection of file- or folder-paths to crawl.
int	hashCode() the hashcode for this object
boolean	isRecurse() Indicates whether folders are recursively traversed.
void	release() Release a FolderCrawler.
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	setFolderSortByRef(IFolderSort ppFolderSort) The folder sorter object associated with the crawler.
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	setRecurse(boolean pbParseRecursively) Indicates whether folders are recursively traversed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderCrawler

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

Constructs a FolderCrawler using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FolderCrawler

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FolderCrawler theFolderCrawler = (FolderCrawler) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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

Specified by:

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

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.