com.ibm.ims.base

Class SecondaryIndexInfo

java.lang.Object

com.ibm.ims.base.DLITypeInfo

com.ibm.ims.base.SecondaryIndexInfo

All Implemented Interfaces:

java.io.Serializable

public class SecondaryIndexInfo
extends DLITypeInfo

A SecondaryIndexInfo object is a specialization of a DLITypeInfo object that defines a field, or a set of fields, that make up a secondary index. You construct a SecondaryIndexInfo object by providing the field name alias, an array of ordered strings that indicate the field names (by field name alias) the secondary index references (via the SRCH parameter), and the actual name of the secondary index as defined in the DBD. The following example demonstrates how to define a segment containing a secondary index.

    public class TelephoneDirectory extends DLISegment {

      static String[] keys = {"LastName", "FirstName"};

      static DLITypeInfo[] typeInfo = { 
        new DLITypeInfo("EmployeeNumber",       DLITypeInfo.CHAR,  1, 6, "EMPNO"),
        new DLITypeInfo("LastName",             DLITypeInfo.CHAR,  7, 10),
        new DLITypeInfo("FirstName",            DLITypeInfo.CHAR, 17, 10, "FNAME"),
        new DLITypeInfo("Extension",            DLITypeInfo.CHAR, 27, 10),
        new SecondaryIndexInfo("EmployeeInfo", "Directory", keys, "EMPINFO", 20)
      };
        
      public TelephoneDirectory() {
        super("Directory", "TELEDIR", typeInfo, 36);
      }
    } 

 

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.ims.base.DLITypeInfo

ARRAY, BIGINT, BINARY, BIT, BLOB, CHAR, CLOB, DATE, DBCS, DOUBLE, FLOAT, INTEGER, NON_UNIQUE_KEY, NOT_KEY, OTHER, PACKEDDECIMAL, SECONDARY_INDEX, SMALLINT, STRUCT, TIME, TIMESTAMP, TINYINT, TYPELIST, UBIGINT, UINTEGER, UNIQUE_KEY, USMALLINT, UTINYINT, VARCHAR, XML, ZONEDDECIMAL

Constructor Summary

Constructors

Constructor and Description
SecondaryIndexInfo(java.lang.String fieldName, java.lang.String sourceSegmentName, java.lang.String[] sourceIndexFieldNames, java.lang.String searchFieldName, int keyLength) Constructs a SecondaryIndexInfo object.

Method Summary

Modifier and Type	Method and Description
DLITypeInfo[]	getSourceFieldTypeInfo() Returns the secondary index source segment information like the DBD defined name of the secondary index field, offset in the segment, alias name, array of source segment field names.
java.lang.String[]	getSourceIndexInfo() Returns the ordered list of segment name aliases that the secondary index references (provided via the SRCH parameter).
java.lang.String	getSourceSegmentName() Returns the name of the source segment that has the fields corresponding to the fields in the secondary index, which is given by the sourceSegmentName parameter.
void	setSourceFieldTypeInfo(DLITypeInfo[] sourceFieldTypeInfos) Sets the secondary index source segment information like the DBD defined name of the secondary index field, offset in the segment, alias name, array of source segment field names.

Methods inherited from class com.ibm.ims.base.DLITypeInfo

getDBType, getFieldLength, getFieldName, getFieldOffset, getFieldType, getIsRoot, getKeyType, getPrecision, getScale, getSearchFieldName, getTypeQualifier, getXmlSchema, isSigned

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecondaryIndexInfo

public SecondaryIndexInfo(java.lang.String fieldName,
                          java.lang.String sourceSegmentName,
                          java.lang.String[] sourceIndexFieldNames,
                          java.lang.String searchFieldName,
                          int keyLength)

Constructs a SecondaryIndexInfo object.

Parameters:

fieldName - The name of the field. This name can be an alias that maps to the the actual name as defined in the DBD source file, which is given by the searchFieldName parameter.

sourceSegmentName - The name of the source segment that has the fields corresponding to the fields in the secondary index, which is given by the sourceSegmentName parameter.

sourceIndexFieldNames - The ordered list of field name aliases that the secondary index references (provided via the SRCH parameter). Note the fields specified via the SRCH parameter are the actual names of the fields and not the field alias names so be sure to code the alias names.

searchFieldName - The actual name of the secondary index as defined in the DBD (via the XDFLD NAME= parameter)

keyLength - The sum of the lengths of the fields of the secondary index.

Method Detail

getSourceSegmentName

public java.lang.String getSourceSegmentName()

Returns the name of the source segment that has the fields corresponding to the fields in the secondary index, which is given by the sourceSegmentName parameter.

Returns:

Name of the source segment

getSourceIndexInfo

public java.lang.String[] getSourceIndexInfo()

Returns the ordered list of segment name aliases that the secondary index references (provided via the SRCH parameter).

Returns:

Secondary index source segment field names

getSourceFieldTypeInfo

public DLITypeInfo[] getSourceFieldTypeInfo()

Returns the secondary index source segment information like the DBD defined name of the secondary index field, offset in the segment, alias name, array of source segment field names.

Returns:

Secondary index source segment information

setSourceFieldTypeInfo

public void setSourceFieldTypeInfo(DLITypeInfo[] sourceFieldTypeInfos)

Sets the secondary index source segment information like the DBD defined name of the secondary index field, offset in the segment, alias name, array of source segment field names.

Parameters:

sourceFieldTypeInfos - Information like the DBD defined name of the secondary index field, offset in the segment, alias name, array of source segment field names.