Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSearchEngineInfoDL

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSearchEngineInfoDL
All Implemented Interfaces:
dkExtension, dkSearchEngineInfo, java.io.Serializable

public class DKSearchEngineInfoDL
extends java.lang.Object
implements dkSearchEngineInfo, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKSearchEngineInfoDL()
          Constructs a new DKAnnotationDL object.
DKSearchEngineInfoDL(DKSearchEngineInfoDL aDKSearchEngineInfoDL)
          Copy constructor.
 
Method Summary
 void copyData(DKSearchEngineInfoDL aSourceSrchEngine)
          Copy data member values from the source DKSearchEngineInfoDL object.
 boolean equals(DKSearchEngineInfoDL aDKSearchEngineInfoDL)
          Compares this object with the parameter object.
 java.lang.String getCatalog()
          Gets the catalog name of the QBIC search manager.
 java.lang.String getDataBase()
          Gets the database name of the QBIC search manager.
 java.lang.String getIndexName()
          Gets the search index name of a search server
 java.lang.String getName()
          Gets the name of this extension object
 short getSearchClassId()
          Gets the index class Id of the item in the FRN$SEARCH table.
 java.lang.String getSearchEngine()
          Gets the search engine name.
 java.lang.String getSearchIndex()
          Gets search index, the search index should be a null-terminated string(ASCII).
 int getSearchIndexOption()
          Gets the search index option, based on the option the search program will do queue processing only or do both queue & indexing processing.
 java.lang.String getSearchInfo()
          Gets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie.
 short getSearchState()
          Gets the search indexed state.
 java.lang.String getSearchTimestamp()
          Gets the search Tiemstamp.
 java.lang.String getServerName()
          Gets the server name of the search manager.
 java.lang.String getTextIndex()
          Gets the TextMiner search index name.
 boolean getWakeUpService()
          Gets the flag, if true, it will notify the search program that there is indexing work to be done (by wake up the user exit),
 void setIndexName(java.lang.String indexName)
          Sets the search index name of a search server
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setSearchEngine(java.lang.String aSearchEngineName)
          Sets the search engine name, the search engine should be a null-terminated string(ASCII).
 void setSearchIndex(java.lang.String aSearchIndex)
          Sets search index, the search index should be a null-terminated string(ASCII).
 void setSearchIndexOption(int aSrchIndexOption)
          Sets the search index option, based on the option the search program will do queue processing only or do both queue & indexing processing.
 void setSearchInfo(java.lang.String aLangCode)
          Sets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie.
 void setServerName(java.lang.String serverName)
          Sets the server name of the search manager.
 void setWakeUpService(boolean bCallExtSrch)
          Sets the flag, if true, it will notify the search program that there is indexing work to be done (by wake up the user exit).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKSearchEngineInfoDL

public DKSearchEngineInfoDL()
Constructs a new DKAnnotationDL object.

DKSearchEngineInfoDL

public DKSearchEngineInfoDL(DKSearchEngineInfoDL aDKSearchEngineInfoDL)
Copy constructor.
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setSearchEngine

public void setSearchEngine(java.lang.String aSearchEngineName)
Sets the search engine name, the search engine should be a null-terminated string(ASCII).
Specified by:
setSearchEngine in interface dkSearchEngineInfo
Parameters:
aSearchEngineName - a search engine name

getSearchEngine

public java.lang.String getSearchEngine()
Gets the search engine name.
Specified by:
getSearchEngine in interface dkSearchEngineInfo
Returns:
a search engine name

setSearchIndex

public void setSearchIndex(java.lang.String aSearchIndex)
Sets search index, the search index should be a null-terminated string(ASCII). ie. "SearchService-IndexName" for TextMiner and "DataBase-Catalog-SearchServer" for QBIC.
Specified by:
setSearchIndex in interface dkSearchEngineInfo
Parameters:
aSearchIndex - a search index

getSearchIndex

public java.lang.String getSearchIndex()
Gets search index, the search index should be a null-terminated string(ASCII). ie. "SearchService-IndexName" for TextMiner and "DataBase-Catalog-SearchServer" for QBIC.
Specified by:
getSearchIndex in interface dkSearchEngineInfo
Returns:
a search index

setSearchInfo

public void setSearchInfo(java.lang.String aLangCode)
Sets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie. ENU is US English, JAP is Japanese)
Specified by:
setSearchInfo in interface dkSearchEngineInfo
Parameters:
aLangCode - a three character language code

getSearchInfo

public java.lang.String getSearchInfo()
Gets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie. ENU is US English, JAP is Japanese)
Specified by:
getSearchInfo in interface dkSearchEngineInfo
Returns:
a three character language code

setIndexName

public void setIndexName(java.lang.String indexName)
Sets the search index name of a search server
Specified by:
setIndexName in interface dkSearchEngineInfo
Returns:
a search index name

getIndexName

public java.lang.String getIndexName()
Gets the search index name of a search server
Specified by:
getIndexName in interface dkSearchEngineInfo
Returns:
a search index name

setServerName

public void setServerName(java.lang.String serverName)
Sets the server name of the search manager.
Specified by:
setServerName in interface dkSearchEngineInfo
Parameters:
serverName - a search engine server name

getServerName

public java.lang.String getServerName()
Gets the server name of the search manager.
Specified by:
getServerName in interface dkSearchEngineInfo
Returns:
a search server name

setWakeUpService

public void setWakeUpService(boolean bCallExtSrch)
Sets the flag, if true, it will notify the search program that there is indexing work to be done (by wake up the user exit). This is for TextMiner search.
Parameters:
bCallExtSrch - a boolean flag

getWakeUpService

public boolean getWakeUpService()
Gets the flag, if true, it will notify the search program that there is indexing work to be done (by wake up the user exit),
Returns:
a boolean flag

equals

public boolean equals(DKSearchEngineInfoDL aDKSearchEngineInfoDL)
Compares this object with the parameter object.
Parameters:
aDKSearchEngineInfoDL - a DKSearchEngineInfoDL object
Returns:
a boolean flag, return true if both objects have the same value for each data member.

setSearchIndexOption

public void setSearchIndexOption(int aSrchIndexOption)
Sets the search index option, based on the option the search program will do queue processing only or do both queue & indexing processing. This is for image search only.
Parameters:
aSrchIndexOption - a search index option

getSearchIndexOption

public int getSearchIndexOption()
Gets the search index option, based on the option the search program will do queue processing only or do both queue & indexing processing. This is for image search only.
Returns:
a search index option

getSearchState

public short getSearchState()
Gets the search indexed state.

The valid values are:

Returns:
the search indexed state

getSearchClassId

public short getSearchClassId()
Gets the index class Id of the item in the FRN$SEARCH table.
Returns:
a index class Id

getTextIndex

public java.lang.String getTextIndex()
Gets the TextMiner search index name.
Returns:
a TextMiner search index name

getDataBase

public java.lang.String getDataBase()
Gets the database name of the QBIC search manager.
Returns:
a database name

getCatalog

public java.lang.String getCatalog()
Gets the catalog name of the QBIC search manager.
Returns:
a catalog name

getSearchTimestamp

public java.lang.String getSearchTimestamp()
Gets the search Tiemstamp.
Returns:
the search Tiemstamp

copyData

public void copyData(DKSearchEngineInfoDL aSourceSrchEngine)
Copy data member values from the source DKSearchEngineInfoDL object.
Parameters:
aSourceSrchEngine - a source DKSearchEngineInfoDL object

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.