getColumn() Method

Usage

public java.lang.String getColumn(
java.lang.String pPattern, 
java.lang.String pSelector)

public java.lang.String getColumn(
java.lang.String pPattern)

Description

In an action, returns information on a column being handled by an the action.

Parameters

Parameter

Type

Description

pPattern

String

Pattern of values rendered for the column.

The list of the attributes usable in a pattern is detailed in the table « Pattern Attributes List »

Each occurrence of the attributes in the pattern string is replaced by its value. Attributes must be between brackets ([ and ])

Example « My string [COL_NAME] is a column »

pSelector

String

The Selector may take one of the following value:

  • NEW: returns the new version of the modified column or the new column.

  • OLD: returns the old version of the modified column or the dropped column.

If the selector is omitted, it is set to OLD for all drop actions. Otherwise, it is set to NEW.

Pattern Attributes List

The following table lists different parameters values as well as their associated description.

Parameter value

Description

I_COL

Internal identifier of the column

COL_NAME

Name of the column

COL_HEADING

Header of the column

COL_DESC

Description of the column

POS

Position of the column

LONGC

Column length (Precision)

SCALE

Scale of the column

FILE_POS

Beginning (index) of the column

BYTES

Number of physical bytes in the column

FILE_END_POS

End of the column (FILE_POS + BYTES)

IND_WRITE

Write right flag of the column

COL_MANDATORY

Mandatory character of the column (0: null authorized, 1: not null)

CHECK_FLOW

Flow control flag of the column (0: do not check, 1: check)

CHECK_STAT

Static control flag of the column (0: do not check, 1: check)

COL_FORMAT

Logical format of the column

COL_DEC_SEP

Decimal symbol of the column

REC_CODE_LIST

List of the record codes retained in the column

COL_NULL_IF_ERR

Processing flag of the column (0 = Reject, 1 = Set to null active trace, 2= set to null inactive trace)

DEF_VALUE

Default value of the column

EXPRESSION

Text of the expression executed on the source (expression as typed in the mapping or column name making an expression executed on the staging area).

CX_COL_NAME

Computed name of the column used as a container for the current expression on the staging area

ALIAS_SEP

Separator used for the alias (from the technology)

SOURCE_DT

Code of the column's datatype.

SOURCE_CRE_DT

Create table syntax for the column's datatype.

SOURCE_WRI_DT

Create table syntax for the column's writable datatype.

DEST_DT

Code of the column's datatype converted to a datatype on the target technology.

DEST_CRE_DT

Create table syntax for the column's datatype converted to a datatype on the target technology.

DEST_WRI_DT

Create table syntax for the column's writable datatype converted to a datatype on the target technology.

SCD_COL_TYPE

Behavior defined for the Slowly Changing Dimensions for this column in the data model.

MANDATORY_CLAUSE

Returns NOT NULL is the column is mandatory. Otherwise, returns the null keyword  for the technology.

DEFAULT_CLAUSE

Returns DEFAULT <default value> if any default value exists. Otherwise, returns and empty string.

COL_DESC

Description (comment) of the column. Quotes and double quotes are replaced with spaces.

<flexfield code>

Flexfield value for the current column.