com.esri.arcgis.catalogUI
Class FileSystemXmlSearchEngine

java.lang.Object
  extended by com.esri.arcgis.catalogUI.FileSystemXmlSearchEngine
All Implemented Interfaces:
IFileSystemQuery, ISearchEngine, ISearchEngineProperties, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FileSystemXmlSearchEngine
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISearchEngine, ISearchEngineProperties, IFileSystemQuery, IConnectionPointContainer

A search engine that looks on the file system for XML files that match the search criteria.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
FileSystemXmlSearchEngine()
          Constructs a FileSystemXmlSearchEngine using ArcGIS Engine.
FileSystemXmlSearchEngine(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FileSystemXmlSearchEngine theFileSystemXmlSearchEngine = (FileSystemXmlSearchEngine) 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(Object o)
          Compare this object with another
 void executeAsynchronous()
          Executes the query asynchronously.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
static String getClsid()
          getClsid.
 String getLocation()
          Starting location of a search.
 String getLocationString()
          Starting location of a search.
 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.
 boolean isIncludeSubFolders()
          Indicates if subfolders will be searched.
 void load(IPropertySet pPropertySet)
          Loads the search engine properties from the given property set.
 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 setIncludeSubFolders(boolean includeSubFolders)
          Indicates if subfolders will be searched.
 void setLocation(String location)
          Starting location of a search.
 void setLocationString(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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

FileSystemXmlSearchEngine

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

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

FileSystemXmlSearchEngine

public FileSystemXmlSearchEngine(Object obj)
                          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FileSystemXmlSearchEngine theFileSystemXmlSearchEngine = (FileSystemXmlSearchEngine) obj;

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

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

addISearchEngineEventsListener

public void addISearchEngineEventsListener(ISearchEngineEvents theListener)
                                    throws IOException
addISearchEngineEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalogUI.ISearchEngineEvents interface.
Throws:
IOException - If there are communications problems.

removeISearchEngineEventsListener

public void removeISearchEngineEventsListener(ISearchEngineEvents theListener)
                                       throws IOException
removeISearchEngineEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalogUI.ISearchEngineEvents interface.
Throws:
IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the search engine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getName in interface ISearchEngine
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean isEnabled)
                throws IOException,
                       AutomationException
Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates if the search engine is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setQueryByRef

public void setQueryByRef(IQuery rhs1)
                   throws IOException,
                          AutomationException
Query that will be executed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setQueryByRef in interface ISearchEngine
Parameters:
rhs1 - A reference to a com.esri.arcgis.catalog.IQuery (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

executeAsynchronous

public void executeAsynchronous()
                         throws IOException,
                                AutomationException
Executes the query asynchronously.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
executeAsynchronous in interface ISearchEngine
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException
Cancels an ongoing search (if it is currently executing).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
stop in interface ISearchEngine
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExecuting

public boolean isExecuting()
                    throws IOException,
                           AutomationException
Indicates if the search is currently executing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

edit

public void edit(int parentHWnd)
          throws IOException,
                 AutomationException
Opens a dialog box that lets a user set the search engine's properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
edit in interface ISearchEngineProperties
Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException
Loads the search engine properties from the given property set.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

save

public void save(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException
Saves the search engine properties to the given property set.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getLocationString

public String getLocationString()
                         throws IOException,
                                AutomationException
Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getLocationString in interface ISearchEngineProperties
Returns:
The pLocation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationString

public void setLocationString(String pLocation)
                       throws IOException,
                              AutomationException
Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getLocation

public String getLocation()
                   throws IOException,
                          AutomationException
Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getLocation in interface IFileSystemQuery
Returns:
The location
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocation

public void setLocation(String location)
                 throws IOException,
                        AutomationException
Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

isIncludeSubFolders

public boolean isIncludeSubFolders()
                            throws IOException,
                                   AutomationException
Indicates if subfolders will be searched.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isIncludeSubFolders in interface IFileSystemQuery
Returns:
The includeSubFolders
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncludeSubFolders

public void setIncludeSubFolders(boolean includeSubFolders)
                          throws IOException,
                                 AutomationException
Indicates if subfolders will be searched.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

enumConnectionPoints

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

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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