com.esri.arcgis.search
Class SearchConfiguration

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

All Implemented Interfaces:

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

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

COM Class 'SearchConfiguration'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriSearch.tlb'

Description 'Provides access to members of SearchConfiguration.' 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.search.ISearchConfiguration

IID, IIDee2df519_39a5_48f6_ab24_be147ebdd4bd, xxDummy

Constructor Summary

SearchConfiguration()
Constructs a SearchConfiguration using ArcGIS Engine.

SearchConfiguration(java.lang.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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.lang.String path) Load configuration settings from the specificed location.
void	release() Release a SearchConfiguration.
void	saveToFile(java.lang.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

Constructor Detail

SearchConfiguration

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

Constructs a SearchConfiguration using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SearchConfiguration

public SearchConfiguration(java.lang.Object obj)
                    throws java.io.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:

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

release

public void release()

Release a SearchConfiguration.

Specified by:

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

loadFromFile

public void loadFromFile(java.lang.String path)
                  throws java.io.IOException,
                         AutomationException

Load configuration settings from the specificed location.

Specified by:

loadFromFile in interface ISearchConfiguration

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveToFile

public void saveToFile(java.lang.String path)
                throws java.io.IOException,
                       AutomationException

Save configuration settings to the specificed location.

Specified by:

saveToFile in interface ISearchConfiguration

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServicesCount

public int getServicesCount()
                     throws java.io.IOException,
                            AutomationException

The count of search services.

Specified by:

getServicesCount in interface ISearchConfiguration

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceName

public IAGSServerObjectName getServiceName(int index)
                                    throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

isServiceSelected

public boolean isServiceSelected(IAGSServerObjectName pSON)
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

setIsServiceSelected

public void setIsServiceSelected(IAGSServerObjectName pSON,
                                 boolean bSelected)
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

addServiceName

public void addServiceName(IAGSServerObjectName pSON)
                    throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

deleteServiceName

public void deleteServiceName(IAGSServerObjectName pSON)
                       throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

empty

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

Reset to default value and clean service names array.

Specified by:

empty in interface ISearchConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxResultsPerPage

public int getMaxResultsPerPage()
                         throws java.io.IOException,
                                AutomationException

The maximum number of search result per page.

Specified by:

getMaxResultsPerPage in interface ISearchConfiguration

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxResultsPerPage

public void setMaxResultsPerPage(int pCount)
                          throws java.io.IOException,
                                 AutomationException

The maximum number of search result per page.

Specified by:

setMaxResultsPerPage in interface ISearchConfiguration

Parameters:

pCount - The pCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowPopup

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

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

Specified by:

isShowPopup in interface ISearchConfiguration

Returns:

The pShow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowPopup

public void setShowPopup(boolean pShow)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

setShowPopup in interface ISearchConfiguration

Parameters:

pShow - The pShow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isZoomToSelectedLocation

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

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

Specified by:

isZoomToSelectedLocation in interface ISearchConfiguration

Returns:

The pZoomToSelectedLocation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZoomToSelectedLocation

public void setZoomToSelectedLocation(boolean pZoomToSelectedLocation)
                               throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsWordNet

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

Indicates whether to use the built in WordNet synonyms.

Specified by:

isCheckSynonymsWordNet in interface ISearchConfiguration

Returns:

The pCheckSynonymsWordNet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsWordNet

public void setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether to use the built in WordNet synonyms.

Specified by:

setCheckSynonymsWordNet in interface ISearchConfiguration

Parameters:

pCheckSynonymsWordNet - The pCheckSynonymsWordNet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsUserDefined

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

Indicates whether to use custom synonyms.

Specified by:

isCheckSynonymsUserDefined in interface ISearchConfiguration

Returns:

The pCheckSynonymsUserDefined

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsUserDefined

public void setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to use custom synonyms.

Specified by:

setCheckSynonymsUserDefined in interface ISearchConfiguration

Parameters:

pCheckSynonymsUserDefined - The pCheckSynonymsUserDefined (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

emptySearchOptions

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

Resets the default values of the search options page.

Specified by:

emptySearchOptions in interface ISearchConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

emptyAdvancedOptions

public void emptyAdvancedOptions()
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.