com.esri.arcgis.datasourcesraster
Class FileCrawler

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.FileCrawler
All Implemented Interfaces:
IDataSourceCrawler, IFileCrawler, IItemPaths, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

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

Product Availability

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

See Also:
Serialized Form

Constructor Summary
FileCrawler()
          Constructs a FileCrawler using ArcGIS Engine.
FileCrawler(Object obj)
          Construct a FileCrawler 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(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getCrawlerItemType()
          The type of the data source item returned by this crawler.
 String getFilter()
          A string expression that allows the data source crawler to filter out invalid items.
 String getPath()
          The file or folder path to crawl.
 IStringArray getPaths()
          Returns all paths associated with the object.
 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 replacePaths(IStringArray pOldPaths, IStringArray pNewPaths)
          Updates all paths associated with the object using the specified mapping rule.
 void setFilter(String pFilter)
          A string expression that allows the data source crawler to filter out invalid items.
 void setPath(String pFileOrFolderPath)
          The file or folder path 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

FileCrawler

public FileCrawler()
            throws IOException,
                   UnknownHostException
Constructs a FileCrawler using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

FileCrawler

public FileCrawler(Object obj)
            throws 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:
IOException - if there are interop problems FileCrawler theFileCrawler = (FileCrawler) obj;
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

getCrawlerItemType

public int getCrawlerItemType()
                       throws IOException,
                              AutomationException
The type of the data source item returned by this crawler.

Product Availability

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

Specified by:
getCrawlerItemType in interface IDataSourceCrawler
Returns:
A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

crawl

public IEnumVariantSimple crawl(ITrackCancel pTrackCancel)
                         throws IOException,
                                AutomationException
Traverses a data store and returns a enumeration of crawled data source items.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanFilterByTime

public boolean isCanFilterByTime()
                          throws IOException,
                                 AutomationException
Indicates whether the data source crawler can filter items by time using the 'TimeExtent' property.

Product Availability

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

Specified by:
isCanFilterByTime in interface IDataSourceCrawler
Returns:
The pbCanFilterByTime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

public void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws 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????&

Product Availability

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

Specified by:
setTimeExtentByRef in interface IDataSourceCrawler
Parameters:
ppTimeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeExtent

public ITimeExtent getTimeExtent()
                          throws 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????&

Product Availability

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

Specified by:
getTimeExtent in interface IDataSourceCrawler
Returns:
A reference to a com.esri.arcgis.system.ITimeExtent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanFilterByExpression

public boolean isCanFilterByExpression()
                                throws IOException,
                                       AutomationException
Indicates whether the data source crawler can filter items by a string expression like a wild-card filter or SQL Where Clause.

Product Availability

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

Specified by:
isCanFilterByExpression in interface IDataSourceCrawler
Returns:
The pbCanFilterByExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilter

public void setFilter(String pFilter)
               throws IOException,
                      AutomationException
A string expression that allows the data source crawler to filter out invalid items.

Product Availability

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

Specified by:
setFilter in interface IDataSourceCrawler
Parameters:
pFilter - The pFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException
A string expression that allows the data source crawler to filter out invalid items.

Product Availability

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

Specified by:
getFilter in interface IDataSourceCrawler
Returns:
The pFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

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.