Index

DKTextICM

Purpose:

This class represents text resource objects stored in the resource manager that has been configured for Content Manager Version 8.1. This class inherits from the classes dkResource and DKLobICM. A resource object consists of content stored in a resource manager and the metadata describing the content stored in the Content Manager library server. You can make a text resource object text searchable by creating a text index on the content of the the text resource object.

Following are document properties important for text search:

CCSID: Text documents can be indexed if they are in one of the supported code pages or CCSID (Coded Character Set Identifier). The list of supported CCSIDs is documented in the TIE User's Guide, SH12-6732. The default CCSID is the same CCSID for the underlying database engine.

Format: Supported document formats are Hypertext Markup Language (HTML), Extended Markup Language (XML), flat ASCII (TEXT), and General Purpose Format (GPP). The default format is TEXT. Refer to the TIE User's Guide for further information.

Language code: A complete list of supported language codes are listed in the TIE User's Guide. The default language code is English, EN_US.

Text document model: This property is only required for searching structured documents. It allows you to define the markup tags and their corresponding field names in structured documents like HTML, XML, or GPP. The model defines which fields in the document are indexed and text-searchable. This property enables you to use the markup tags in your text search expressions.

Important: This class represents the four properties, CCSID, format, language code, and model, in each instance. Although these values are saved in the persistent store, they are for information only and are optional. They are not currently used for text indexing purposes. Also, each instance can have different values. Currently, the text indexing process refers to the resource item type definition to get the value of the CCSID, format, language code, and the text document model. The text search process does not use the values stored in each instance. Therefore, all resource item instances defined under the same resource item definition use these same values for building the text index. Content Manager text search supports search on words, terms, free text, search with the Boolean operators AND and OR, search with wildcards, search on words within the same sentence or paragraph (or proximity search), and search on structured documents.

Since:Version 8

Class summary:

class DKEXPORT DKTextICM : public DKLobICM
{
  public:
     DKTextICM();
     DKTextICM(DKDatastoreICM* aDatastore);
     DKTextICM(DKDatastoreICM* aDatastore);
     DKTextICM(DKDatastoreICM* ds, DKByteArray* buf);
     DKTextICM(const DKTextICM& aDKTextICM);
 
     virtual ~DKTextICM();
 
     virtual void setTextSearchableFlag(DKBoolean tieFlag);
     virtual void setLanguageParms(int ccsid, DKString languageCode, DKString format);
     virtual int getCCSID();
     virtual void setCCSID(int ccsid);
     virtual DKBoolean getTextSearchableFlag();
     virtual DKString getLanguageCode();
     virtual void setLanguageCode(DKString dksLangCode);  
     virtual DKString getFormat();
     virtual void setFormat(DKString dksFormat);
     virtual DKString getModel();
     virtual void setModel(DKString  dksModel) ;
};

Members:

Constructors
DKTextICM();
     DKTextICM(DKDatastoreICM* aDatastore);
     DKTextICM(DKDatastoreICM* aDatastore);
     DKTextICM(DKDatastoreICM* ds, DKByteArray* buf);
     DKTextICM(const DKTextICM& aDKTextICM);

Destructor
virtual  ~DKTextICM();

Member functions

setTextSearchableFlag
Sets Text Information Extender re-indexing flag.
void setTextSearchableFlag(DKBoolean tieFlag);

setLanguageParms
Sets the coded character set identifier, language code and the format.
void setLanguageParms(int ccsid, DKString languageCode, DKString format);

getCCSID
Gets the coded character set identifier.
int getCCSID();

getTextSearchableFlag
Gets the Text Information Extender re-indexing flag.
DKBoolean getReIndexFlag();

getLanguageCode
Gets the language code.
DKString getLanguageCode();

getFormat
Gets the text objects format string.
DKString getFormat();

setFormat
Sets the text objects format string.
void setFormat(DKString dksFormat);

getModel
Gets the text document model of this text object. See setModel method for more information. Returns: The document model. Maximum length of the returned value is 30 bytes.
void DKString getModel();

setModel
Sets the text document model for this text object. This method s only relevant if you want to perform structured document search on the content of this text object. It is not applicable for flat ASCII documents. The text format must be one of the structured document format, such as HTML, XML, or GPP. Although this value is saved in the persistent store, it is for informational purposes only and is optional. Currently, it is not being used for text indexing purposes. Also, each instance can have different values. For details see the class description. Parameters: dksmodel - The document model. String with maximum length of 30 bytes.

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