com.esri.arcgis.search
Class SearchConfiguration

java.lang.Object
  com.esri.arcgis.search.SearchConfiguration

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISearchConfiguration, Serializable

public class SearchConfiguration
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISearchConfiguration

Provides access to members of SearchConfiguration.

See Also:

Serialized Form

Constructor Summary

SearchConfiguration()
Constructs a SearchConfiguration using ArcGIS Engine.

SearchConfiguration(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SearchConfiguration theSearchConfiguration = (SearchConfiguration) obj;

Method Summary

void	addServiceName(IAGSServerObjectName pSON) Add search service name.
void	deleteServiceName(IAGSServerObjectName pSON) Delete search service name.
void	empty() Reset to default value and clean service names array.
void	emptyAdvancedOptions() Resets the default values of the advanced options page and cleans the array of service names.
void	emptySearchOptions() Resets the default values of the search options page.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getMaxResultsPerPage() The maximum number of search result per page.
IAGSServerObjectName	getServiceName(int index) The search service object name at the specified index.
int	getServicesCount() The count of search services.
int	hashCode() the hashcode for this object
boolean	isCheckSynonymsUserDefined() Indicates whether to use custom synonyms.
boolean	isCheckSynonymsWordNet() Indicates whether to use the built in WordNet synonyms.
boolean	isServiceSelected(IAGSServerObjectName pSON) Indicates whether a service is selected.
boolean	isShowPopup() Indicates whether to show pop-up in search result page.
boolean	isZoomToSelectedLocation() Indicates whether to zoom to the select text based spatial search location.
void	loadFromFile(String path) Load configuration settings from the specificed location.
void	saveToFile(String path) Save configuration settings to the specificed location.
void	setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined) Indicates whether to use custom synonyms.
void	setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet) Indicates whether to use the built in WordNet synonyms.
void	setIsServiceSelected(IAGSServerObjectName pSON, boolean bSelected) Indicates whether a service is selected.
void	setMaxResultsPerPage(int pCount) The maximum number of search result per page.
void	setShowPopup(boolean pShow) Indicates whether to show pop-up in search result page.
void	setZoomToSelectedLocation(boolean pZoomToSelectedLocation) Indicates whether to zoom to the select text based spatial search location.

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

SearchConfiguration

public SearchConfiguration()
                    throws IOException,
                           UnknownHostException

Constructs a SearchConfiguration using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SearchConfiguration

public SearchConfiguration(Object obj)
                    throws IOException

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

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

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

loadFromFile

public void loadFromFile(String path)
                  throws IOException,
                         AutomationException

Load configuration settings from the specificed location.

Specified by:

loadFromFile in interface ISearchConfiguration

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

public void saveToFile(String path)
                throws IOException,
                       AutomationException

Save configuration settings to the specificed location.

Specified by:

saveToFile in interface ISearchConfiguration

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServicesCount

public int getServicesCount()
                     throws IOException,
                            AutomationException

The count of search services.

Specified by:

getServicesCount in interface ISearchConfiguration

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceName

public IAGSServerObjectName getServiceName(int index)
                                    throws IOException,
                                           AutomationException

The search service object name at the specified index.

Specified by:

getServiceName in interface ISearchConfiguration

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isServiceSelected

public boolean isServiceSelected(IAGSServerObjectName pSON)
                          throws IOException,
                                 AutomationException

Indicates whether a service is selected.

Specified by:

isServiceSelected in interface ISearchConfiguration

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

The bSelected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsServiceSelected

public void setIsServiceSelected(IAGSServerObjectName pSON,
                                 boolean bSelected)
                          throws IOException,
                                 AutomationException

Indicates whether a service is selected.

Specified by:

setIsServiceSelected in interface ISearchConfiguration

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

bSelected - The bSelected (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addServiceName

public void addServiceName(IAGSServerObjectName pSON)
                    throws IOException,
                           AutomationException

Add search service name.

Specified by:

addServiceName in interface ISearchConfiguration

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteServiceName

public void deleteServiceName(IAGSServerObjectName pSON)
                       throws IOException,
                              AutomationException

Delete search service name.

Specified by:

deleteServiceName in interface ISearchConfiguration

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Reset to default value and clean service names array.

Specified by:

empty in interface ISearchConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxResultsPerPage

public int getMaxResultsPerPage()
                         throws IOException,
                                AutomationException

The maximum number of search result per page.

Specified by:

getMaxResultsPerPage in interface ISearchConfiguration

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxResultsPerPage

public void setMaxResultsPerPage(int pCount)
                          throws IOException,
                                 AutomationException

The maximum number of search result per page.

Specified by:

setMaxResultsPerPage in interface ISearchConfiguration

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowPopup

public boolean isShowPopup()
                    throws IOException,
                           AutomationException

Indicates whether to show pop-up in search result page.

Specified by:

isShowPopup in interface ISearchConfiguration

Returns:

The pShow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowPopup

public void setShowPopup(boolean pShow)
                  throws IOException,
                         AutomationException

Indicates whether to show pop-up in search result page.

Specified by:

setShowPopup in interface ISearchConfiguration

Parameters:

pShow - The pShow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZoomToSelectedLocation

public boolean isZoomToSelectedLocation()
                                 throws IOException,
                                        AutomationException

Indicates whether to zoom to the select text based spatial search location.

Specified by:

isZoomToSelectedLocation in interface ISearchConfiguration

Returns:

The pZoomToSelectedLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomToSelectedLocation

public void setZoomToSelectedLocation(boolean pZoomToSelectedLocation)
                               throws IOException,
                                      AutomationException

Indicates whether to zoom to the select text based spatial search location.

Specified by:

setZoomToSelectedLocation in interface ISearchConfiguration

Parameters:

pZoomToSelectedLocation - The pZoomToSelectedLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsWordNet

public boolean isCheckSynonymsWordNet()
                               throws IOException,
                                      AutomationException

Indicates whether to use the built in WordNet synonyms.

Specified by:

isCheckSynonymsWordNet in interface ISearchConfiguration

Returns:

The pCheckSynonymsWordNet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsWordNet

public void setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet)
                             throws IOException,
                                    AutomationException

Indicates whether to use the built in WordNet synonyms.

Specified by:

setCheckSynonymsWordNet in interface ISearchConfiguration

Parameters:

pCheckSynonymsWordNet - The pCheckSynonymsWordNet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsUserDefined

public boolean isCheckSynonymsUserDefined()
                                   throws IOException,
                                          AutomationException

Indicates whether to use custom synonyms.

Specified by:

isCheckSynonymsUserDefined in interface ISearchConfiguration

Returns:

The pCheckSynonymsUserDefined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsUserDefined

public void setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined)
                                 throws IOException,
                                        AutomationException

Indicates whether to use custom synonyms.

Specified by:

setCheckSynonymsUserDefined in interface ISearchConfiguration

Parameters:

pCheckSynonymsUserDefined - The pCheckSynonymsUserDefined (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

emptySearchOptions

public void emptySearchOptions()
                        throws IOException,
                               AutomationException

Resets the default values of the search options page.

Specified by:

emptySearchOptions in interface ISearchConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

emptyAdvancedOptions

public void emptyAdvancedOptions()
                          throws IOException,
                                 AutomationException

Resets the default values of the advanced options page and cleans the array of service names.

Specified by:

emptyAdvancedOptions in interface ISearchConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.