com.esri.arcgis.catalogUI
Class CatalogSearchEngine

java.lang.Object
  com.esri.arcgis.catalogUI.CatalogSearchEngine

All Implemented Interfaces:

ISearchEngine, ISearchEngineProperties, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class CatalogSearchEngine
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISearchEngine, ISearchEngineProperties, IConnectionPointContainer

COM Class 'CatalogSearchEngine'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description 'A search engine that looks in the Catalog for objects that match the search criteria.' 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.catalogUI.ISearchEngine

IID, IIDd18306a2_9d3c_11d3_a6cb_0008c7d3ae50, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.ISearchEngineProperties

IID, IIDb46f085c_db78_4862_a391_fcfdc92c62cb, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

CatalogSearchEngine()
Constructs a CatalogSearchEngine using ArcGIS Engine.

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

Method Summary

void	addISearchEngineEventsListener(ISearchEngineEvents theListener) addISearchEngineEventsListener.
void	edit(int parentHWnd) Opens a dialog box that lets a user set the search engine's properties.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	executeAsynchronous() Executes the query asynchronously.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLocationString() Starting location of a search.
java.lang.String	getName() Name of the search engine.
int	hashCode() the hashcode for this object
boolean	isEnabled() Indicates if the search engine is enabled.
boolean	isExecuting() Indicates if the search is currently executing.
void	load(IPropertySet pPropertySet) Loads the search engine properties from the given property set.
void	release() Release a CatalogSearchEngine.
void	removeISearchEngineEventsListener(ISearchEngineEvents theListener) removeISearchEngineEventsListener.
void	save(IPropertySet pPropertySet) Saves the search engine properties to the given property set.
void	setEnabled(boolean isEnabled) Indicates if the search engine is enabled.
void	setLocationString(java.lang.String pLocation) Starting location of a search.
void	setQueryByRef(IQuery rhs1) Query that will be executed.
void	stop() Cancels an ongoing search (if it is currently executing).

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogSearchEngine

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

Constructs a CatalogSearchEngine using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CatalogSearchEngine

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

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

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

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

addISearchEngineEventsListener

public void addISearchEngineEventsListener(ISearchEngineEvents theListener)
                                    throws java.io.IOException

addISearchEngineEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalogUI.ISearchEngineEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeISearchEngineEventsListener

public void removeISearchEngineEventsListener(ISearchEngineEvents theListener)
                                       throws java.io.IOException

removeISearchEngineEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalogUI.ISearchEngineEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a CatalogSearchEngine.

Specified by:

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the search engine.

Specified by:

getName in interface ISearchEngine

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean isEnabled)
                throws java.io.IOException,
                       AutomationException

Indicates if the search engine is enabled.

Specified by:

setEnabled in interface ISearchEngine

Parameters:

isEnabled - The isEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Indicates if the search engine is enabled.

Specified by:

isEnabled in interface ISearchEngine

Returns:

The isEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryByRef

public void setQueryByRef(IQuery rhs1)
                   throws java.io.IOException,
                          AutomationException

Query that will be executed.

Specified by:

setQueryByRef in interface ISearchEngine

Parameters:

rhs1 - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeAsynchronous

public void executeAsynchronous()
                         throws java.io.IOException,
                                AutomationException

Executes the query asynchronously.

Specified by:

executeAsynchronous in interface ISearchEngine

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws java.io.IOException,
                 AutomationException

Cancels an ongoing search (if it is currently executing).

Specified by:

stop in interface ISearchEngine

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExecuting

public boolean isExecuting()
                    throws java.io.IOException,
                           AutomationException

Indicates if the search is currently executing.

Specified by:

isExecuting in interface ISearchEngine

Returns:

The isExecuting

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int parentHWnd)
          throws java.io.IOException,
                 AutomationException

Opens a dialog box that lets a user set the search engine's properties.

Specified by:

edit in interface ISearchEngineProperties

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IPropertySet pPropertySet)
          throws java.io.IOException,
                 AutomationException

Loads the search engine properties from the given property set.

Specified by:

load in interface ISearchEngineProperties

Parameters:

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IPropertySet pPropertySet)
          throws java.io.IOException,
                 AutomationException

Saves the search engine properties to the given property set.

Specified by:

save in interface ISearchEngineProperties

Parameters:

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationString

public java.lang.String getLocationString()
                                   throws java.io.IOException,
                                          AutomationException

Starting location of a search.

Specified by:

getLocationString in interface ISearchEngineProperties

Returns:

The pLocation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationString

public void setLocationString(java.lang.String pLocation)
                       throws java.io.IOException,
                              AutomationException

Starting location of a search.

Specified by:

setLocationString in interface ISearchEngineProperties

Parameters:

pLocation - The pLocation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.