Purpose:
Content Manager Version 8 allows an administrator to make attributes text-searchable. In addition, the text content in the Resource Manager can also be made text searchable. For such searches to work in an optimal manner, a text search index must be defined. The DKTextIndexICM class holds all the properties of a text search index in Content Manager. It contains set and get methods to set and query this information. It has no interaction with the server itself. An instance of this class may be specified when defining an attribute for a component. If this class is specified, it makes the attribute text searchable. Conversely, setting the value of the instance of this class associated with the attribute to null makes the attribute non text-searchable. An instance of this class can also be used to specify the text index properties for a text resource item type.
Constant to specify text format for indexed documents. TEXT_INDEX_DOC_FORMAT_TEXT = "TEXT"
Constant to specify html format for indexed documents. TEXT_INDEX_DOC_FORMAT_HTML = "HTML"
Constant to specify xml format for indexed documents. TEXT_INDEX_DOC_FORMAT_XML = "XML"
Constant to specify gpp format for indexed documents: TEXT_INDEX_DOC_FORMAT_GPP = "GPP"
Class summary:
class DKEXPORT DKTextIndexDefICM { public: DKTextIndexDefICM(); ~DKTextIndexDefICM(); DKTextIndexDefICM(DKTextIndexDefICM& attr1); long getIndexCCSID(); void setIndexCCSID(long indexCCSID); DKString getIndexLangCode(); void setIndexLangCode(const char* indexLangCode); long getMinChanges(); void setMinChanges(long minChanges); DKString getUpdateFrequency(); void setUpdateFrequency(const char* updateFreq); long getCommitCount(); void setCommitCount(long commitCount); DKString getFormat(); void setFormat(const char* format); DKString getIndexDir(); void setIndexDir(const char* indexDir); DKString getWorkingDir(); void setWorkingDir(const char* workingDir); DKString getModelName(); void setModelName(const char* modelName); DKString getModelFile(); void setModelFile(const char* modelFile); long getModelCCSID(); void setModelCCSID(long modelCCSID); DKString getUDFName(); void setUDFName(const char* udfName); DKString getUDFSchema(); void setUDFSchema(const char* udfSchema); };
Members:
DKTextIndexDefICM()
Default constructor for the component type index class. Constructs the definition of the index class for a component type definition. Copy Constructors
DKTextIndexDefICM(const DKTextIndexDefICM& compIndex)
A copy constructor for component type index definition object. The new instance of the component type index definition will contain all the information copied from the original one.
Parameters: compIndex - a component type index definition object, DKTextIndexDefICM. Destructor
virtual ~DKTextIndexDefICM()
Destructor for this object.
Returns: the CCSID used for building the text index
long getIndexCCSID();
Parameters: indexCCSID - the CCSID that will be used for building this text index
void setIndexCCSID(long indexCCSID);
Returns: the language code for the text index
DKString getIndexLangCode();
Parameters: languageCode - value to set the language code of the text index to
void setIndexLangCode(const char* indexLangCode);
Returns: the minimum number of changes before this text index is updated automatically
long getMinChanges();
Parameters: minChanges - the value to set for the minimum number of changes to occur to the text column before an automatic update of this text index.
void setMinChanges(long minChanges);
Returns: the update frequency for this text index.
DKString getUpdateFrequency();
Parameters: updateFreq - value to set the update frequency for this text index to
void setUpdateFrequency(const char* updateFreq);
Returns: commit count for this text index
long getCommitCount();
Returns: commitCount - new value for the number of rows to process before a commit is executed
void setCommitCount(long commitCount);
Returns: format of the text documents associated with this text index
DKString getFormat();
Parameters: format - new value for the format of text documents associated with this text index
void setFormat(const char* format);
Returns: the name of directory on the server where the index data is stored
DKString getIndexDir();
Parameters: value/name for a directory on the server where the index data is to be stored
void setIndexDir(const char* indexDir);
Returns: the value for the working directory used to store temporary files needed during indexing
DKString getWorkingDir();
Parameters: workingDir - value for the working directory where temporary files created during the indexing process of this text index will be stored
void setWorkingDir(const char* workingDir);
Returns: model name or empty string (if no model is associated with this text index)
DKString getModelName();
Parameters: modelName - name of the model to be associated with this text index
void setModelName(const char* modelName);
Returns: model file for the model associated with this text index or empty string (if there is no model for this text index)
DKString getModelFile();
Parameters: modelFile - value for the model file for the model associated with this text index
void setModelFile(const char* modelFile);
Returns: the CCSID used for building the text index
long getModelCCSID();
Parameters: modelCCSID - value for the CCSID used for the model file
void setModelCCSID(long modelCCSID);
Returns: the name of the UDF (if, any) or an empty string.
DKString getUDFName();
Parameters: udfName - value for the UDF name that will be used to generate indexable content associated with this text index
void setUDFName(const char* udfName);
Returns: udfSchema - value for the UDF schema or empty string (if no defined UDF schema).
DKString getUDFSchema();
Parameters: udfSchema - value for the UDF Schema associated with this text index
void setUDFSchema(const char* udfSchema);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.