com.esri.arcgis.datasourcesraster
Class ArrayCrawler

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.ArrayCrawler
All Implemented Interfaces:
IArrayCrawler, IDataSourceCrawler, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ArrayCrawler
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSourceCrawler, IArrayCrawler

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

Description 'A crawler for an array of strings.' 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.IArrayCrawler
IID, IIDa9bd38d7_5e0f_4608_b75c_2ed6ca429c08, xxDummy
 
Constructor Summary
ArrayCrawler()
          Constructs a ArrayCrawler using ArcGIS Engine.
ArrayCrawler(java.lang.Object obj)
          Construct a ArrayCrawler 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.
 IStringArray getDataSourceItems()
          The array of data source items to traverse.
 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.
 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.
 void release()
          Release a ArrayCrawler.
 void setCrawlerItemType(int rhs1)
          The data source type associated with this crawler.
 void setDataSourceItemsByRef(IStringArray ppDataSourceItems)
          The array of data source items to traverse.
 void setFilter(java.lang.String pFilter)
          A string expression that allows the data source crawler to filter out invalid items.
 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

ArrayCrawler

public ArrayCrawler()
             throws java.io.IOException,
                    java.net.UnknownHostException
Constructs a ArrayCrawler using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ArrayCrawler

public ArrayCrawler(java.lang.Object obj)
             throws java.io.IOException
Construct a ArrayCrawler using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArrayCrawler.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems ArrayCrawler theArrayCrawler = (ArrayCrawler) 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 ArrayCrawler.

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.

setCrawlerItemType

public void setCrawlerItemType(int rhs1)
                        throws java.io.IOException,
                               AutomationException
The data source type associated with this crawler.

Specified by:
setCrawlerItemType in interface IArrayCrawler
Parameters:
rhs1 - A com.esri.arcgis.datasourcesraster.esriCrawlerDataSourceType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceItemsByRef

public void setDataSourceItemsByRef(IStringArray ppDataSourceItems)
                             throws java.io.IOException,
                                    AutomationException
The array of data source items to traverse.

Specified by:
setDataSourceItemsByRef in interface IArrayCrawler
Parameters:
ppDataSourceItems - 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.

getDataSourceItems

public IStringArray getDataSourceItems()
                                throws java.io.IOException,
                                       AutomationException
The array of data source items to traverse.

Specified by:
getDataSourceItems in interface IArrayCrawler
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.