com.ibm.ims.dli

Interface PathMetaData

public interface PathMetaData

An object that can be used to get information about the types and properties of the fields in a Path object.

Method Summary

Modifier and Type	Method and Description
int	getFieldCount() Returns the number of fields in this Path object.
java.lang.String	getFieldName(int field) Gets the name of the specified field.
int	getFieldType(int field) Gets the DLI type of the specified field.
int	getPrecision(int field) Gets the specified field size of the designated field.
int	getScale(int field) Gets the number of digits to the right of the decimal point in the specified field.
java.lang.String	getSegmentName(int field) Gets the segment name of the specified field.
boolean	isSearchable(int field) Indicates whether the designated field can be used in a segment search argument (SSA).
boolean	isSigned(int field) Indicates whether values in the designated field are signed numbers.

Method Detail

getFieldCount

int getFieldCount()

Returns the number of fields in this Path object.

Returns:

the number of fields

getFieldName

java.lang.String getFieldName(int field)
                       throws DLIException

Gets the name of the specified field.

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

field name

Throws:

DLIException - if a processing error occurs

getFieldType

int getFieldType(int field)
          throws DLIException

Gets the DLI type of the specified field.

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

DLI type from com.ibm.ims.dli.types.Types

Throws:

DLIException - if a processing error occurs

getPrecision

int getPrecision(int field)
          throws DLIException

Gets the specified field size of the designated field. For numeric data, this is the maximum precision. For character data, this is the length in characters. For date and time datatypes, this is the length in characters of the String representation of the field (assuming the maximum allowed precision of the fractional seconds component).

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

precision

Throws:

DLIException - if a processing error occurs

getScale

int getScale(int field)
      throws DLIException

Gets the number of digits to the right of the decimal point in the specified field. For data types where the scale is not applicable, this method returns zero.

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

scale

Throws:

DLIException - if a processing error occurs

getSegmentName

java.lang.String getSegmentName(int field)
                         throws DLIException

Gets the segment name of the specified field.

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

segment name

Throws:

DLIException - if a processing error occurs

isSearchable

boolean isSearchable(int field)
              throws DLIException

Indicates whether the designated field can be used in a segment search argument (SSA).

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

true if so; false otherwise

Throws:

DLIException - if a processing error occurs

isSigned

boolean isSigned(int field)
          throws DLIException

Indicates whether values in the designated field are signed numbers.

Parameters:

field - the first field is 1, the second is 2, ...

Returns:

true if so; false otherwise

Throws:

DLIException - if a processing error occurs