Index

DXIndexInfoTS

Purpose:

This class is used to hold information about a text search index. The field in the class mirrors the field specified in the Text Search Engine System Administration Panel for an index.

Methods:

getIndexName
      String getIndexName();
 

Gets the index name.

setIndexName
      setIndexName(String indexName);
 

Sets the index name. The indexName is the name of a text search index.

getIndexType
      long getIndexType();     // DX_TS_Index_Type_Linguistic, 
                               // DX_TS_Index_Type_Precise, or DX_TS_Index_Type_GTR
 

Gets the index type. This will return DX_TS_Index_Type_Linguistic, DX_TS_Index_Type_Precise or DX_TS_Index_Type_GTR.

setIndexType
      setIndexType(long indexType);
 

Sets the index type. The indexType is the name of a text search index type. The index types are DX_TS_Index_Type_Linguistic, DX_TS_Index_Type_Precise or DX_TS_Index_Type_GTR.

getIndexFeature
      long getIndexFeature();     // DX_TS_Index_Feature for Lingusitic or 
                                  // DX_TS_Index_Feature_Case_Enabled for GTR
 

Gets the index feature. This will return DX_TS_Index_Feature_Case_Enabled for GTR.

setIndexFeature
      setIndexFeature(long indexFeature);
 

Sets the index feature. The indexFeature is the name of a text search index feature. The index feature is DX_TS_Index_Feature_Case_Enabled for GTR.

getIndexCCSID
      long getIndexCCSID();
 

Gets the index CCSID (coded character set ID).

setIndexCCSID
      setIndexCCSID(long indexCCSID);
 

Sets the index CCSID (coded character set ID). The indexCCSID is the CCSID for a text search index.

getLibraryId
      String getLibraryID();     // library ID for text search index
 

Gets the library ID.

setLibraryId
      setLibraryID(String libID);
 

Sets the library ID. The libId is the name of a library ID for a text search index.

getLibraryClientServices
      String getLibraryClientServices();
 

Gets the library client services.

setLibraryClientServices
      setLibraryClientServices(String libClientServices);
 

Sets the library client services. The libClientServices is the name of a library client services for a text search index.

getLibraryServerServices
      String getLibraryServerServices();
 

Gets the library server services.

setLibraryServerServices
      setLibraryServerServices(String libServerServices);
 

Sets the library server services. The libServerServices is the name of a library server services for a text search index.

getIndexDataArea
      String getIndexDataArea();
 

Gets the index data area.

setIndexDataArea
      setIndexDataArea(String indexDataArea);
 

Sets the index data area. The indexDataArea is the name of the index data area for a text search index.

getIndexWorkArea
      String getIndexWorkArea();
 

Gets the index work area.

setIndexWorkArea
      setIndexWorkArea(String indexWorkArea);
 

Sets the index work area. The indexWorkArea is the name of the index work area for a text search index.

getIndexTitle
      String getIndexTitle();
 

Gets the index title.

setIndexTitle
      setIndexTitle(String indexTitle);
 

Sets the index title. The indexTitle is the name of the index title for a text search index.

getIndexTitleCCSID
      long getIndexTitleCCSID();
 

Gets the index title CCSID (coded character set ID).

setIndexTitleCCSID
      setIndexTitleCCSID(long indexTitleCCSID);
 

Sets the index title CCSID (coded character set ID). The indexTitleCCSID is the index title CCSID for a text search index.

getIndexDescription
      String getIndexDescription();
 

Gets the index description.

setIndexDescription
      setIndexDescription(String indexDescription);
 

Sets the index description. The indexDescription is the name of the index description for a text search index.

getIndexDescriptionCCSID
      long getIndexDescriptionCCSID();
 

Gets the index description CCSID.

setIndexDescriptionCCSID
      setIndexDescriptionCCSID(long indexDescCCSID);
 

Sets the index description CCSID (coded character set ID). The indexDescCCSID is the description title CCSID for a text search index.

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