com.esri.arcgis.datasourcesraster
Class IDataSourceCrawlerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.IDataSourceCrawlerProxy

All Implemented Interfaces:

IDataSourceCrawler, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

IDataSourceCrawler2Proxy

public class IDataSourceCrawlerProxy
extends com.esri.arcgis.interop.Dispatch
implements IDataSourceCrawler, java.io.Serializable

Internal use class Proxy for COM Interface 'IDataSourceCrawler'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control a data source crawler.' 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

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IIDa1631439_6f80_4ac3_b559_0d1836f6b13a

Constructor Summary

	IDataSourceCrawlerProxy() For internal use only
	IDataSourceCrawlerProxy(java.lang.Object obj)
protected	IDataSourceCrawlerProxy(java.lang.Object obj, java.lang.String iid)
	IDataSourceCrawlerProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IDataSourceCrawlerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
IEnumVariantSimple	crawl(ITrackCancel pTrackCancel) Traverses a data store and returns a enumeration of crawled data source items.
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.
ITimeExtent	getTimeExtent() The range of allowed time value associated with crawled data source items.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener)
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 com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IDataSourceCrawlerProxy

public IDataSourceCrawlerProxy(java.lang.String CLSID,
                               java.lang.String host,
                               com.esri.arcgis.interop.AuthInfo authInfo)
                        throws java.net.UnknownHostException,
                               java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IDataSourceCrawlerProxy

public IDataSourceCrawlerProxy()

For internal use only

IDataSourceCrawlerProxy

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

Throws:

java.io.IOException

IDataSourceCrawlerProxy

protected IDataSourceCrawlerProxy(java.lang.Object obj,
                                  java.lang.String iid)
                           throws java.io.IOException

Throws:

java.io.IOException

IDataSourceCrawlerProxy

protected IDataSourceCrawlerProxy(java.lang.String CLSID,
                                  java.lang.String iid,
                                  java.lang.String host,
                                  com.esri.arcgis.interop.AuthInfo authInfo)
                           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

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.