Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreAdminTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin
        |
        +--com.ibm.mm.sdk.common.DKDatastoreAdminTS
All Implemented Interfaces:
DKConstant, DKConstantDL, dkDatastoreAdmin, DKMessageId, DKMessageIdDL, java.io.Serializable

public class DKDatastoreAdminTS
extends dkAbstractDatastoreAdmin
implements DKConstantDL, DKMessageIdDL

DKDatastoreAdminTS : This class represents and processes datastore administration functions for TS.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Method Summary
 void clearIndex(java.lang.String indexName)
          Clear all indexed terms from a search index.
 void clearScheduledDocuments(java.lang.String indexName)
          Clears the schedule document request queue for the specified index.
 void createDocModel(java.lang.String indexName, DKDocModelTS docModel)
          Create document model
 void deleteDocModel(java.lang.String indexName, int ccsid, java.lang.String docModelName)
          Delete document model
 void deleteIndexingDocMessages(java.lang.String indexName)
          Deletes the indexing messages that can occur while Text Search indexes documents.
 DKDocModelTS getDocModel(java.lang.String indexName, int ccsid, java.lang.String docModelName)
          Get document model
 DKIndexFuncStatusTS getIndexFunctionStatus(java.lang.String indexName, int funcId)
          Get index function status, document and document message queue count for a search index.
 dkCollection getIndexingDocMessages(java.lang.String indexName)
          Gets the indexing messages that can occur while Text Search indexes documents.
 DKIndexingRulesTS getIndexingRules(java.lang.String indexName)
          Gets the default indexing rules that Text Search applies when format, CCSID and language cannot be determined automatically for a document.
 dkCollection listDocModels(java.lang.String indexName)
          List document models
 void reorgIndex(java.lang.String indexName)
          Reorganization remove obsolete information from the index specified, and compresses the information to improve storage utilization and performance
 void setIndexFunctionStatus(java.lang.String indexName, int funcId, int actionId)
          Set indexing function status for a search index.
 void setIndexingRules(DKIndexingRulesTS indexRules)
          Sets the default indexing rules that Text Search applies when format, CCSID and language cannot be determined automatically for a document.
 void startUpdateIndex(java.lang.String indexName)
          Start the indexing process.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin
accessControl, adminDomainsMgmt, authorizationMgmt, clearCache, configurationManagement, getDatastore, setDatastore, userManagement, workFlowManagement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

startUpdateIndex

public void startUpdateIndex(java.lang.String indexName)
                      throws DKException,
                             java.lang.Exception
Start the indexing process.
Parameters:
indexName - the name of the search index.

clearIndex

public void clearIndex(java.lang.String indexName)
                throws DKException,
                       java.lang.Exception
Clear all indexed terms from a search index.
Parameters:
indexName - the name of the search index.

getIndexFunctionStatus

public DKIndexFuncStatusTS getIndexFunctionStatus(java.lang.String indexName,
                                                  int funcId)
                                           throws DKException,
                                                  java.lang.Exception
Get index function status, document and document message queue count for a search index.
Parameters:
indexName - the name of a search index.
funcId - the function id for a text search function.
Returns:
a search index function status object which contains the indexing function status for a text search function.

setIndexFunctionStatus

public void setIndexFunctionStatus(java.lang.String indexName,
                                   int funcId,
                                   int actionId)
                            throws DKException,
                                   java.lang.Exception
Set indexing function status for a search index.
Parameters:
indexName - the name of a search index.
funcId - the function id for a text search function.
actionId - the indicator applied to a text search function. It can be enabled, disabled or reset.

reorgIndex

public void reorgIndex(java.lang.String indexName)
                throws DKException,
                       java.lang.Exception
Reorganization remove obsolete information from the index specified, and compresses the information to improve storage utilization and performance
Parameters:
indexName - the name of a search index.

clearScheduledDocuments

public void clearScheduledDocuments(java.lang.String indexName)
                             throws DKException,
                                    java.lang.Exception
Clears the schedule document request queue for the specified index.
Parameters:
indexName - the name of a search index.

getIndexingRules

public DKIndexingRulesTS getIndexingRules(java.lang.String indexName)
                                   throws DKException,
                                          java.lang.Exception
Gets the default indexing rules that Text Search applies when format, CCSID and language cannot be determined automatically for a document.
Parameters:
indexName - the name of a search index.
Returns:
an indexing rules object which contains the indexing rules for a text search index.

setIndexingRules

public void setIndexingRules(DKIndexingRulesTS indexRules)
                      throws DKException,
                             java.lang.Exception
Sets the default indexing rules that Text Search applies when format, CCSID and language cannot be determined automatically for a document.
Parameters:
indexRules - the indexing rules object which contains the indexing rules for a text search index.

getIndexingDocMessages

public dkCollection getIndexingDocMessages(java.lang.String indexName)
                                    throws DKException,
                                           java.lang.Exception
Gets the indexing messages that can occur while Text Search indexes documents.
Parameters:
indexName - the name of a search index.
Returns:
a collection contain indexing document message objects which contains the indexing message information for a text search index.

deleteIndexingDocMessages

public void deleteIndexingDocMessages(java.lang.String indexName)
                               throws DKException,
                                      java.lang.Exception
Deletes the indexing messages that can occur while Text Search indexes documents.
Parameters:
indexName - the name of a search index.

createDocModel

public void createDocModel(java.lang.String indexName,
                           DKDocModelTS docModel)
                    throws DKException,
                           java.lang.Exception
Create document model
Parameters:
indexName - the name of a search index.
docModel - the document model.

deleteDocModel

public void deleteDocModel(java.lang.String indexName,
                           int ccsid,
                           java.lang.String docModelName)
                    throws DKException,
                           java.lang.Exception
Delete document model
Parameters:
indexName - the name of a search index.
ccsid - the ccsid.
docModelName - document model name.

getDocModel

public DKDocModelTS getDocModel(java.lang.String indexName,
                                int ccsid,
                                java.lang.String docModelName)
                         throws DKException,
                                java.lang.Exception
Get document model
Parameters:
indexName - the name of a search index.
ccsid - the ccsid.
docModelName - document model name.
Returns:
document model object

listDocModels

public dkCollection listDocModels(java.lang.String indexName)
                           throws DKException,
                                  java.lang.Exception
List document models
Parameters:
indexName - the name of a search index.
Returns:
collection of document model objects

EIP Java APIs

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