com.esri.arcgis.geodatabase

Class FullTextSearchTerm

java.lang.Object

com.esri.arcgis.geodatabase.FullTextSearchTerm

All Implemented Interfaces:

IFullTextSearchTerm, com.esri.arcgis.interop.RemoteObjRef, IClone, java.io.Serializable

public class FullTextSearchTerm
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFullTextSearchTerm, IClone

COM Class 'FullTextSearchTerm'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri FullText Search Term object.' 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.geodatabase.IFullTextSearchTerm

IID, IID6dca7d4b_13f9_45c5_a532_8ebc2d6cd022, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

Constructors

Constructor and Description
FullTextSearchTerm() Constructs a FullTextSearchTerm using ArcGIS Engine.
FullTextSearchTerm(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FullTextSearchTerm theFullTextSearchTerm = (FullTextSearchTerm) obj;

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String fieldName) Adds a field name to array of fields to search against.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
static java.lang.String	getClsid() getClsid.
java.lang.String	getField(int index) The field name at the given index.
int	getFieldCount() The field name count.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getSearchOperator() The boolean operator used between terms in a keyword search.
java.lang.String	getSearchTerm() The search term.
int	getSearchType() The search term modifier to apply against the search term.
java.lang.String	getSearchWhere() The search where clause.
int	hashCode() the hashcode for this object
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	release() Release this COM object reference
void	setSearchOperator(int searchOperator) The boolean operator used between terms in a keyword search.
void	setSearchTerm(java.lang.String searchTerm) The search term.
void	setSearchType(int searchType) The search term modifier to apply against the search term.
void	setSearchWhere(java.lang.String searchWhere) The search where clause.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextSearchTerm

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

Constructs a FullTextSearchTerm using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FullTextSearchTerm

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

addField

public void addField(java.lang.String fieldName)
              throws java.io.IOException,
                     AutomationException

Adds a field name to array of fields to search against.

Specified by:

addField in interface IFullTextSearchTerm

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

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

The field name count.

Specified by:

getFieldCount in interface IFullTextSearchTerm

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

public java.lang.String getField(int index)
                          throws java.io.IOException,
                                 AutomationException

The field name at the given index.

Specified by:

getField in interface IFullTextSearchTerm

Parameters:

index - The index (in)

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchTerm

public void setSearchTerm(java.lang.String searchTerm)
                   throws java.io.IOException,
                          AutomationException

The search term.

Specified by:

setSearchTerm in interface IFullTextSearchTerm

Parameters:

searchTerm - The searchTerm (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTerm

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

The search term.

Specified by:

getSearchTerm in interface IFullTextSearchTerm

Returns:

The searchTerm

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchType

public void setSearchType(int searchType)
                   throws java.io.IOException,
                          AutomationException

The search term modifier to apply against the search term.

Specified by:

setSearchType in interface IFullTextSearchTerm

Parameters:

searchType - A com.esri.arcgis.geodatabase.esriFullTextSearchType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchType

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

The search term modifier to apply against the search term.

Specified by:

getSearchType in interface IFullTextSearchTerm

Returns:

A com.esri.arcgis.geodatabase.esriFullTextSearchType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchWhere

public void setSearchWhere(java.lang.String searchWhere)
                    throws java.io.IOException,
                           AutomationException

The search where clause.

Specified by:

setSearchWhere in interface IFullTextSearchTerm

Parameters:

searchWhere - The searchWhere (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchWhere

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

The search where clause.

Specified by:

getSearchWhere in interface IFullTextSearchTerm

Returns:

The searchWhere

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchOperator

public void setSearchOperator(int searchOperator)
                       throws java.io.IOException,
                              AutomationException

The boolean operator used between terms in a keyword search.

Specified by:

setSearchOperator in interface IFullTextSearchTerm

Parameters:

searchOperator - A com.esri.arcgis.geodatabase.esriFullTextSearchOperator constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchOperator

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

The boolean operator used between terms in a keyword search.

Specified by:

getSearchOperator in interface IFullTextSearchTerm

Returns:

A com.esri.arcgis.geodatabase.esriFullTextSearchOperator constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.