com.esri.arcgis.datasourcesraster
Class FolderCrawler

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

All Implemented Interfaces:

IFileCrawler, IItemPaths, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FolderCrawler
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFileCrawler, IItemPaths

A crawler for folders that reside on the file-system.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FolderCrawler()
Constructs a FolderCrawler using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getPath() The file or folder path to crawl.
IStringArray	getPaths() Returns all paths associated with the object.
int	hashCode() the hashcode for this object
boolean	isRecurse() Indicates whether folders are recursively traversed.
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	setPath(String pFileOrFolderPath) The file or folder path 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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

FolderCrawler

public FolderCrawler()
              throws IOException,
                     UnknownHostException

Constructs a FolderCrawler using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FolderCrawler

public FolderCrawler(Object obj)
              throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setPath

public void setPath(String pFileOrFolderPath)
             throws IOException,
                    AutomationException

The file or folder path to crawl.

Product Availability

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

Specified by:

setPath in interface IFileCrawler

Parameters:

pFileOrFolderPath - The pFileOrFolderPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The file or folder path to crawl.

Product Availability

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

Specified by:

getPath in interface IFileCrawler

Returns:

The pFileOrFolderPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecurse

public void setRecurse(boolean pbParseRecursively)
                throws IOException,
                       AutomationException

Indicates whether folders are recursively traversed.

Product Availability

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

Specified by:

setRecurse in interface IFileCrawler

Parameters:

pbParseRecursively - The pbParseRecursively (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecurse

public boolean isRecurse()
                  throws IOException,
                         AutomationException

Indicates whether folders are recursively traversed.

Product Availability

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

Specified by:

isRecurse in interface IFileCrawler

Returns:

The pbParseRecursively

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws IOException,
                             AutomationException

Returns all paths associated with the object.

Product Availability

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

Specified by:

getPaths in interface IItemPaths

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws 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.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.