A 代替APIリファレンス

この付録では、Oracle Data Integrator odiRef APIのリストを示します。

このAPIの使用についての概要は、第2章「代替APIの概要」を参照してください。

この付録の構成は、次のとおりです。

A.1項「置換メソッドのリスト」
A.2項「置換メソッドのリファレンス」

A.1 置換メソッドのリスト

次に、置換メソッドのリストを、使用できるナレッジ・モジュールの種類別に分類して示します。グローバル・メソッドには、どの状況でも使用できるメソッドが分類されています。

指定されたナレッジ・モジュールまたはアクションでの動作に関する詳細は、指定されたメソッドの説明を参照してください。

この項で説明する項目は、次のとおりです。

グローバル・メソッド
ジャーナル化ナレッジ・モジュール
ロード・ナレッジ・モジュール
チェック・ナレッジ・モジュール
統合ナレッジ・モジュール
リバースエンジニアリング・ナレッジ・モジュール
サービス・ナレッジ・モジュール
アクション

A.1.1 グローバル・メソッド

次のメソッドは、すべてのナレッジ・モジュールおよびアクションで使用できます。

getCatalogName()メソッド
getCatalogNameDefaultPSchema()メソッド
getColDefaultValue()メソッド
getContext()メソッド
getDataType()メソッド
getFlexFieldValue()メソッド
getInfo()メソッド
getJDBCConnection()メソッド
getJDBCConnectionFromLSchema()メソッド
getNbInsert()、getNbUpdate()、getNbDelete()、getNbErrors()およびgetNbRows()メソッド
getObjectName()メソッド
getObjectNameDefaultPSchema()メソッド
getOdiInstance()メソッド
getOption()メソッド
getPackage()メソッド
getPrevStepLog()メソッド
getQuotedString()メソッド
getSchemaName()メソッド
getSchemaNameDefaultPSchema()メソッド
getSession()メソッド
getSessionVarList()メソッド
getStep()メソッド
getSysDate()メソッド
setNbInsert()、setNbUpdate()、setNbDelete()、setNbErrors()およびsetNbRows()メソッド
setTaskName()メソッド

A.1.2 ジャーナル化ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、ジャーナル化ナレッジ・モジュール(JKM)では特に次のメソッドを使用できます。

getJrnFilter()メソッド
getJrnInfo()メソッド
getSubscriberList()メソッド
getTable()メソッド
getColList()メソッド

A.1.3 ロード・ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、ロード・ナレッジ・モジュール(LKM)では特に次のメソッドを使用できます。

getColList()メソッド
getDataSet()メソッド
getDataSetCount()メソッド
getFilter()メソッド
getFilterList()メソッド
getFrom()メソッド
getGrpBy()メソッド
getGrpByList()メソッド
getHaving()メソッド
getHavingList()メソッド
getJoin()メソッド
getJoinList()メソッド
getJrnFilter()メソッド
getJrnInfo()メソッド
getPop()メソッド
getSrcColList()メソッド
getSrcTablesList()メソッド
getTable()メソッド
getTargetColList()メソッド
getTableName()メソッド
getTargetTable()メソッド
getTemporaryIndex()メソッド
getTemporaryIndexColList()メソッド
setTableName()メソッド

A.1.4 チェック・ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、チェック・ナレッジ・モジュール(CKM)では特に次のメソッドを使用できます。

getAK()メソッド
getAKColList()メソッド
getCK()メソッド
getColList()メソッド
getFK()メソッド
getFKColList()メソッド
getNotNullCol()メソッド
getPK()メソッド
getPKColList()メソッド
getPop()メソッド
getTable()メソッド
getTargetColList()メソッド
getTargetTable()メソッド

A.1.5 統合ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、統合ナレッジ・モジュール(IKM)では特に次のメソッドを使用できます。

getColList()メソッド
getDataSet()メソッド
getDataSetCount()メソッド
getFilter()メソッド
getFilterList()メソッド
getFrom()メソッド
getGrpBy()メソッド
getGrpByList()メソッド
getHaving()メソッド
getHavingList()メソッド
getJoin()メソッド
getJoinList()メソッド
getJrnFilter()メソッド
getJrnInfo()メソッド
getPop()メソッド
getSrcColList()メソッド
getSrcTablesList()メソッド
getTable()メソッド
getTableName()メソッド
getTargetColList()メソッド
getTargetTable()メソッド
getTemporaryIndex()メソッド
getTemporaryIndexColList()メソッド
setTableName()メソッド

A.1.6 リバースエンジニアリング・ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、リバースエンジニアリング・ナレッジ・モジュール(RKM)では特に次のメソッドを使用できます。

getModel()メソッド

A.1.7 サービス・ナレッジ・モジュール

グローバル・メソッドのリストに含まれるメソッドに加えて、サービス・ナレッジ・モジュール(SKM)では特に次のメソッドを使用できます。

hasPK()メソッド
nextAK()メソッド
nextCond()メソッド
nextFK()メソッド

A.1.8 アクション

グローバル・メソッドのリストに含まれるメソッドに加えて、アクションでは特に次のメソッドを使用できます。

getAK()メソッド
getAKColList()メソッド
getCK()メソッド
getColList()メソッド
getColumn()メソッド
getFK()メソッド
getFKColList()メソッド
getIndex()メソッド
getIndexColList()メソッド
getNewColComment()メソッド
getNewTableComment()メソッド
getPK()メソッド
getPKColList()メソッド
getTable()メソッド
getTargetTable()メソッド
isColAttrChanged()メソッド

A.2 代替メソッドのリファレンス

この項では、代替メソッドをアルファベット順にリストしています。各メソッドの使用方法、説明、パラメータおよびコード例について詳述します。

A.2.1 getAK()メソッド

代替キーに関する情報を返すために使用します。

使用方法

public java.lang.String getAK(java.lang.String pPropertyName)

説明

このメソッドはチェック・プロシージャの間、データストアの代替キーに関する情報を返します。現在のタスクにalternate keyというタグが付けられている場合、チェック・ナレッジ・モジュールからのみアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって現在処理されている代替キーに関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	AK制約の内部番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GUID	代替キーのGUID
KEY_NAME	代替キーの名前
MESS	代替キーの制約に関するエラー・メッセージ
FULL_NAME	ローカル・オブジェクト・マスクで生成されたAKのフルネーム
<flexfield code>	このAKのフレックスフィールドの値

例

The alternate key of my table is named: <%=odiRef.getAK("KEY_NAME")%>

A.2.2 getAKColList()メソッド

代替キーの属性に関する情報を返すために使用します。

使用方法

public java.lang.String getAKColList( java.lang.String pStart,
java.lang.String pPattern,java.lang.String pEnd)
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getAKColList(
java.lang.String pPattern,
java.lang.String pSeparator)

説明

現在チェックされている代替キーの属性と式のリストを返します。

リストの各要素について、pPatternパラメータが解釈され、繰り返されます。前の要素からはpSeparatorパラメータによって区切られます。生成された文字列はpStartから始まり、pEndで終わります。要素が選択されていない場合は、pStartとpEndは省略され、空の文字列が返されます。

このリストには、現在の代替キーの各属性の要素が含まれます。現在のタスクにalternate keyというタグが付けられている場合、チェック・ナレッジ・モジュールからアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって処理された代替キーの属性のリストを、キー内の位置の順に並べて返します。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン・シーケンス内に出現するたびにその値に置き換えられます。属性は大カッコ([ ])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	キー属性の名前
COL_HEADING	キー属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始位置(固定ファイル)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字: 0: NULLを許可 1: NULLでない
CHECK_FLOW	属性のフロー制御フラグ: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	未使用
CX_COL_NAME	未使用
ALIAS_SEP	別名に対して(テクノロジにより)使用されるグループ化記号
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
<flexfield code>	現在の属性のフレックスフィールド値

例

CUSTOMER表に代替キーAK_CUSTOMER (CUST_ID、CUST_NAME)が含まれ、次のコードを生成する場合:

create table T_AK_CUSTOMER
(CUST_ID numeric(10) not null, CUST_NAME varchar(50) not null)

次のように記述します。

create table T_<%=odiRef.getAK("KEY_NAME")%>
<%=odiRef.getAKColList("(", "[COL_NAME] [DEST_CRE_DT] not null", ", ", ")")%>

説明: getAKColList関数が使用され、(CUST_ID numeric(10) not null, CUST_NAME varchar(50) not null)部分が生成されます。先頭と末尾はカッコで、代替キーの各属性をカンマで区切ってパターン(属性、データ型、not null)が繰り返されます。このため、

関数の最初のパラメータ"("は、文字列を、文字列「(」で始めることを示します。
2番目のパラメータ"[COL_NAME] [DEST_CRE_DT] not null"は、このパターンを代替キーの各属性に対して繰り返すことを示します。キーワード[COL_NAME]および[DEST_CRE_DT]は、表「パターン属性リスト」の有効なキーワードを参照します。
3番目のパラメータ", "は、パターンの解釈された発生を、文字列「,」で区切ることを示します。
関数の4番目のパラメータ")"は、文字列を、文字列「)」で終わることを示します。

A.2.3 getAllTargetColList()メソッド

マッピングのターゲット表のすべての属性(アクティブな属性および非アクティブな属性を含む)に関する情報を返すために使用します。アクティブな属性とは、アクティブ・マッピングを持つ属性のことです。

このメソッドの使用方法とパラメータは、getTargetTable()メソッドと同じです。詳細は、A.2.61項「getTargetColList()メソッド」を参照してください。

A.2.4 getCatalogName()メソッド

トポロジからカタログ名を返すために使用します。

使用方法

public java.lang.String getCatalogName(
 java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getCatalogName(
 java.lang.String pLogicalSchemaName,
java.lang.String pContextCode,
pContextCode, java.lang.String pLocation)

public java.lang.String getCatalogName(
java.lang.String pLocation)

public java.lang.String getCatalogName()

説明

物理データ・カタログまたは作業カタログの名前を論理スキーマから取得できます。

最初の構文が使用される場合、返されるカタログ名は現在のコンテキストに一致します。

2番目の構文が使用される場合、返されるカタログ名は、pContextCodeパラメータで指定されたコンテキストのカタログ名です。

3番目の構文は、現在のコンテキスト、現在の論理スキーマでのデータ・カタログ(D)または作業カタログ(W)の名前を返します。

4番目の構文は、現在のコンテキスト、現在の論理スキーマでのデータ・カタログ(D)の名前を返します。

パラメータ

パラメータ	タイプ	説明
pLogicalSchemaName	文字列	論理スキーマの名前
pContextCode	文字列	強制適用されたスキーマのコンテキストのコード
pLocation	文字列	有効な値は次のとおりです。 W: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマの作業カタログを返します。 D: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマのデータ・カタログを返します。

例

定義されている物理スキーマ: Pluton.db_odi.dbo

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_owner

この物理スキーマに関連づけられているもの: コンテキストCTX_DEVのMSSQL_ODI

コール対象	戻り値
<%=odiRef.getCatalogName("MSSQL_ODI", "CTX_DEV", "W")%>	tempdb
<%=odiRef.getCatalogName("MSSQL_ODI", "CTX_DEV", "D")%>	db_odi

A.2.5 getCatalogNameDefaultPSchema()メソッド

トポロジからデフォルトの物理スキーマのカタログ名を返すために使用します。

使用方法

public java.lang.String getCatalogNameDefaultPSchema(
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getCatalogNameDefaultPSchema(
java.lang.String pLogicalSchemaName,
java.lang.String pContextCode,
java.lang.String pLocation)

public java.lang.String getCatalogNameDefaultPSchema(
java.lang.String pLocation)

public java.lang.String getCatalogNameDefaultPSchema()

説明

タプルに対応している物理スキーマ(論理スキーマ、コンテキスト)が関連付けられているデータ・サーバーのデフォルトの物理データ・カタログまたは作業カタログの名前を取得できます。コンテキストを指定しない場合、現在のコンテキストが使用されます。論理スキーマ名が指定されない場合、現在の論理スキーマが使用されます。pLocationが指定されない場合、データ・カタログが返されます。

パラメータ

パラメータ	タイプ	説明
pLogicalSchemaName	文字列	論理スキーマの名前
pContextCode	文字列	強制適用されたスキーマのコンテキストのコード
pLocation	文字列	有効な値は次のとおりです。 W: タプル(コンテキスト、論理スキーマ)に対応している物理スキーマもアタッチされているデータ・サーバーに関連付けられている、デフォルトの物理スキーマの作業カタログを返します。 D: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマのデータ・カタログを返します。

例

定義されている物理スキーマ: Pluton.db_odi.dbo

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_odi
デフォルト・スキーマか	はい

この物理スキーマに関連付けられているもの: コンテキスト: コンテキストCTX_DEVのMSSQL_ODIおよびPluton.db_doc.doc

データ・カタログ:	db_doc
データ・スキーマ:	doc
作業カタログ:	tempdb
作業スキーマ:	temp_doc
デフォルト・スキーマか	いいえ

この物理スキーマに関連付けられているもの: コンテキストCTX_DEVのMSSQL_DOC

コール対象	戻り値
<%=odiRef.getCatalogNameDefaultPSchema("MSSQL_DOC", "CTX_DEV", "W")%>	tempdb
<%=odiRef.getCatalogNameDefaultPSchema("MSSQL_DOC", "CTX_DEV", "D")%>	db_odi

A.2.6 getCK()メソッド

条件に関する情報を返すために使用します。

使用方法

public java.lang.String getCK(java.lang.String pPropertyName)

説明

このメソッドはチェック・プロシージャの間、データストアの条件に関する情報を返します。現在のタスクにconditionというタグが付けられている場合のみ、チェック・ナレッジ・モジュールからアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって現在処理されているチェック制約に関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている現在の文字列

次の表は、pPropertyNameで許容される様々な値のリストです。

パラメータ値	説明
ID	チェック制約の内部番号。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GUID	チェックのGUID。
COND_ALIAS	SQL文に使用する表の別名
COND_NAME	条件の名前
COND_TYPE	条件のタイプ
COND_SQL	条件のSQL文
MESS	チェック制約に関するエラー・メッセージ
FULL_NAME	ローカル・オブジェクト・マスクで生成されたチェック制約のフルネーム
COND_SQL_DDL	表の別名がない条件のSQL文
<flexfield code>	このチェック制約のフレックスフィールド値

例

The current condition is called: <%=snpRep.getCK("COND_NAME")%>

insert into MY_ERROR_TABLE
select *
from MY_CHECKED_TABLE
where (not (<%=odiRef.getCK("COND_SQL")%>))

A.2.7 getColDefaultValue()メソッド

マッピング属性のデフォルト値を返すために使用します。

使用方法

public java.lang.String getColDefaultValue()

説明

マッピングのターゲット属性のデフォルト値を返します。

このメソッドは、マッピング式で<%%>タグなしで使用できます。このメソッド・コールは、生成されたコードに、属性定義で設定したデフォルト値を挿入します。属性タイプによっては、この値を引用符で囲みます。

パラメータ

なし

例

The default value of my target attribute is '+ 'odiRef.getColDefaultValue()'

A.2.8 getColList()メソッド

属性のフィルタ済リストから各属性のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getColList(
java.lang.int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd,
java.lang.String pSelector)

代替可能な構文:

public java.lang.String getColList(
java.lang.int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

public java.lang.String getColList(
java.lang.int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pSelector)

public java.lang.String getColList(
java.lang.int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

指定されたデータセットの属性と式のリストを返します。属性リストはこのメソッドがコールされたフェーズにより異なります。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

pPatternパラメータはリストの各要素(pSelectorパラメータに応じて選択)ごとに解釈され、繰り返されて、前の要素からパラメータpSeparatorで区切られます。生成された文字列はpStartから始まり、pEndで終わります。要素が選択されていない場合は、pStartとpEndは省略され、空の文字列が返されます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

注意:

このメソッドでは、特別なコードを必要とせずにルックアップが自動的に生成されます。
ソースの属性名がターゲット・テクノロジで許容されている属性名の最大長を超えた場合、自動的に切り捨てられます。

ロード(LKM)

このリストには、現在の実行ユニットで実行されたすべての有効なマッピング式と、ステージング領域で実行されたマッピング、フィルタおよび結合式で使用された現在の実行ユニットのすべての属性が表示されます。リストは、POS、FILE_POSでソートされます。

マッピングのソースにジャーナル化されたデータストアがある場合、3つのジャーナル化疑似属性JRN_FLAG、JRN_DATEおよびJRN_SUBSCRIBERは、ジャーナル化されたソース・データストアの属性として追加されます。

統合(IKM)

現在のマッピングで現在有効なすべてのマッピング式がリストに表示されます。

このリストには、現在のマッピングのターゲット表にロードされた各属性につき1つの要素が含まれます。ターゲット表が一時表でない場合、リストはPOS、FILE_POSでソートされます。一時表である場合は、リストはソートされません。

マッピングのソースにジャーナル化されたデータストアがあり、それがステージング領域にある場合、3つのジャーナル化擬似属性JRN_FLG、JRN_DATEおよびJRN_SUBSCRIBERは、ジャーナル化されたソース・データストアの属性として追加されます。

チェック(CKM)

このリストにはターゲット表のすべての属性(静的制御またはフロー制御)が表示されます。

現在のマッピングでマップされる属性を識別するには、MAPセレクタを使用する必要があります。

アクション

このリストには、DDLコマンドで処理された表のすべての属性が表示されます。

変更、追加または削除された属性の場合、NEWおよびOLDセレクタを使用して、DDLコマンドによって処理される、変更された属性の新バージョンまたは旧バージョンを取得することができます。表が一時表でない場合、リストはPOS、FILE_POSでソートされます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストを、後述の「パターン属性リスト」に示します。属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。
pSelector	文字列	次の形式を使用して、最初のリストの要素をフィルタできるブール式を指定する文字列。 <SELECTOR> <演算子> <SELECTOR>など。カッコを使用できます。使用できる演算子: 否定: NOTまたは! 論理和: ORまたは\|\| 論理積: ANDまたは&& 例: (INS AND UPD) OR TRG 有効なセレクタについては後述します。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	属性の名前。
COL_HEADING	属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始(索引)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: NULLを許可 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	ソース上で実行される式のテキスト(属性マッピングに入力された式、またはステージング領域上で実行された式を作成する属性名)。
CX_COL_NAME	ステージング領域上の現在の式のコンテナとして使用されている属性の計算された名前
ALIAS_SEP	別名に対して(テクノロジにより)使用されるセパレータ
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
MANDATORY_CLAUSE	属性が必須の場合、`NOT NULL`を返します。そうでない場合、そのテクノロジのNULLキーワードを返します。
DEFAULT_CLAUSE	デフォルト値が存在する場合、`DEFAULT <デフォルト値>`を返します。そうでない場合は、空の文字列を返します。
JDBC_TYPE	データ・サービス - ドライバによって返される属性のJDBCタイプ。
<flexfield code>	現在の属性のフレックスフィールド値

セレクタの説明

パラメータ値	説明
INS	LKM: 適用対象外(*) IKM: 挿入でマークされたマッピング式のみ CKM: 適用対象外
UPD	LKM: 適用対象外(*) IKM: 更新でマークされたマッピング式のみ CKM: 適用対象外
TRG	LKM: 適用対象外(*) IKM: ターゲット上で実行されたマッピング式のみ CKM: 適用対象外
NULL	LKM: 適用対象外(*) IKM: NULL値可能でない属性をロードするすべてのマッピング式 CKM: NULL値を許容しないすべてのターゲット属性
PK	LKM: 適用対象外(*) IKM: 主キー属性をロードするすべてのマッピング式 CKM: 主キーの一部であるすべてのターゲット属性
UK	LKM: 適用対象外(*) IKM: 現在のマッピングに対して選択された更新キー属性をロードするすべてのマッピング式 CKM: 適用対象外
REW	LKM: 適用対象外(*) IKM: 読取り専用フラグが選択されていない属性をロードするすべてのマッピング式 CKM: 読取り専用フラグが選択されていないすべてのターゲット属性
UD1	LKM: 適用対象外(*) IKM: UD1としてマークされた属性をロードするすべてのマッピング式 CKM: 適用対象外
UD2	LKM: 適用対象外(*) IKM: UD2としてマークされた属性をロードするすべてのマッピング式 CKM: 適用対象外
UD3	LKM: 適用対象外(*) IKM: UD3としてマークされた属性をロードするすべてのマッピング式 CKM: 適用対象外
UD4	LKM: 適用対象外(*) IKM: UD4としてマークされた属性をロードするすべてのマッピング式 CKM: 適用対象外
UD5	LKM: 適用対象外(*) IKM: UD5としてマークされた属性をロードするすべてのマッピング式 CKM: 適用対象外
MAP	LKM: 適用対象外 IKM: 適用対象外 CKM: フロー制御: 現在のマッピングの式でロードされたターゲット表のすべての属性静的制御: ターゲット表のすべての属性
SCD_SK	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Surrogate Key」とマーキングされたすべての属性
SCD_NK	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Natural Key」とマーキングされたすべての属性
SCD_UPD	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Overwrite on Change」とマーキングされたすべての属性
SCD_INS	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Add Row on Change」とマーキングされたすべての属性
SCD_FLAG	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Current Record Flag」とマーキングされたすべての属性
SCD_START	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Starting Timestamp」とマーキングされたすべての属性
SCD_END	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Ending Timestamp」とマーキングされたすべての属性
NEW	アクション: 表に追加された属性。表の変更された属性の新しいバージョン
OLD	アクション: 表から削除された属性。表の変更された属性の旧バージョン
WS_INS	SKM: 属性は、データ・サービスを使用したINSERTを許可するフラグを設定されています。
WS_UPD	SKM: 属性は、データ・サービスを使用したUDATEを許可するフラグを設定されています。
WS_SEL	SKM: 属性は、データ・サービスを使用したSELECTを許可するフラグを設定されています。

注意:

LKMで、前の表に*で示した一部のセレクタを使用することは、可能ですが非推奨です。マッピングでソース上でマップされる属性のみが返されます。結果として、マッピングによっては、結果が正しくないことがあります。たとえば、UKセレクタでは、マップされないかソース上で実行されないキーの属性は、このセレクタで返されません。

例

CUSTOMER表に属性(CUST_ID、CUST_NAME、AGE)が含まれ、次のコードを生成する場合:

create table CUSTOMER (CUST_ID numeric(10) null,
CUST_NAME varchar(50) null, AGE numeric(3) null)

次のように記述します。

create table CUSTOMER
<%=odiRef.getColList("(", "[COL_NAME] [SOURCE_CRE_DT] null", ", ", ")", "")%>

説明: getColList関数が使用され、(CUST_ID numeric(10) null, CUST_NAME varchar(50) null, AGE numeric(3) null)が生成されます。先頭と末尾はカッコで、各属性をカンマで区切ってパターン(属性、データ型、null)が繰り返されます。このため、

関数の最初の文字"("は、文字列を、文字列「(」で始めることを示します。
2番目のパラメータ"[COL_NAME] [SOURCE_CRE_DT] null"は、このパターンを各属性に対して繰り返すことを示します。キーワード[COL_NAME]および[SOURCE_CRE_DT]は、表「パターン属性リスト」の有効なキーワードに対する参照です。
3番目のパラメータ", "は、パターンの解釈された発生を、文字列「,」で区切ることを示します。
関数の4番目のパラメータ")"は、文字列を、文字列「)」で終わることを示します。
最後のパラメータ""は、パターンを各属性に対して(選択内容なしで)繰り返すことを示します。

A.2.9 getColumn()メソッド

アクションによって処理されている特定の属性に関する情報を返すために使用します。

使用方法

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

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

説明

アクションでは、アクションにより処理されている属性に関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPattern	文字列	属性に対してレンダーされた値のパターンパターンで使用できる属性のリストを、後述の「パターン属性リスト」に示します。属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSelector	文字列	セレクタは次のいずれかの値をとることができます。 NEW: 変更された属性の新しいバージョンまたは新しい属性を返します。 OLD: 変更された属性の古いバージョンまたは削除された属性を返します。セレクタを省略すると、すべての削除アクションに対してOLDに設定されます。それ以外の場合はNEWに設定されます。

タイプ

説明

pPattern

文字列

属性に対してレンダーされた値のパターン

パターンで使用できる属性のリストを、後述の「パターン属性リスト」に示します。

属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。

例: «My string [COL_NAME] is a attribute»

pSelector

文字列

セレクタは次のいずれかの値をとることができます。

NEW: 変更された属性の新しいバージョンまたは新しい属性を返します。
OLD: 変更された属性の古いバージョンまたは削除された属性を返します。

セレクタを省略すると、すべての削除アクションに対してOLDに設定されます。それ以外の場合はNEWに設定されます。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	属性の名前。
COL_HEADING	属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始(索引)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: NULLを許可 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	ソース上で実行される式のテキスト(マッピングに入力された式、またはステージング領域上で実行された式を作成する属性名)。
CX_COL_NAME	ステージング領域上の現在の式のコンテナとして使用されている属性の計算された名前
ALIAS_SEP	別名に対して(テクノロジにより)使用されるセパレータ
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
MANDATORY_CLAUSE	属性が必須の場合、`NOT NULL`を返します。そうでない場合、そのテクノロジのNULLキーワードを返します。
DEFAULT_CLAUSE	デフォルト値が存在する場合、`DEFAULT <デフォルト値>`を返します。そうでない場合は、空の文字列を返します。
<flexfield code>	現在の属性のフレックスフィールド値

A.2.10 getContext()メソッド

現在のコンテキストに関する情報を返すために使用します。

使用方法

public java.lang.String getContext(java.lang.String pPropertyName)

説明

このメソッドは現在の実行コンテキストに関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	コンテキストの内部IDこのパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GLOBAL_ID	コンテキストのGUID。
CTX_NAME	コンテキストの名前。
CTX_CODE	コンテキストのコード
CTX_DEFAULT	デフォルト・コンテキストには1、他のコンテキストには0を返します。
<flexfield code>	この参照のフレックスフィールド値

例

Current Context = <%=getContext("CTX_NAME")%>

A.2.11 getDataSet()メソッド

マッピングの指定されたデータセットに関する情報を返すために使用します。

使用方法

public java.lang.String getDataSet(
java.lang.Int pDSIndex,
java.lang.String pPropertyName)

説明

マッピングの指定されたデータセットに関する情報を取得します。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
OPERATOR	選択されたデータセットに適用される演算子。最初のデータセットには、空の値が返されます。
NAME	データセット名。
HAS_JRN	データセットがジャーナル化されたデータストアの場合は「1」を、そうでない場合は「0」を返します。

例

<%for (int i=0; i < odiRef.getDataSetCount(); i++){%><%=odiRef.getDataSet(i, "Operator")%>select        <%=odiRef.getPop("DISTINCT_ROWS")%>      <%=odiRef.getColList(i,"", "[EXPRESSION] [COL_NAME]", ",\n\t", "", "((INS and !TRG) and REW)")%> from  <%=odiRef.getFrom(i)%>where     <% if (odiRef.getDataSet(i, "HAS_JRN").equals("1")) { %> JRN_FLAG <> 'D        '<%} else {%>    (1=1)    <% } %><%=odiRef.getJoin(i)%><%=odiRef.getFilter(i)%><%=odiRef.getJrnFilter(i)%><%=odiRef.getGrpBy(i)%><%=odiRef.getHaving(i)%>
<%}%>

A.2.12 getDataSetCount()メソッド

マッピングのデータセットの数を返すために使用します。

使用方法

public java.lang.Int getDataSetCount()

説明

マッピングのデータセットの数を返します。

パラメータ

なし

例

<%for (int i=0; i < odiRef.getDataSetCount(); i++){%><%=odiRef.getDataSet(i, "Operator")%>select        <%=odiRef.getPop("DISTINCT_ROWS")%>      <%=odiRef.getColList(i,"", "[EXPRESSION] [COL_NAME]", ",\n\t", "", "((INS and !TRG) and REW)")%> from  <%=odiRef.getFrom(i)%>where     <% if (odiRef.getDataSet(i, "HAS_JRN").equals("1")) { %> JRN_FLAG <> 'D        '<%} else {%>    (1=1)    <% } %><%=odiRef.getJoin(i)%><%=odiRef.getFilter(i)%><%=odiRef.getJrnFilter(i)%><%=odiRef.getGrpBy(i)%><%=odiRef.getHaving(i)%>
<%}%>

A.2.13 getDataType()メソッド

指定されたデータ型の属性を作成する構文を返すために使用します。

使用方法

public java.lang.String getDataType(
java.lang.String pDataTypeName,
java.lang.String pDataTypeLength,
java.lang.String pDataTypePrecision)

説明

ソース・テクノロジおよびターゲット・テクノロジに関連づけられたパラメータに応じて、データ型として数値または日付を使用する作成構文を返します。

パラメータ

パラメータ	タイプ	説明
パラメータ	タイプ	説明
pDataTypeName	文字列	次の表にリストされているデータ型の名前
pDataTypeLength	文字列	データ型の長さ
pDataTypePrecision	文字列	データ型の精度

次の表は、pDataTypeNameで可能なすべての値のリストです。

パラメータ値	説明
SRC_VARCHAR	ソースのvarcharデータ型に対応する構文を返します。
SRC_NUMERIC	ソースの数値データ型に対応する構文を返します。
SRC_DATE	ソースの日付データ型に対応する構文を返します。
DEST_VARCHAR	ターゲットのvarcharデータ型に対応する構文を返します。
DEST_NUMERIC	ターゲットの数値データ型に対応する構文を返します。
DEST_DATE	ターゲットの日付データ型に対応する構文を返します。

例

次のテクノロジの構文が次のようであるとします。

テクノロジ	Varchar	数値	日付
Oracle	varchar2(%L)	number(%L,%P)	date
Microsoft SQL Server	varchar(%L)	numeric(%L,%P)	datetime
Microsoft Access	Text(%L)	double	datetime

getDataTypeのコール例を次に示します。

コール	Oracle	SQL Server	Access
`<%=odiRef.getDataType("DEST_VARCHAR", "10" "")%>`	varchar2(10)	varchar(10)	Text(10)
`<%=odiRef.getDataType("DEST_VARCHAR", "10", "5")%>`	varchar2(10)	varchar(10)	Text(10)
`<%=odiRef.getDataType("DEST_NUMERIC", "10" "")%>`	number(10)	numeric(10)	double
`<%=odiRef.getDataType("DEST_NUMERIC", "10", "2")%>`	number(10,2)	numeric(10,2)	double
`<%=odiRef.getDataType("DEST_NUMERIC" "" "")%>`	number	numeric	double
`<%=odiRef.getDataType("DEST_DATE" "" "")%>`	date	datetime	datetime
`<%=odiRef.getDataType("DEST_DATE", "10", "2")%>`	date	datetime	datetime

A.2.14 getFilter()メソッド

マッピングのフィルタ用に生成されたWHERE句セクション全体を返すために使用します。

使用方法

public java.lang.String getFilter(java.lang.Int pDSIndex)

説明

指定されたデータセットのSQLフィルタ列を返します(ロード時はソースで、統合時はステージング領域で)。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

なし

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

A.2.15 getFilterList()メソッド

マッピングの各フィルタのプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getFilterList( 
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getFilterList(
java.lang.Int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

マッピングの指定されたデータセットに対するSQLフィルタの発生のリストを返します。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

pPatternパラメータはリストの各要素ごとに解釈され、繰り返されて、前の要素からパラメータpSeparatorで区切られます。生成された文字列はpStartから始まり、pEndで終わります。要素が選択されていない場合は、pStartとpEndは省略され、空の文字列が返されます。

このリストには、ソースまたはターゲット上(使用中のナレッジ・モジュールにより異なります)で実行される各フィルタ式の要素が含まれます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。リスト内で使用できるもののリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切るために使用されます。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
ID	フィルタ内部識別子。
EXPRESSION	フィルタ式のテキスト

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilterList("and ","([EXPRESSION])"," and ","")%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

説明: getFilterList関数は、SELECT句のフィルタを生成するために使用されます。フィルタはandで始まり、各フィルタごとにandで区切ってパターン(各フィルタの式)を繰り返します。このため、

関数の最初のパラメータ"and"は、文字列を、文字列and で始めることを示します。
2番目のパーメータ"([EXPRESSION])"は、このパターンを各フィルタに対して繰り返すことを示します。キーワード[EXPRESSION]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ" and "は、パターンの解釈された発生を、文字列andで区切ることを示します。
関数の4番目のパラメータ""は、文字列が特定の文字を伴わずに終わることを示します。

A.2.16 getFK()メソッド

外部キーに関する情報を返すために使用します。

使用方法

public java.lang.String getFK(java.lang.String pPropertyName)

説明

このメソッドはチェック・プロシージャの間、データストアの外部キー(または結合、参照)に関する情報を返します。現在のタスクにreferenceというタグが付けられている場合のみ、ナレッジ・モジュールからアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって現在処理されている外部キーに関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	参照制約の内部番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GUID	代替キーのGUID。
FK_NAME	参照制約の名前
FK_TYPE	参照制約のタイプ
FK_ALIAS	参照表の別名(複合式の場合のみ使用)
PK_ALIAS	参照された表の別名(複合式の場合のみ使用)
ID_TABLE_PK	参照された表の内部番号
PK_I_MOD	参照されたモデルの番号
PK_CATALOG	現在のコンテキストで参照された表のカタログ
PK_SCHEMA	現在のコンテキストで参照された表の物理スキーマ
PK_TABLE_NAME	参照された表の名前
COMPLEX_SQL	結合句の複合SQL文(該当する場合)
MESS	参照制約のエラー・メッセージ
FULL_NAME	ローカル・オブジェクト・マスクで生成された外部キーのフルネーム
<flexfield code>	この参照のフレックスフィールド値

例

The current reference key of my table is called: <%=odiRef.getFK("FK_NAME")%>. It references the table <%=odiRef.getFK("PK_TABLE_NAME")%> that is in the schema <%=odiRef.getFK("PK_SCHEMA")%>

A.2.17 getFKColList()メソッド

外部キーの属性に関する情報を返すために使用します。

使用方法

public java.lang.String getFKColList(java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getFKColList(
java.lang.String pPattern,
java.lang.String pSeparator)

説明

参照制約(外部キー)の属性部分のリストを返します。

このリストには、現在の外部キーの各属性につき1つの要素が含まれます。現在のタスクにreferenceというタグが付けられている場合のみ、チェック・ナレッジ・モジュールからアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって処理された外部キーの属性のリストを、キー内の位置の順に並べて返します。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
パラメータ	タイプ	説明
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	キーの属性の名前
COL_HEADING	キーの属性のヘッダー
COL_DESC	キーの属性の説明
POS	キーの属性の位置
LONGC	キーの属性の長さ(精度)
SCALE	キーの属性のスケール
FILE_POS	属性の開始(索引)
BYTES	属性の物理オクテット数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: 許可されない 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性のレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	未使用
CX_COL_NAME	未使用
ALIAS_SEP	別名に対して(テクノロジにより)使用されるセパレータ
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
PK_I_COL	参照属性の内部識別子
PK_COL_NAME	参照キー属性の名前
PK_COL_HEADING	参照キー属性のヘッダー
PK_COL_DESC	参照キー属性の説明
PK_POS	参照属性の位置
PK_LONGC	参照属性の長さ
PK_SCALE	参照属性の精度
PK_FILE_POS	参照属性の開始(索引)
PK_BYTES	参照属性の物理オクテット数
PK_FILE_END_POS	参照属性の終わり(FILE_POS + BYTES)
PK_IND_WRITE	参照属性の書込み権限フラグ
PK_COL_MANDATORY	参照属性の必須文字。有効な値: 0: NULLを許可 1: NOT NULL
PK_CHECK_FLOW	参照属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
PK_CHECK_STAT	参照属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
PK_COL_FORMAT	参照属性の論理形式
PK_COL_DEC_SEP	参照属性の小数点セパレータ
PK_REC_CODE_LIST	参照属性に維持されたレコード・コードのリスト
PK_COL_NULL_IF_ERR	参照属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
PK_DEF_VALUE	参照属性のデフォルト値
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
<flexfield code>	参照している表の現在の属性のフレックスフィールド値

例

CUSTOMER.COUNTRY_ID = CITY.ID_COUNT and CUSTOMER.CITY_ID = CITY.ID_CITでCUSTOMER表がCITY表を参照している場合

句:

(CUS.COUNTRY_ID = CITY.ID_COUNT and CUS.CITY_ID = CITY.ID_CIT)

は、次のようにも記述できます。

<%=odiRef.getFKColList("(", "CUS.[COL_NAME] = CITY.[PK_COL_NAME]", " and
", ")" )%>

説明: getFKColList関数は、外部キーの各属性上でループして、カッコで始まってカッコで終わり、andで区切られたパターンを外部キーの各属性に対して繰り返す句を生成するために使用されます。このため、

関数の最初のパラメータ"("は、文字列を「(」で始めることを示します。
2番目のパラメータ"CUS.[COL_NAME] = CITY.[PK_COL_NAME]"は、このパターンを外部キーの各属性に対して繰り返すことを示します。キーワード[COL_NAME]および[PK_COL_NAME]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ" and "は、パターンの発生を、文字列「 and 」で区切ることを示します。
関数の4番目のパラメータ")"は、文字列が「)」で終わることを示します。

A.2.18 getFlexFieldValue()メソッド

フレックスフィールドの値を返すために使用します。

使用方法

public java.lang.String getFlexFieldValue(java.lang.String pI_Instance,
java.lang.String pI_Object, java.lang.String pFlexFieldCode)

説明

このメソッドは、オブジェクト・インスタンスのフレックスフィールドの値を返します。

パラメータ

パラメータ	タイプ	説明
pI_Instance	文字列	オブジェクト・インスタンス・ウィンドウの「バージョン」タブに表示される、オブジェクト・インスタンスの内部ID
pI_Object	文字列	そのオブジェクト・タイプの「オブジェクト」ウィンドウの「バージョン」タブに表示される、オブジェクト・タイプの内部ID
pPropertyName	文字列	値が返されるフレックスフィールド・コード

例

<%=odiRef.getFlexFieldValue("32001","2400","MY_DATASTORE_FIELD")%>

タイプがdatastore (datastoreの内部IDは2400)で、内部IDが32001のオブジェクト・インスタンスの、フレックスフィールドMY_DATASTORE_FIELDの値を返します。

A.2.19 getFormattedName()メソッド

テキストおよびODI接頭辞を付けて名前を構成する場合に使用します。

使用方法

public java.lang.String getFormattedName(java.lang.String pName)

public java.lang.String getFormattedName(java.lang.String pName,java.lang.String pTechnology)

説明

テキストおよびODI接頭辞に基づく名前を構成する場合に使用し、オプションのテクノロジに有効です。テキストには、getObjectName()メソッドに使用可能な接頭辞(%INT_PRF、%COL_PRF、%ERR_PRF、%IDX_PRFなど)、および%UNIQUE_STEP_TAGまたは%UNIQUE_SESSION_TAGを含めることができます。後のほうのタグは、一意の名前が有効になると展開されます。同じパラメータが渡される前提であれば、同じ実行コンテキスト内でこのAPIをコールすると、常に同じ一意の名前が返されます。

パラメータ

パラメータ	タイプ	説明
pName	文字列	初期キーとして使用される名前であり、他のODI接頭辞を含めることができます。
pTechnology	文字列	戻された名前が検証されるオプションのテクノロジ。たとえば、名前の長さなどです。

例

<%=odiRef.getFormattedName("%COL_PRFMY_TABLE%UNIQUE_STEP_TAG_AE", "ORACLE")%>
might result in
C$_MY_TAB7wDiBe80vBog1auacS1xB _AE

<?=getFormattedName( "<%=getTableName("COLL_SHORT_NAME")%>.ctl", "FILE" )%>"
might result in:-
C$_0DEFAULT.ctl
or, if unique names are enabled
C_0DEFAULTAhbxZoeJ2zznXYpnDzhkm.ctl

C$_0

A.2.20 getFrom()メソッド

指定されたコンテキスト内のSQL FROM句を返すために使用します。

使用方法

public java.lang.String getFrom(java.lang.Int pDSIndex)

説明

FROMのSQL文字列を指定されたデータセットのソースのSELECT句から取得します。FROM文は、データセットで使用される表および結合(テクノロジのSQL機能に応じて)から構築されます。

ISOの外部結合とカッコをサポートするテクノロジでは、getFrom()が次のような文字列を返すことがあります。

((CUSTOMER as CUS inner join CITY as CIT on (CUS.CITY_ID = CIT.CITY_ID))
left outer join SALES_PERSON as SP on (CUS.SALES_ID = SP.SALE_ID))

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

マッピングのソースにジャーナル化されたデータストアがある場合、句内のソース表はジャーナル化されたソース・データストアにリンクされたデータ・ビューによって置き換えられます。

ソース・データストアのいずれかが「一時マッピングを導出表として使用(下位選択)」ボックスを選択した一時データストアである場合は、getFromメソッドにより、この一時ソースに対して下位選択文が生成されます。

ソース・データストアでパーティショニングが使用される場合は、このメソッドによりオブジェクト名が返されるときにパーティショニング句が自動的に追加されます。

このメソッドでは、特別なコードを必要とせずに検索が自動的に生成されることに注意してください。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

A.2.21 getGrpBy()メソッド

指定されたコンテキスト内のSQL GROUP BY句全体を返すために使用します。

使用方法

public java.lang.String getGrpBy(java.lang.Int pDSIndex)

説明

SQL GROUP BY文字列を取得します(ロード・フェーズではソース上、統合フェーズではステージング領域上)。この文は、マッピング式に検出された集計変換から自動的に計算されます。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

A.2.22 getGrpByList()メソッド

マッピングの指定されたデータセットに対する各GROUP BY句のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getGrpByList(
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getGrpByList(
java.lang.Int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

マッピングの指定されたデータセットに対するSQL GROUP BYの発生のリストを返します。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

このリストには、ソースまたはターゲット上(使用するナレッジ・モジュールにより異なります)のGROUP BY文の要素が含まれます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切るために使用されます。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
ID	句の内部識別子
EXPRESSION	グループ化文のテキスト

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpByList("group by ", "[EXPRESSION]", " , ", "")%>
<%=odiRef.getHaving()%>

説明: getGrpByList関数は、group byで始まり、各式ごとにカンマによって区切られたパターン(各グループ化式)が繰り返されるselect命令のgroup by句を生成するために使用されます。

関数の最初のパラメータ"group by"は、文字列を「group by」から始めることを示します。
2番目のパラメータ"[EXPRESSION]"は、式によって各グループについてこのパターンを繰り返すことを示します。キーワード[EXPRESSION]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ", "は、パターンの解釈された発生を、カンマで区切ることを示します。
関数の4番目のパラメータ""は、文字列が特定の文字を伴わずに終わることを示します。

A.2.23 getHaving()メソッド

指定されたコンテキスト内のSQL HAVING句全体を返すために使用します。

使用方法

public java.lang.String getHaving(java.lang.Int pDSIndex)

説明

指定されたデータセットに対してSQL文HAVINGを取得します(ロード時はソースで、統合時はステージング領域で)。この文は、検出された集計関数が含まれているフィルタ式から自動的に計算されます。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

例

insert into <%=odiRef.getTable(
"L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
 <%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

A.2.24 getHavingList()メソッド

マッピングの各HAVING句のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getHavingList(
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getHavingList(
java.lang.Int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

マッピングで指定されたデータセットのSQL HAVINGの発生のリストを返します。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

このリストには、ソースまたはターゲット上(使用するナレッジ・モジュールより異なります)で実行される各HAVING式の要素が1つ含まれます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
パラメータ値	説明
ID	句の内部識別子
EXPRESSION	Having式のテキスト

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpByList("group by ", "[EXPRESSION]", " , ", "")%>
<%=odiRef.getHavingList("having ", "([EXPRESSION])", " and ", "")%>

説明: getHavingList関数は、select命令のHaving句を生成するために使用されます。この句はhavingで始まり、各式ごとにandで区切ってパターン(各集計フィルタ式)を繰り返します。

関数の最初のパラメータ"having "は、文字列を「having」で始めることを示します。
2番目のパラメータ"([EXPRESSION])"は、このパターンを各集計フィルタに対して繰り返すことを示します。キーワード[EXPRESSION]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ" and "は、パターンの解釈された発生を、文字列「 and 」で区切ることを示します。
関数の4番目のパラメータ""は、文字列が特定の文字を伴わずに終わることを示します。

A.2.25 getIndex()メソッド

アクションによって処理される特定の索引に関する情報を返すために使用します。

使用方法

public java.lang.String getIndex(java.lang.String pPropertyName)

説明

アクションでは、このメソッドは、DDLコマンドによって現在処理されている索引に関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	索引の内部番号
KEY_NAME	索引の名前
FULL_NAME	ローカル・オブジェクト・マスクで生成された索引のフルネーム
<flexfield code>	この索引のフレックスフィールドの値

A.2.26 getIndexColList()メソッド

アクションによって処理される索引の属性に関する情報を返すために使用します。

使用方法

public java.lang.String getIndexColList(java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

説明

アクションでは、このメソッドはDDLコマンドによって処理される索引の属性のリストを、索引内の位置の順に並べて返します。

このリストには、現在の索引の各属性の要素が含まれます。

パラメータ

パラメータ	タイプ	説明
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン・シーケンス内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	索引属性の名前
COL_HEADING	索引属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始位置(固定ファイル)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: NULLを許可 1: NULLでない
CHECK_FLOW	属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	未使用
CX_COL_NAME	未使用
ALIAS_SEP	別名に対して(テクノロジにより)使用されるグループ化記号
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
<flexfield code>	現在の属性のフレックスフィールド値

A.2.27 getInfo()メソッド

現在のタスクに関する情報を返すために使用します。

使用方法

public java.lang.String getInfo(java.lang.String pPropertyName)

説明

このメソッドは現在のタスクに関する情報を返します。使用可能な情報のリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ERR_NAME	エラー表の名前
I_SRC_SET	現在のタスクがLKMのコンテキストにある場合、現在の実行単位の数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。GUID_SRC_SETが代替です
GUID_SRC_SET	タスクがロード・ナレッジ・モジュールに所属する場合の、現在の実行ユニットのグローバルに一意のID
SRC_SET_NAME	タスクがロード・ナレッジ・モジュールに所属する場合の、現在の実行ユニットの名前
COLL_NAME	ロード中にデータのステージングに使用されるコレクション表の名前
INT_NAME	統合表の名前
TARG_NAME	ターゲット表の名前
SRC_CATALOG	論理スキーマおよびコンテキストから導出されたソース・カタログの名前
SRC_SCHEMA	論理スキーマおよびコンテキストから導出された物理ソース・スキーマの名前
SRC_WORK_CATALOG	論理スキーマおよびコンテキストから導出された物理ソース作業カタログの名前
SRC_WORK_SCHEMA	論理スキーマおよびコンテキストから導出された物理ソース作業スキーマの名前
DEST_CATALOG	論理スキーマおよびコンテキストから導出された物理ターゲット・カタログの名前
DEST_SCHEMA	論理スキーマおよびコンテキストから導出された物理ターゲット・スキーマの名前
DEST_WORK_CATALOG	論理スキーマおよびコンテキストから導出された物理ターゲット作業カタログの名前
DEST_WORK_SCHEMA	論理スキーマおよびコンテキストから導出された物理ターゲット作業スキーマの名前
SRC_TECHNO_NAME	ソース・テクノロジの名前
SRC_CON_NAME	ソース接続の名前
SRC_DSERV_NAME	ソース・マシンのデータ・サーバーの名前
SRC_CONNECT_TYPE	ソース・マシンの接続タイプ
SRC_IND_JNDI	JNDI URLフラグ
SRC_JAVA_DRIVER	ソース接続のJDBCドライバの名前
SRC_JAVA_URL	ソース接続のJDBC URL
SRC_JNDI_AUTHENT	JNDI認証タイプ
SRC_JNDI_PROTO	JNDIソース・プロトコル
SRC_JNDI_FACTORY	JNDIソース・ファクトリ
SRC_JNDI_URL	ソースJNDI URL
SRC_JNDI_RESSOURCE	アクセスされたソースJNDIリソース
SRC_JNDI_USER	ソースに対するJNDI認証のユーザー名
SRC_JNDI_ENCODED_PASS	ソースに対するJNDI認証の暗号化されたパスワード
SRC_USER_NAME	ソース接続のユーザー名
SRC_ENCODED_PASS	ソース接続の暗号化されたパスワード
SRC_FETCH_ARRAY	ソース配列フェッチのサイズ
SRC_BATCH_UPDATE	ソース・バッチ更新のサイズ
SRC_EXE_CHANNEL	ソース接続の実行チャネル
SRC_COL_ALIAS_WORD	ソース・テクノロジで属性を別名と区別するために使用される語
SRC_TAB_ALIAS_WORD	ソース・テクノロジで表を別名と区別するために使用される語
SRC_DATE_FCT	ソース・テクノロジで現在の日付を返す関数
SRC_DDL_NULL	ソースでの表の作成時にキーワードNULLに対して使用する定義を返します。
SRC_MAX_COL_NAME_LEN	ソース・テクノロジでの属性名の最大文字数
SRC_MAX_TAB_NAME_LEN	ソース・テクノロジでの表名の最大文字数
SRC_REM_OBJ_PATTERN	ソース・テクノロジでのリモート・オブジェクトの置換モデル
SRC_LOC_OBJ_PATTERN	ソース・テクノロジでのローカル・オブジェクト名の置換モデル
DEST_TECHNO_NAME	ターゲット・テクノロジの名前
DEST_CON_NAME	ターゲット接続の名前
DEST_DSERV_NAME	ターゲット・マシンのデータ・サーバーの名前
DEST_CONNECT_TYPE	ターゲット・マシンの接続タイプ
DEST_IND_JNDI	ターゲットJNDI URLフラグ
DEST_JAVA_DRIVER	ターゲット接続のJDBCドライバの名前
DEST_JAVA_URL	ターゲット接続のJDBC URL
DEST_JNDI_AUTHENT	ターゲットのJNDI認証タイプ
DEST_JNDI_PROTO	JNDIターゲット・プロトコル
DEST_JNDI_FACTORY	JNDIターゲット・ファクトリ
DEST_JNDI_URL	ターゲットのJNDI URL
DEST_JNDI_RESSOURCE	アクセスされるターゲットJNDIリソース
DEST_JNDI_USER	ターゲットに対するJNDI認証のユーザー名
DEST_JNDI_ENCODED_PASS	ターゲットに対するJNDI認証の暗号化されたパスワード
DEST_USER_NAME	ターゲット接続用のユーザーの名前
DEST_ENCODED_PASS	ターゲット接続用の暗号化されたパスワード
DEST_FETCH_ARRAY	ターゲット配列フェッチのサイズ
DEST_BATCH_UPDATE	ターゲット配列フェッチのサイズ
DEST_EXE_CHANNEL	ターゲット接続の実行チャネル
DEST_COL_ALIAS_WORD	ターゲット・テクノロジで属性を別名と区別するために使用される語
DEST_TAB_ALIAS_WORD	ターゲット・テクノロジで表を別名と区別するために使用される語
DEST_DATE_FCT	ターゲット・テクノロジで現在の日付を返す関数
DEST_DDL_NULL	ターゲットでの表の作成時にキーワードNULLに対して使用する定義を返す関数
DEST_MAX_COL_NAME_LEN	ターゲット・テクノロジでの属性の最大文字数
DEST_MAX_TAB_NAME_LEN	ターゲット・テクノロジでの表名の最大文字数
DEST_REM_OBJ_PATTERN	ターゲット・テクノロジでのリモート・オブジェクトの置換モデル
DEST_LOC_OBJ_PATTERN	ターゲット・テクノロジでのローカル・オブジェクト名の置換モデル
CT_ERR_TYPE	エラー・タイプ(F: フロー、S: 静的)。チェック・ナレッジ・モジュールの場合にのみ適用されます。
CT_ERR_ID	内部のエラー表ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときに有効です。バージョン12cではCT_ERR_GUIDを使用する必要があります。
CT_ERR_GUID	エラー表のグローバルに一意なID
CT_ORIGIN	静的コントロールの名前またはプロジェクト・コードを接頭辞として前につけたマッピングの名前
JRN_NAME	ジャーナル化されたデータストア名
JRN_VIEW	ジャーナル化されたデータストアに関連付けられたビューの名前
JRN_DATA_VIEW	ジャーナル化されたデータストアに関連付けられたデータ・ビューの名前
JRN_TRIGGER	ジャーナル化されたデータストアに関連付けられたトリガーの名前
JRN_ITRIGGER	ジャーナル化されたデータストアに関連付けられた挿入トリガーの名前
JRN_UTRIGGER	ジャーナル化されたデータストアに関連付けられた更新トリガーの名前
JRN_DTRIGGER	ジャーナル化されたデータストアに関連付けられた削除トリガーの名前
SUBSCRIBER_TABLE	サブスクライバ表の名前
CDC_SET_TABLE	CDCセット表の名前
CDC_TABLE_TABLE	セットに関連付けられている表のリストを含むデータストアの名前
CDC_SUBS_TABLE	セットにサブスクライブされたサブスクライバのリストを含むデータストアの名前
CDC_OBJECTS_TABLE	セットに追加されたオブジェクトのリストを含むデータストアの名前
SRC_DEF_CATALOG	ソース物理スキーマの、現在のコンテキストに基づいたカタログの名前
SRC_DEF_SCHEMA	ソース・データ・サーバー用のデフォルト・スキーマ
SRC_DEFW_CATALOG	ソース・データ・サーバー用のデフォルト作業カタログ
SRC_DEFW_SCHEMA	ソース・データ・サーバー用のデフォルト作業スキーマ
DEST_DEF_CATALOG	ターゲット・データ・サーバー用のデフォルト・カタログ
DEST_DEF_SCHEMA	ターゲット・データ・サーバー用のデフォルト・スキーマ
DEST_DEFW_CATALOG	ターゲット・データ・サーバー用のデフォルト作業カタログ
DEST_DEFW_SCHEMA	ターゲット・データ・サーバー用のデフォルト作業スキーマ
SRC_LSCHEMA_NAME	ソース論理スキーマ名
DEST_LSCHEMA_NAME	ターゲット論理スキーマ名
SRC_I_CONNECT	ソース接続の、現在のコンテキストに基づいた数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。SRC_CONNECT_GUIDが12cでの代替です
SRC_CONNECT_GUID	ソース接続のグローバルに一意なID
SRC_I_PSCHEMA	ソース物理スキーマの、現在のコンテキストに基づいた数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。SRC_PSCHEMA_GUIDが12cでの代替です
SRC_PSCHEMA_GUID	ソース物理スキーマの、現在のコンテキストに基づいたグローバルに一意なID
SRC_I_LSCHEMA	ソース論理スキーマの数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。SRC_LSCHEMA_GUIDが12cでの代替です
SRC_LSCHEMA_GUID	ソース論理スキーマのグローバルに一意のID
SRC_I_TECHNO	ソース・テクノロジの数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。SRC_TECHNO_GUIDが12cでの代替です
SRC_TECHNO_GUID	ソース・テクノロジのグローバルに一意なID
DEST_I_CONNECT	ターゲット接続の、現在のコンテキストに基づいた数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。DEST_CONNECT_GUIDが12cでの代替です
DEST_CONNECT_GUID	ターゲット接続のグローバルに一意なID
DEST_I_PSCHEMA	ターゲット物理スキーマの、現在のコンテキストに基づいた数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。DEST_PSCHEMA_GUIDが12cでの代替です
DEST_PSCHEMA_GUID	ターゲット物理スキーマの、現在のコンテキストに基づいたグローバルに一意なID
DEST_I_LSCHEMA	ターゲット論理スキーマの数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。DEST_LSCHEMA_GUIDが12cでの代替です
DEST_LSCHEMA_GUID	ターゲット論理スキーマのグローバルに一意のID
DEST_I_TECHNO	ターゲット・テクノロジの数値ID。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効ですが、リポジトリが12cモードのときにはエラー・メッセージが返されます。DEST_TECHNO_GUIDが12cでの代替です
DEST_TECHNO_GUID	ターゲット・テクノロジのグローバルに一意なID
UNIQUE_STEP_TAG	現在のステップのスコープ内で名前を一意にするために使用されるタグ
UNIQUE_SESSION_TAG	現在のセッションのスコープ内で名前を一意にするために使用されるタグ
IS_CONCURRENT	現在のタスクで一時オブジェクトに一意の名前が使用されている場合、1を返します
SRC_SET_GUID	タスクがロード・ナレッジ・モジュールに属している場合の、現在の実行ユニットのGUID
ODI_MAJOR_VERSION	現在のODIインストールのメジャー・インストール・バージョン。たとえば、現在のリリースが12.1.3.0.0の場合、`12`を返します

例

The current source condition is: <%=odiRef.getInfo("SRC_CON_NAME")%>  on server: <%=odiRef.getInfo("SRC_DSERV_NAME")%>

A.2.28 getJDBCConnection()メソッド

ソースまたはターゲットのJDBC接続を返すために使用します。

使用方法

java.sql.Connection getJDBCConnection(
java.lang.String pPropertyName)

説明

このメソッドは、現在のタスクのソースまたはターゲットのJDBC接続を返します。

注意:

このメソッドは文字列ではなく、JDBC接続オブジェクトを返します。このオブジェクトはタスク内のJavaコードに使用されることがあります。
このメソッドを使用して取得したJDBC接続は、接続の確立後にクローズすることをお薦めします。KMをODIマッピングで使用している場合、同時性が向上します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	返される接続の名前

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
SRC	現在のタスクのソース接続
DEST	現在タスクのターゲット接続
WORKREP	作業リポジトリ接続

例

この接続のソース接続を取得して、文を作成します。

java.sql.Connection sourceConnection = odiRef.getJDBCConnection("SRC");
java.sql.Statement s = sourceConnection.createStatement();

A.2.28.1 getJDBCConnection("WORKREP")

getJDBCConnection("WORKREP")は制限付きAPIです。

マスター・リポジトリ接続にはセキュリティ・データが保持されます。マスター・リポジトリへの直接のJDBCアクセスを取得するユーザーを制御するために、次の条件の下でこのAPIが有効な接続を返します。

マスター・リポジトリおよび作業リポジトリは異なるスキーマにあります。
マスター・リポジトリおよび作業リポジトリは同じスキーマ内にあり、あなたは「マスター・リポジトリ」オブジェクトに対して新しく導入された権限である「JDBC接続の作成」と呼ばれる特定の権限を持っています。

これらの条件が満たされていない場合、odiRef.getJDBCConnection("WORKREP")が次のエラーをスローします。

ODI-14179: セキュリティ上の理由で、ご使用中の作業リポジトリおよびマスター・リポジトリが同じデータベース・スキーマを使用しているためodiRef.getJDBCConnection ("WORKREP")を使用できません。

シナリオ実行中に作業リポジトリ接続への直接のJDBCアクセスが必要な場合、Oracle Data Integrator管理者に依頼してOracle Data Integrator StudioのSecurity Explorerから「マスター・リポジトリ」オブジェクトに対する<JDBC接続の作成>権限を付与してから再試行してください。<JDBC接続の作成>権限は、「Security Explorer」の「オブジェクト」セクションの「マスター・リポジトリ」オブジェクトの下にあることに注意してください。

A.2.29 getJDBCConnectionFromLSchema()メソッド

指定された論理スキーマのJDBC接続を返すために使用します。

使用方法

public java.lang.String getJDBCConnectionFromLSchema(
java.lang.String pLogicalSchemaName,
java.lang.String pContextName)

public java.lang.String getJDBCConnectionFromLSchema(
java.lang.String pLogicalSchemaName)

説明

指定された論理スキーマのJDBC接続を返します。pLogicalSchemaNameにより論理スキーマが特定されます。

最初の構文では、pContextNameパラメータで提供されるコンテキストの論理スキーマが解決されます。

2番目の構文では、現在のコンテキストの論理スキーマが解決されます。

パラメータ

パラメータ	タイプ	説明
pLogicalSchemaName	文字列	オブジェクトの強制論理スキーマの名前
pContextName	文字列	オブジェクトの強制コンテキスト

注意:

このメソッドは文字列ではなく、JDBC接続オブジェクトを返します。このオブジェクトはタスク内のJavaコードに使用されることがあります。
このメソッドを使用して取得したJDBC接続は、接続の確立後にクローズすることをお薦めします。KMをODIマッピングで使用している場合、同時性が向上します。

A.2.30 getJoin()メソッド

マッピングの結合のために生成されたWHERE句セクション全体を返すために使用します。

使用方法

public java.lang.String getJoin(java.lang.Int pDSIndex)

説明

マッピングの指定されたデータセットに対してSQL結合文字列を取得します(ロード時はソースで、統合時はステージング領域で)。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoin()%>
<%=odiRef.getFilter()%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

A.2.31 getJoinList()メソッド

マッピングの各結合のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getJoinList( 
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getJoinList(
java.lang.Int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

WHERE句に対してマッピングの指定されたデータセット内のSQL結合の発生のリストを返します。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

pPatternパラメータはリストの各要素ごとに解釈され、繰り返されて、前の要素からパラメータpSeparatorで区切られます。生成された文字列はpStartから始まり、pEndで終わります。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
ID	結合の内部識別子
EXPRESSION	結合式のテキスト

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getFrom()%>
where (1=1)
<%=odiRef.getJoinList("and ","([EXPRESSION])"," and ","")%>
<%=odiRef.getFilterList("and ","([EXPRESSION])"," and ","")%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

説明: getJoinList関数は、SELECT文のWHERE部分に置く結合式を生成するために使用されます。式は「and」で始まり、各結合ごとに「 and 」で区切ってパターン(各結合の式)を繰り返します。次に例を示します。

関数の最初のパラメータ"and"は、文字列を「and」で始めることを示します。
2番目のパラメータ"([EXPRESSION])"は、このパターンを各結合に対して繰り返すことを示します。キーワード[EXPRESSION]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ" and "は、パターンの解釈された発生を、「 and 」で区切ることを示します(andの前後のスペースに注意してください)。
関数の4番目のパラメータ""は、文字列が特定の文字を伴わずに終わることを示します。

A.2.32 getJrnFilter()メソッド

マッピングのジャーナル化フィルタを返すために使用します。

使用方法

public java.lang.String getJrnFilter(java.lang.Int pDSIndex)

説明

現在のマッピングで指定されたデータセットのSQLジャーナル化フィルタを返します。ジャーナル化された表がソースにある場合、ロード・フェーズでこのメソッドを使用できます。ジャーナル化された表がステージング領域にある場合、統合時にこのメソッドを使用できます。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引

例

<%=odiRef.getJrnFilter()%>

A.2.33 getJrnInfo()メソッド

データストアのジャーナル化に関する情報を返すために使用します。

使用方法

public java.lang.String getJrnInfo(java.lang.String pPropertyName)

説明

モデルやデータストアのジャーナル化の場合はJKM、マッピングの場合はLKMまたはIKMに対するデータストアのジャーナル化に関する情報を返します。

注意:

ジャーナル化の情報を使用できるのは、ODI Studioでコードが生成される場合のみです。同じodiRef.getInfo()コールでも、エージェントで評価される場合(コールが<? ... ?>または<@ ... @>でラップされている場合)は、ランタイム・リポジトリ内でジャーナル化に関するメタデータが使用できなくなるため、空の文字列が返されます。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
FULL_TABLE_NAME	ジャーナル化されたデータストアのフルネーム
JRN_FULL_NAME	ジャーナル・データストアのフルネーム
JRN_FULL_VIEW	ジャーナル化されたデータストアにリンクされたビューのフルネーム
JRN_FULL_DATA_VIEW	ジャーナル化されたデータストアにリンクされたデータ・ビューのフルネーム
JRN_FULL_TRIGGER	ジャーナル化されたデータストアにリンクされたトリガーのフルネーム
JRN_FULL_ITRIGGER	ジャーナル化されたデータストアにリンクされた挿入トリガーのフルネーム
JRN_FULL_UTRIGGER	ジャーナル化されたデータストアにリンクされた更新トリガーのフルネーム
JRN_FULL_DTRIGGER	ジャーナル化されたデータストアにリンクされた削除トリガーのフルネーム
SNP_JRN_SUBSCRIBER	作業スキーマにおけるサブスクライバ表の名前
JRN_NAME	ジャーナル化されたデータストアの名前
JRN_VIEW	ジャーナル化されたデータストアにリンクされたビューの名前
JRN_DATA_VIEW	ジャーナル化されたデータストアにリンクされたデータ・ビューの名前
JRN_TRIGGER	ジャーナル化されたデータストアにリンクされたトリガーの名前
JRN_ITRIGGER	ジャーナル化されたデータストアにリンクされた挿入トリガーの名前
JRN_UTRIGGER	ジャーナル化されたデータストアにリンクされた更新トリガーの名前
JRN_DTRIGGER	ジャーナル化されたデータストアにリンクされた削除トリガーの名前
SUBSCRIBER	サブスクライバの名前
JRN_COD_MOD	ジャーナル化されたデータ・モデルのコード
JRN_METHOD	ジャーナル化モード(一貫または単純)
CDC_SET_TABLE	CDCセットのリストが含まれている表のフルネーム
CDC_TABLE_TABLE	CDCセットを使用してジャーナル化された表のリストが含まれている表のフルネーム
CDC_SUBS_TABLE	CDCセットのサブスクライバのリストが含まれている表のフルネーム
CDC_OBJECTS_TABLE	ジャーナル化パラメータとオブジェクトが含まれている表のフルネーム

例

The table being journalized is <%=odiRef.getJrnInfo("FULL_TABLE_NAME")%>

A.2.34 getLoadPlanInstance()メソッド

ロード計画インスタンス情報を返します。

使用方法

public java.lang.String getLoadPlanInstance (java.lang.String pPropertyName)

説明

このメソッドは、ロード計画の現在の実行インスタンス情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な値のリストです。

パラメータ値	説明
BATCH_ID	説明
BATCH_GUID	参照制約の内部番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
RESTART_ATTEMPTS	代替キーのGUID。
LOAD_PLAN_NAME	参照制約の名前
START_DATE	参照制約のタイプ

例

現在のロード計画<%=odiRef.getLoadPlanInstance("LOAD_PLAN_NAME")%>は、<%=odiRef.getLoadPlanInstance("START_DATE")%>に実行を開始しました。

A.2.35 getModel()メソッド

モデルに関する情報を返すために使用します。

使用方法

public java.lang.String getModel(java.lang.String pPropertyName)

説明

このメソッドは、パーソナライズされたリバース・エンジニアリングの処理時に、現在のデータ・モデルに関する情報を返します。使用可能なデータのリストをpPropertyName値の表に示します。

注意:

このメソッドはソース接続(リバース・エンジニアリングされるデータ・サーバー)上でも、ターゲット接続(リポジトリ)上でも使用できます。ターゲット接続では、コンテキストから独立したプロパティのみを指定できます(たとえば、スキーマ名やカタログ名は使用できません)。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な値のリストです。

パラメータ値	説明
ID	説明
GLOBAL_ID	参照制約の内部番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
MOD_NAME	代替キーのGUID。
LSCHEMA_NAME	参照制約の名前
MOD_TEXT	参照制約のタイプ
REV_TYPE	参照表の別名(複合式の場合のみ使用)
REV_UPDATE	参照された表の別名(複合式の場合のみ使用)
REV_INSERT	参照された表の内部番号
REV_OBJ_PATT	参照されたモデルの番号
REV_OBJ_TYPE	現在のコンテキストで参照された表のカタログ
TECH_INT_NAME	現在のコンテキストで参照された表の物理スキーマ
LAGENT_NAME	参照された表の名前
REV_CONTEXT	結合句の複合SQL文(該当する場合)
REV_ALIAS_LTRIM	参照制約のエラー・メッセージ
CKM	ローカル・オブジェクト・マスクで生成された外部キーのフルネーム
RKM	この参照のフレックスフィールド値
SCHEMA_NAME	現在のリバース・コンテキストでのデータ・スキーマの物理名
WSCHEMA_NAME	現在のリバース・コンテキストでの作業スキーマの物理名
CATALOG_NAME	現在のリバース・コンテキストでのデータ・カタログの物理名
WCATALOG_NAME	現在のリバース・コンテキストでの作業カタログの物理名
<flexfield code>	現在のモデルのフレックスフィールドの値

例

リバースするオブジェクトのマスクの一部である表のリストを取得します。

select TABLE_NAME,
         RES_NAME,
     replace(TABLE_NAME, '<%=odiRef.getModel("REV_ALIAS_LTRIM")%>' , '')
          ALIAS,
          TABLE_DESC
from MY_TABLES
where
TABLE_NAME like '<%=odiRef.getModel("REV_OBJ_PATT")%>'

A.2.36 getNbInsert()、getNbUpdate()、getNbDelete()、getNbErrors()およびgetNbRows()メソッド

現在のタスクに対して挿入、更新、削除された行数またはエラーになった行数を取得するために使用します。

使用方法

public java.lang.Long getNbInsert()

public java.lang.Long getNbUpdate()

public java.lang.Long getNbDelete()

public java.lang.Long getNbErrors()

public java.lang.Long getNbRows()

説明

これらのメソッドは、現在のタスクに対して次の値を取得します。

挿入された行数(getNbInsert)
更新された行数(getNbUpdate)
削除された行数(getNbDelete)
エラーになった行数(getNbErrors)
このタスク時に処理された行の総数(getNbRows)

これらの数は、setNbInsert()、setNbUpdate()、setNbDelete()、setNbErrors()およびsetNbRows()メソッドを使用して処理された行の実際の数とは別に設定できます。

例

次のJythonの例では、挿入行数を定数値50に設定し、この値をエラーの数にコピーしています。

InsertNumber=50

odiRef.setNbInsert(InsertNumber)

odiRef.setNbErrors(odiRef.getNbInsert())

A.2.37 getNewColComment()メソッド

アクションによって処理される特定の属性の新しいコメントを返すために使用します。

使用方法

public java.lang.String getNewColComment()

説明

アクションでは、このメソッドは、列のコメントの変更アクションで、DDLコマンドによって処理されている属性の新しいコメントを返します。

A.2.38 getNewTableComment()メソッド

アクションによって処理される特定の表の新しいコメントを返すために使用します。

使用方法

public java.lang.String getNewTableComment()

説明

アクションでは、このメソッドは、表のコメントの変更アクションで、DDLコマンドによって処理されている表の新しいコメントを返します。

A.2.39 getNotNullCol()メソッド

NOT NULLをチェックする属性に関する情報を返すために使用します。

使用方法

public java.lang.String getNotNullCol(java.lang.String pPropertyName)

説明

このメソッドはチェック・プロシージャの間、データストアのNOT NULL属性に関する情報を返します。現在のタスクにmandatoryというタグが付けられている場合、チェック・ナレッジ・モジュールからアクセスできます。

パラメータ

パラメータ	タイプ	説明
パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	現在の属性の内部識別子このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GLOBAL_ID	現在の属性のGUID。
COL_NAME	Not null属性の名前
MESS	標準エラー・メッセージ
<flexfield code>	現在のnot null属性のフレックスフィールド値

例

insert into...
select *
from ...
<%=odiRef.getNotNullCol("COL_NAME")%> is null

A.2.40 getObjectName()メソッド

オブジェクトの完全修飾名を返すために使用します。

使用方法

public java.lang.String getObjectName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLocation)

public java.lang.String getObjectName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getObjectName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pContextName,
java.lang.String pLocation)

public java.lang.String getObjectName(
java.lang.String pObjectName,
java.lang.String pLocation)

public java.lang.String getObjectName(
java.lang.String pObjectName)

public java.lang.String getObjectName(java.lang.String pMode,java.lang.String pObjectName,java.lang.String pLogicalSchemaName,java.lang.String pContextName,java.lang.String pLocation,
java.lang.String pPartitionType,
java.lang.String pPartitionName)

説明

カタログとスキーマを含む、物理オブジェクトのフルネームを返します。pModeパラメータは、使用する置換マスクを示します。

注意:

getObjectNameメソッドは、オブジェクト名を、テクノロジで許容されるオブジェクトの最大長に自動で切り捨てます。ODI 11gより前のバージョンでは、オブジェクト名は切り捨てられません。オブジェクト名を切り捨てず、10gの動作を再現するには、データ・サーバーのプロパティ・タブでOBJECT_NAME_LENGTH_CHECK_OLDというプロパティを追加し、その値をtrueに設定します。

最初の構文は、現在のコンテキストでの現在の論理スキーマに応じて、オブジェクト名を作成します。

2番目の構文は、現在のコンテキストで、pLogicalSchemaNameパラメータに示された論理スキーマに応じて、オブジェクトの名前を作成します。

3番目の構文は、pLogicalSchemaNameおよびpContextNameパラメータに示された論理スキーマとコンテキストから名前を作成します。

4番目の構文は、現在のコンテキストでの現在の論理スキーマに応じて、ローカル・オブジェクト・マスクを使用してオブジェクト名を作成します(pMode = "L")。

5番目の構文は4番目と同じですが、pLocation = "D"です。

最後の構文は3番目の構文と同じですが、pPartitionTypeおよびpPartitionNameパラメータを使用して、特に指定されたパーティションでオブジェクト名を修飾します。

パラメータ

パラメータ	タイプ	説明
pMode	文字列	"L"はローカル・オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。"R"はリモート・オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。注意: リモート・オブジェクト・マスクを使用する場合、getObjectNameは常にリモート・サーバーのデフォルト物理スキーマを使用してオブジェクト名前を解決します。
pObjectName	文字列	有効なリソース名(表またはファイル)を表すすべての文字列。このオブジェクト名には接頭辞を付けておくことができます。この接頭辞は、実行時に、物理スキーマで定義された適切な一時オブジェクト接頭辞に置き換えられます。
pLogicalSchemaName	文字列	オブジェクトの強制論理スキーマの名前
pContextName	文字列	オブジェクトの強制コンテキスト
pLocation	文字列	有効な値は次のとおりです。 W: 物理カタログのオブジェクトと、指定されたタプル(コンテキスト、論理スキーマ)に対応する作業物理スキーマの完全名を返します。 D: 物理カタログのオブジェクトと、指定されたタプル(コンテキスト、論理スキーマ)に対応するデータ物理スキーマの完全名を返します。
pPartitionType	文字列	特定のパーティションまたはサブパーティションのオブジェクト名を修飾するかどうかを指定します。有効な値は次のとおりです。 P: pPartitionNameで指定されるパーティションのオブジェクトを修飾します。 S: pPartitionNameで指定されるサブパーティションのオブジェクトを修飾します。
pPartitionName	文字列	オブジェクト名を修飾するためのサブパーティションのパーティションの名前

接頭辞

pObjectNameパラメータで指定されたリソース名に接頭辞コードを付加することで、Oracle Data Integrator一時オブジェクト名(エラー表または統合表、ジャーナル化トリガーなど)を生成することができます。

接頭辞のリストを次に示します。

Prefix	説明
Prefix	説明
%INT_PRF	統合表の接頭辞(デフォルト値は「I$_」)
%COL_PRF	ロード表の接頭辞(デフォルト値は「C$_」)
%ERR_PRF	エラー表の接頭辞(デフォルト値は「E$_」)
%JRN_PRF_TAB	ジャーナル化表の接頭辞(デフォルト値は「J$_」)
%INT_PRF_VIE	ジャーナル化ビューの接頭辞(デフォルト値は「JV$_」)
%JRN_PRF_TRG	ジャーナル化トリガーの接頭辞(デフォルト値は「T$_」)
%IDX_PRF	一時索引の接頭辞(デフォルト値は「IX$_」)
%UNIQUE_STEP_TAG	一時オブジェクトに一意の名前が有効になっていることをコード生成の最終フェーズに通知するために使用される接頭辞。
%UNIQUE_SESSION_TAG	一時オブジェクトに一意の名前が有効になっていることをコード生成の最終フェーズに通知するために使用される接頭辞。

注意:

一時オブジェクトは通常、作業物理スキーマに作成されます。そのため、接頭辞を使用して一時オブジェクトを作成するか、一時オブジェクトにアクセスする場合は、pLocationを「W」に設定します。

例

定義されている物理スキーマ

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_owner

この物理スキーマを関連付けている論理スキーマ: MSSQL_ODI(コンテキストはCTX_DEV)

コール対象	戻り値
`<%=odiRef.getObjectName("L", "EMP", "MSSQL_ODI", "CTX_DEV", "W")%>`	`tempdb.temp_owner.EMP`
`<%=odiRef.getObjectName("L", "EMP", "MSSQL_ODI", "CTX_DEV", "D")%>`	`db_odi.dbo.EMP`
`<%=odiRef.getObjectName("R", "%ERR_PRFEMP", "MSSQL_ODI", "CTX_DEV", "W")%>`	`MyServer.tempdb.temp_owner.E$_EMP`
`<%=odiRef.getObjectName("R", "EMP", "MSSQL_ODI", "CTX_DEV", "D")%>`	`MyServer.db_odi.dbo.EMP`

A.2.41 getObjectNameDefaultPSchema()メソッド

データ・サーバーのデフォルト物理スキーマでのオブジェクトの完全修飾名を返すために使用します。

使用方法

public java.lang.String getObjectNameDefaultPSchema(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLocation)

public java.lang.String getObjectNameDefaultPSchema(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getObjectNameDefaultPSchema(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pContextName,
java.lang.String pLocation)

public java.lang.String getObjectNameDefaultPSchema(
java.lang.String pObjectName,
java.lang.String pLocation)

public java.lang.String getObjectNameDefaultPSchema(
java.lang.String pObjectName)

public java.lang.String getObjectNameDefaultPSchema(java.lang.String pMode,java.lang.String pObjectName,java.lang.String pLogicalSchemaName,java.lang.String pContextName,java.lang.String pLocation,
java.lang.String pPartitionType,
java.lang.String pPartitionName)

説明

このメソッドはgetObjectNameメソッドに類似しています。ただし、オブジェクト名は、物理スキーマがアタッチされるデータ・サーバーのデフォルト物理スキーマに対して導出されます。getObjectNameでは、オブジェクト名は物理スキーマ自身に対して導出されます。

詳細は、「getObjectName()メソッド」を参照してください。

A.2.42 getObjectShortName()メソッド

オブジェクトの短縮名を返すために使用します。

使用方法

public java.lang.String getObjectShortName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLocation)

public java.lang.String getObjectShortName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getObjectShortName(
java.lang.String pMode,
java.lang.String pObjectName,
java.lang.String pLogicalSchemaName,
java.lang.String pContextName,
java.lang.String pLocation)

説明

スキーマおよびカタログ接頭辞を付けずにオブジェクト名を返しますが、必要に応じてデリミタを追加します。

pModeパラメータは、使用する置換マスクを示します。

パラメータ

パラメータ	タイプ	説明
pMode	文字列	"L"はローカル・オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。"R"はリモート・オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。注意: リモート・オブジェクト・マスクを使用する場合、getObjectShortNameは常にリモート・サーバーのデフォルト物理スキーマを使用してオブジェクト名前を解決します。
pObjectName	文字列	有効なリソース名(表またはファイル)を表すすべての文字列。このオブジェクト名には接頭辞を付けておくことができます。この接頭辞は、実行時に、物理スキーマで定義された適切な一時オブジェクト接頭辞に置き換えられます。
pLogicalSchemaName	文字列	オブジェクトの強制論理スキーマの名前
pContextName	文字列	オブジェクトの強制コンテキスト
pLocation	文字列	有効な値は次のとおりです。 W: 物理カタログのオブジェクトと、指定されたタプル(コンテキスト、論理スキーマ)に対応する作業物理スキーマの完全名を返します。 D: 物理カタログのオブジェクトと、指定されたタプル(コンテキスト、論理スキーマ)に対応するデータ物理スキーマの完全名を返します。

接頭辞

テキストには、getObjectName()メソッドに使用可能な接頭辞(%INT_PRF、%COL_PRF、%ERR_PRF、%IDX_PRFなど)を含めることができます。

論理スキーマがOracle SCOTTスキーマを指している場合の例を次に示します。

<%= odiRef.getObjectShortName("L", "%COL_PRFEMP", "D") %>

この場合、次の文字列が返されます。

C$EMP

例

ローカル作業スキーマがOracleテクノロジである場合の例を次に示します。

<%= odiRef.getObjectShortName("L", "ABC", "W") %>

この場合、生成済コードでABCが生成されます。

<%= odiRef.getObjectShortName("L", "abc", "W") %>

この場合は、生成済コードで"abc" (二重引用符付き)が生成されます。

A.2.43 getOdiInstance()メソッド

ODIのマスター/作業リポジトリ・カップルへの接続の現在のセッション・インスタンスを返すために使用します。

使用方法

public oracle.odi.core.OdiInstance getOdiInstance(java.lang.String pPropertyName)

説明

ODIのマスター/作業リポジトリ・カップルへの接続の現在のセッション・インスタンスを返します。

OdiInstanceはODIコア・インフラストラクチャの中心クラスで、ODIのマスター/作業リポジトリ・カップルへの読取り/書込みアクセスを必要とするODIコンシューマに必要なロー・レベルのインフラストラクチャ・サービスを提供します。このメソッドは、ODIプロシージャのJythonまたはGroovyあるいはナレッジ・モジュールで使用できます。ユーザーがインスタンスのクローズを担当します。

A.2.44 getOption()メソッド

KMまたはプロシージャのオプションの値を返すために使用します。

使用方法

public java.lang.String getOption(java.lang.String pOptionName)
public java.lang.String getUserExit(java.lang.String pOptionName)

説明

KMまたはプロシージャのオプションの値を返します。

getUserExit構文は非推奨で、互換性上の理由で残されているだけです。

パラメータ

パラメータ	タイプ	説明
pOptionName	文字列	リクエストされたオプションの名前が含まれている文字列

例

The value of my MY_OPTION_1 option is <%=odiRef.getOption("MY_OPTION_1")%>

A.2.45 getPackage()メソッド

現在のパッケージに関する情報を返すために使用します。

使用方法

public java.lang.String getPackage(java.lang.String pPropertyName)

説明

このメソッドは、現在のパッケージに関する情報を返します。使用可能なプロパティのリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
I_PACKAGE	パッケージの内部ID。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
PACKAGE_GUID	パッケージのGUID。
PACKAGE_NAME	パッケージの名前
<flexfield code>	このパッケージのフレックスフィールドの値

例

Package <%=odiRef.getPackage("PACKAGE_NAME")%> is running.

A.2.46 getParentLoadPlanStepInstance()メソッド

このセッションの親ロード計画ステップ・インスタンスを返します。

使用方法

public java.lang.String getParentLoadPlanStepInstance(java.lang.String pPropertyName)

説明

このメソッドは、ロード計画インスタンスの現在のステップの親のステップ実行インスタンス情報を返します。親ステップがルート・ステップの場合、空の文字列が返されます。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
BATCH_ID	ロード計画インスタンスの識別子(インスタンスID)。ロード計画が開始されるたびに、一意の識別子が付いた新しいロード計画インスタンスが作成されます。
RESTART_ATTEMPTS	このロード計画親ステップ・インスタンスの実行試行の番号。この番号は、ロード計画親ステップ・インスタンスが最初に開始されると1から始まり、ロード計画親ステップ・インスタンスが再開するたびに増分されます。
STEP_NAME	ロード計画親ステップの名前
STEP_TYPE	ロード計画親ステップのタイプ
START_DATE	現在のロード計画インスタンスの現在のステップの親ステップ・インスタンスが実行される開始日付と時刻。

例

ステップ<%=odiRef.getParentLoadPlanStepInstance("STEP_NAME")%>は、<%=odiRef.getParentLoadPlanStepInstance("RESTART_ATTEMPTS")%>回実行されました。

A.2.47 getPK()メソッド

主キーに関する情報を返すために使用します。

使用方法

public java.lang.String getPK(java.lang.String pPropertyName)

説明

このメソッドはチェック・プロシージャの間、データストアの主キーに関する情報を返します。

アクションでは、このメソッドは、DDLコマンドによって現在処理されている主キーに関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
ID	PK制約の内部番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
PACKAGE_GUID	主キーのGUID。
KEY_NAME	主キーの名前
MESS	主キー制約に関するエラー・メッセージ
FULL_NAME	ローカル・オブジェクト・マスクで生成されたPKのフルネーム
<flexfield code>	主キーのフレックスフィールド値

例

The primary key of my table is called: <%=odiRef.getPK("KEY_NAME")%>

A.2.48 getPKColList()メソッド

主キーの属性に関する情報を返すために使用します。

使用方法

public java.lang.String getPKColList( java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

説明

チェックされている主キーの属性と式のリストを返します。

このリストには、現在の主キーの各属性の要素が含まれます。現在のタスクにprimary keyというタグが付けられている場合、チェック・ナレッジ・モジュールからアクセスできます。

アクションでは、このメソッドは、DDLコマンドによって処理された主キーの属性のリストを、キー内の位置の順に並べて返します。

パラメータ

パラメータ	タイプ	説明
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン・シーケンス内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	キー属性の名前
COL_HEADING	キー属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始位置(固定ファイル)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: NULLを許可 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	未使用
CX_COL_NAME	未使用
ALIAS_SEP	別名に対して(テクノロジにより)使用されるグループ化記号
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
<flexfield code>	現在の属性のフレックスフィールド値

例

CUSTOMER表に主キーPK_CUSTOMER (CUST_ID, CUST_NAME)があり、作成するコードが次のようである場合:

create table T_PK_CUSTOMER (CUST_ID numeric(10) not null, CUST_NAME
varchar(50) not null)

次のように記述します。

create table T_<%=odiRef.getPK("KEY_NAME")%>
<%=odiRef.getPKColList("(", "[COL_NAME] [DEST_CRE_DT] not null", ", ", ")")%>

説明: getPKColList関数は、(CUST_ID numeric(10) not null, CUST_NAME varchar(50) not null)の部分を生成するために使用されます。これはカッコで始まりカッコで終わり、主キーの各属性について、カンマで区切られたパターン(属性、データ型、NOT NULL)を繰り返します。このため、

関数の最初のパラメータ"("は、文字列を、文字列「(」で始めることを示します。
2番目のパラメータ"[COL_NAME] [DEST_CRE_DT] not null"は、このパターンを主キーの各属性に対して繰り返すことを示します。キーワード[COL_NAME]および[DEST_CRE_DT]は、表「パターン属性リスト」の有効なキーワードを参照します。
3番目のパラメータ", "は、パターンの解釈された発生を、文字列「,」で区切ることを示します。
4番目のパラメータ")"は、文字列が、文字列「)」で終わることを示します。

A.2.48.1 getPop()メソッド

マッピングに関する情報を返すために使用します。

使用方法

public java.lang.String getPop(java.lang.String pPropertyName)

説明

このメソッドは現在のマッピングに関する情報を返します。使用可能な情報のリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
I_POP	マッピングの内部番号
FOLDER	マッピングのフォルダ名
POP_NAME	マッピングの名前。
IND_WORK_TARG	ステージング領域の位置フラグ
LSCHEMA_NAME	マッピングのステージング領域である論理スキーマの名前
DESCRIPTION	マッピングの説明
WSTAGE	ターゲット・データストアの性質を示しているフラグ: E - ターゲット・データストアは既存の表です(一時表ではありません)。 N - ターゲット・データストアはデータ・スキーマ内の一時表です。 W - ターゲット・データストアは作業スキーマ内の一時表です。
TABLE_NAME	ターゲット表の名前。
KEY_NAME	更新キーの名前
DISTINCT_ROWS	重複抑制フラグ
OPT_CTX	マッピングの最適化コンテキストの名前
TARG_CTX	マッピングの実行コンテキストの名前
MAX_ERR	許容される最大エラー数
MAX_ERR_PRCT	割合によるエラー・インジケータ
IKM	このマッピングで使用される統合ナレッジ・モジュールの名前
LKM	ステージング領域に対して単一テクノロジIKMが選択されている場合に、ステージング領域からターゲットにデータをロードするために指定されるロード・ナレッジ・モジュールの名前
CKM	このマッピングで使用されるチェック・ナレッジ・モジュールの名前
HAS_JRN	マッピングのソースにジャーナル化された表がある場合、1を返します。それ以外の場合は0を返します。
PARTITION_NAME	ターゲット・データストアに選択されているパーティションまたはサブパーティションの名前。パーティションが選択されていない場合は、空の文字列を返します。
PARTITION_TYPE	ターゲット・データストアに選択されているパーティションまたはサブパーティションのタイプ。パーティションが選択されていない場合は、空の文字列を返します。 P: パーティション S: サブパーティション
<flexfield code>	マッピングのフレックスフィールド値
IS_CONCURRENT	一時オブジェクトに一意の名前が使用されている場合は1を返し、それ以外の場合は0を返します。

例

The current mapping is: <%=odiRef.getPop("POP_NAME")%> and runs on the logical schema: <%=odiRef.getInfo("L_SCHEMA_NAME")%>

A.2.49 getPrevStepLog()メソッド

パッケージで前に実行された手順に関する情報を返すために使用します。

使用方法

public java.lang.String getPrevStepLog(java.lang.String pPropertyName)

説明

パッケージで最後に実行された手順についての情報を返します。リクエストされた情報は、pPropertyNameパラメータを使用して指定されます。前の手順がない場合(たとえば、getPrevStepLog手順がパッケージ外部から実行される場合)は、「No previous step」例外が発生します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	前の手順についてリクエストされたプロパティの名前が含まれる文字列。次に示す、有効プロパティのリストを参照してください。

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
SESS_NO	セッションの番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
SESS_GUID	セッションのGUID。
NNO	パッケージ内部の手順の番号。実行された最初の手順は0です。
STEP_NAME	手順の名前
STEP_TYPE	手順のタイプを示しているコード。次の値が返されます。 F: マッピング VD: 変数宣言 VS: 変数の設定/増分 VE: 変数の評価 V: 変数のリフレッシュ T: プロシージャ OE: OSコマンド SE: ODIツール RM: モデルのリバースエンジニアリング CM: モデルのチェック CS: サブモデルのチェック CD: データストアのチェック JM: モデルのジャーナル化 JD: データストアのジャーナル化
CONTEXT_NAME	手順が実行されたコンテキストの名前
MAX_ERR	許容されるエラーの最大数またはその割合
MAX_ERR_PRCT	最大エラー数が割合で表されている場合は1、それ以外の場合は0 を返します。
RUN_COUNT	この手順がこれまでに実行された回数
BEGIN	手順が開始された日付と時刻
END	手順が終了した日付と時刻
DURATION	手順を実行するのにかかった時間(単位は秒)
STATUS	前の手順の終了ステータスを示している1文字のコードを返します。状態R(実行中)が返されることはありません。 D: 終了(成功) E: エラー Q: キュー化 W: 待機中 M: 警告
RC	リターン・コード。0はエラーがないことを示します。
MESSAGE	前の手順により返されたエラー・メッセージがある場合、そのメッセージ。エラーがない場合は空の文字列
INSERT_COUNT	手順によって挿入された行数
DELETE_COUNT	手順によって削除された行数
UPDATE_COUNT	手順によって更新された行数
ERROR_COUNT	品質管理手順の場合の、手順によって検出されたエラーのある行の数

例

Previous step '<%=odiRef.getPrevStepLog("STEP_NAME")%>' executed
in '<%=odiRef.getPrevStepLog("DURATION")%>' seconds.

A.2.50 getQuotedString()メソッド

引用文字列を返すために使用します。

使用方法

public java.lang.String getQuotedString(java.lang.String pString)

説明

このメソッドは引用符で囲まれた文字列を返します。引用符や、文字列に表示される可能性がある\n、\tなどのエスケープ文字は維持されます。

このメソッドは、Java、Groovy、またはJythonコードで、値として渡された文字列を保護するのに有効です。

パラメータ

パラメータ	タイプ	説明
パラメータ	タイプ	説明
pString	文字列	引用符で保護する文字列

例

次のJavaコードでは、有効な文字列値を生成するためにgetQuotedStringメソッドが使用されています。

String condSqlOK = <%=odiRef.getQuotedString(odiRef.getCK("MESS"))%>;
String condSqlKO = <%=odiRef.getCK("MESS")%>;

条件のメッセージが"Error:\n Zero is not a valid value"である場合、生成されるコードは次のようになります。getQuotedStringを使用しないと、\nが維持されず、改行になってしまうため、コードは正しくありません。

String condSqlOK = "Error:\n Zero is not a valid value";
String condSqlKO = "Error:
Zero is not a valid value";

A.2.51 getSchemaName()メソッド

トポロジから取得したスキーマ名を返すために使用します。

使用方法

public java.lang.String getSchemaName(
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getSchemaName(
java.lang.String pLogicalSchemaName,
java.lang.String pContextCode,
java.lang.String pLocation)

public java.lang.String getSchemaName( java.lang.String pLocation)


public java.lang.String getSchemaName()

説明

データ・スキーマまたは作業スキーマの物理名を論理スキーマから取得します。

最初の構文が使用される場合、返されるスキーマは現在のコンテキストに対応します。

2番目の構文が使用される場合、返されるスキーマはpContextCodeパラメータで指定されたコンテキストに対応します。

3番目の構文は、現在のコンテキスト、現在の論理スキーマでのデータ・スキーマ(D)または作業スキーマ(W)の名前を返します。

4番目の構文は、現在のコンテキスト、現在の論理スキーマでのデータ・スキーマ(D)の名前を返します。

パラメータ

パラメータ	タイプ	説明
pLogicalSchemaName	文字列	スキーマの論理スキーマの名前
pContextCode	文字列	スキーマの強制コンテキスト
pLocation	文字列	有効な値は次のとおりです。 D: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマのデータ・スキーマを返します。 W: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマの作業スキーマを返します。

例

定義されている物理スキーマ: Pluton.db_odi.dbo

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_owner

この物理スキーマを関連付けている論理スキーマ: MSSQL_ODI(コンテキストはCTX_DEV)

コール対象	戻り値
`<%=odiRef.getSchemaName("MSSQL_ODI", "CTX_DEV", "W")%>`	`temp_owner`
`<%=odiRef.getSchemaName("MSSQL_ODI", "CTX_DEV", "D")%>`	`dbo`

A.2.52 getSchemaNameDefaultPSchema()メソッド

トポロジからデフォルトの物理スキーマのカタログ名を返すために使用します。

使用方法

public java.lang.String getSchemaNameDefaultPSchema(
java.lang.String pLogicalSchemaName,
java.lang.String pLocation)

public java.lang.String getSchemaNameDefaultPSchema(
java.lang.String pLogicalSchemaName,
java.lang.String pContextCode,
java.lang.String pLocation)

public java.lang.String getSchemaNameDefaultPSchema( 
java.lang.String pLocation)

public java.lang.String getSchemaNameDefaultPSchema(

説明

タプルに対応している物理スキーマ(論理スキーマ、コンテキスト)が関連付けられているデータ・サーバーのデフォルトの物理データ・スキーマまたは作業スキーマの名前を取得できます。コンテキストを指定しない場合、現在のコンテキストが使用されます。論理スキーマ名が指定されない場合、現在の論理スキーマが使用されます。pLocationが指定されない場合、データ・スキーマが返されます。

パラメータ

パラメータ	タイプ	説明
pLogicalSchemaName	文字列	論理スキーマの名前
pContextCode	文字列	強制適用されたスキーマのコンテキストのコード
pLocation	文字列	有効な値は次のとおりです。 D: タプル(コンテキスト、論理スキーマ)に対応する物理スキーマのデータ・スキーマを返します。 W: タプル(コンテキスト、論理スキーマ)に対応している物理スキーマもアタッチされているデータ・サーバーに関連付けられている、デフォルトの物理スキーマの作業スキーマを返します。

例

定義されている物理スキーマ: Pluton.db_odi.dbo

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_odi
デフォルト・スキーマか	はい

この物理スキーマに関連付けられているもの: コンテキストCTX_DEVのMSSQL_ODIおよびPluton.db_doc.doc

データ・カタログ:	db_doc
データ・スキーマ:	doc
作業カタログ:	tempdb
作業スキーマ:	temp_doc
デフォルト・スキーマか	いいえ

この物理スキーマに関連付けられているもの: コンテキストCTX_DEVのMSSQL_DOC

コール対象	戻り値
`<%=odiRef.getSchemaNameDefaultPSchema("MSSQL_DOC", "CTX_DEV", "W")%>`	`temp_odi`
`<%=odiRef.getSchemaNameDefaultPSchema("MSSQL_DOC", "CTX_DEV", "D")%>`	`dbo`

A.2.53 getSession()メソッド

現在のセッションに関する情報を返すために使用します。

使用方法

public java.lang.String getSession(java.lang.String pPropertyName)

説明

このメソッドは現在のセッションに関する情報を返します。使用可能なプロパティのリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
SESS_NO	セッションの内部番号。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
SESS_GUID	セッションのGUID。
SESS_NAME	セッションの名前。
SCEN_NAME	シナリオの名前
SCEN_VERSION	現在のシナリオのバージョン
CONTEXT_NAME	実行コンテキストの名前
CONTEXT_CODE	実行コンテキストのコード
AGENT_NAME	実行を担当する物理エージェントの名前
SESS_BEG	セッション開始の日付と時刻
USER_NAME	セッションを実行しているODIユーザー

例

The current session is: <%=odiRef.getSession("SESS_NAME")%>

A.2.54 getSessionVarList()メソッド

今後使用する目的で確保されているコマンドです。

使用方法

public java.lang.String getSessionVarList( java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd,
java.lang.String pSelector)

説明

今後使用する目的で確保されているコマンドです。

パラメータ

今後使用する目的で確保されているコマンドです。

例

今後使用する目的で確保されているコマンドです。

A.2.55 getSrcColList()メソッド

ロード・フェーズまたは統合フェーズに関連したソース属性のフィルタ済リストから、各属性のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getSrcColList(
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pUnMappedPattern,
java.lang.String pMappedPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

public java.lang.String getSrcColList(
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

public java.lang.String getSrcColList(
java.lang.String pStart,
java.lang.String pUnMappedPattern,
java.lang.String pMappedPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

public java.lang.String getSrcColList(
int dsIndex,
java.lang.String pStart,
java.lang.String pUnMappedPattern,
java.lang.String pMappedPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

説明

このメソッドはLKMとIKMに用意されていて、指定されたデータセット内の属性のリストのプロパティを返します。このリストはLKM(ソース)またはIKM(ステージング領域)によって処理されたソースのすべての属性を含みます。リストは、ソース表内の属性位置を基準にソートされます。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

表示されるプロパティは、属性がマップされているかどうかにより異なります。属性がマップされている場合、返されるプロパティはpMappedPatternパターンで定義されます。属性がマップされていない場合、返されるプロパティはpUnMappedPatternパターンで定義されます。

パターンで使用できる属性のリストは、「パターン属性リスト」に詳述されます。属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([ ])で囲む必要があります。例: "My string [COL_NAME] is a attribute".

pMappedPatternまたはpUnMappedPatternパラメータがリストの各要素について解釈され、繰り返されます。パターンはpSeparatorで区切られます。生成された文字列はpStartから始まり、pEndで終わります。

バリアントgetSrcColList(String pStart, String pPattern, String pSeparator, String pEnd)でpPatternパラメータが使用されている場合、pUnMappedPatternパラメータとpMappedPatternパラメータの両方で引数として同じpPattern値を使用して、バリアントgetSrcColList(String pStart, String pUnMappedPattern, String pMappedPattern,String pSeparator, String pEnd)がコールされます。

マッピングのソースにジャーナル化されたデータストアがある場合、3つのジャーナル化疑似属性JRN_FLG、JRN_DATEおよびJRN_SUBSCRIBERは、ジャーナル化されたソース・データストアの属性として追加されます。

パラメータ

パラメータ	タイプ	説明
dsIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	pPatternの値が、pUnMappedPatternとpMappedPatternの両方で引数として使用されます。
pUnMappedPattern	文字列	属性がマップされていない場合、パターンはリスト内に現れるたびに繰り返されます。
pMappedPattern	文字列	属性がマップされている場合、パターンはリスト内に現れるたびに繰り返されます。
pSeparator	文字列	このパラメータはパターンを区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	属性の名前。
ALIAS_NAME	属性の名前。COL_NAMEと異なり、オプションのテクノロジ・デリミタを含まない属性名を返します。属性名に、たとえばスペースが含まれる場合、これらのデリミタが表示されます。
COL_HEADING	属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始(索引)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: (0: NULLを許可、1: NOT NULL) 0: NULLを許可 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: (0: チェックしない、1: チェック) 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: (0: チェックしない、1: チェック) 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値: 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
EXPRESSION	ソース(LKM)またはステージング領域(IKM)上で実行された、式のテキスト(マッピング・フィールドに入力したもの)。属性がマップされていない場合、このパラメータは空の文字列を返します。
CX_COL_NAME	サポートされていません。
ALIAS_SEP	別名に対して(テクノロジにより)使用されるセパレータ
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット(IKM)またはステージング領域(LKM)のテクノロジのデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
MANDATORY_CLAUSE	属性が必須の場合、`NOT NULL`を返します。そうでない場合、そのテクノロジのNULLキーワードを返します。
DEFAULT_CLAUSE	デフォルト値が存在する場合、`DEFAULT <デフォルト値>`を返します。そうでない場合は、空の文字列を返します。
<flexfield code>	現在の属性のフレックスフィールド値
POP_ALIAS	マッピングで使用するデータストアの別名。

例

ソース・ファイルに類似した表を作成する場合:

create table <%=odiRef.getTable("L","COLL_NAME", "D")%>_F
(
<%=odiRef.getSrcColList("","[COL_NAME] [DEST_CRE_DT]","[COL_NAME]
[DEST_CRE_DT]",",\n","")%>
)

A.2.56 getSrcTablesList()メソッド

マッピングの各ソース表のプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getSrcTablesList( 
java.lang.Int pDSIndex,
java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getSrcTablesList(
java.lang.Int pDSIndex,
java.lang.String pPattern,
java.lang.String pSeparator)

説明

マッピングで指定されたデータセットのソース表のリストを返します。このメソッドはSELECT 命令にFROM句を作成するために使用できます。ただし、これでなくgetFrom()メソッドを使用することをお薦めします。

IKMで使用される場合のみ、pDSIndexパラメータにより、このコマンドによって考慮されるデータセットが特定されます。

注意:

このメソッドがLKMで使用される場合、pDSIndexは省略できます。IKMの場合も省略可能です。この場合、最初のデータセットが考慮されます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pDSIndex	整数	このコマンドによって考慮されるデータセットを特定する索引
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

Attribute	説明
I_TABLE	現在のソース表の内部識別子(番号がある場合)このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
TABLE_GUID	ソース表のGUID (使用可能な場合)。
MODEL_NAME	現在のソース表のモデルの名前(名前がある場合)
SUB_MODEL_NAME	現在のソース表のサブモデルの名前(名前がある場合)
TECHNO_NAME	ソース・データストアのテクノロジの名前
LSCHEMA_NAME	ソース表の論理スキーマ
TABLE_NAME	ソース・データストアの論理名
RES_NAME	リソースの物理アクセス名(ファイル名またはJMSキュー、表の物理名など)。マッピングのソースにジャーナル化されたデータストアがある場合、句内のソース表は、ジャーナル化されたソース・データストアにリンクされたデータ・ビューによって置き換えられます。
CATALOG	ソース・データストアのカタログ(実行時に解決)
WORK_CATALOG	ソース・データストアの作業カタログ
SCHEMA	ソース・データストアのスキーマ(実行時に解決)
WORK_SCHEMA	ソース・データストアの作業スキーマ
TABLE_ALIAS	表リストに表示されるデータストアの別名(別名がある場合)
POP_TAB_ALIAS	現在のマッピングに表示されるデータストアの別名(別名がある場合)
TABLE_TYPE	データストアのタイプ(使用可能な場合): `Q` = キュー、`S` = シノニム、`T` = 表、`V` = ビュー。
DESCRIPTION	ソース・データストアの説明(説明がある場合)
R_COUNT	ソース・データストアのレコードの数(判明している場合)
FILE_FORMAT	ファイル形式(使用可能な場合): `D` = デリミタ付き、`F` = 固定。
FILE_SEP_FIELD	文字列テキストのファイル・フィールド・セパレータ(タブ文字など)。
XFILE_SEP_FIELD	エスケープ・テキストのファイル・フィールド・セパレータ(タブ文字など)。改行と行頭復帰は`\r`および`\n`にエスケープされ、Unicode文字は`\uXXXX`にエスケープされます。
SFILE_SEP_FIELD	16進形式のファイル・フィールド・セパレータ(例: タブ文字に対する09)。返される文字列は2桁の16進数または4桁の16進数であり、フィールド・セパレータの上位バイトが0であれば2桁の16進数となります。
FILE_ENC_FIELD	データストア・エディタに表示されるテキスト・デリミタ(最大2文字)。
FILE_SEP_ROW	文字列テキストのファイル・レコード・セパレータ。
XFILE_SEP_ROW	エスケープ・テキストのファイル・レコード・セパレータ。改行と行頭復帰は`\r`および`\n`にエスケープされ、Unicode文字は`\uXXXX`にエスケープされます。
SFILE_SEP_ROW	16進形式のファイル・レコード・セパレータ。改行と行頭復帰は`\r`および`\n`にエスケープされ、Unicode文字は`\uXXXX`にエスケープされます。
FILE_FIRST_ROW	無視するヘッダーの行数(ヘッダーがある場合)
FILE_DEC_SEP	データストアのデフォルトの小数点記号(デフォルトがある場合)
METADATA	現在のリソースのメタデータのODI形式の説明(説明がある場合)
OLAP_TYPE	データストアのOLAPタイプ: `DH` = 緩やかに変化するディメンション、`DI` = ディメンション、`FA` = ファクト表、<empty> = 未定義。
IND_JRN	CDCにデータストアが含まれているかを示すフラグ: `1` = はい、`0` = いいえ。
JRN_ORDER	一貫したジャーナル化のためのCDCセット内でのデータストアの順序
PARTITION_NAME	ソース・データストアに選択されているパーティションまたはサブパーティションの名前。パーティションが選択されていない場合は、空の文字列を返します。
PARTITION_TYPE	ソース・データストアに選択されているパーティションまたはサブパーティションのタイプ。パーティションが選択されていない場合は、空の文字列を返します。 P: パーティション S: サブパーティション
<flexfield code>	現在の表のフレックスフィールド値

例

insert into <%=odiRef.getTable("L", "COLL_NAME", "W")%>
select <%=odiRef.getColList("", "[EXPRESSION]", ", ", "", "INS=1")%>
from <%=odiRef.getSrcTablesList("", "[CATALOG].[SCHEMA].[TABLE_NAME] AS [POP_TAB_ALIAS]", ", ", "")%>
where (1=1)
<%=odiRef.getJoinList("and ","([EXPRESSION])"," and ","")%>
<%=odiRef.getFilterList("and ","([EXPRESSION])"," and ","")%>
<%=odiRef.getGrpBy()%>
<%=odiRef.getHaving()%>

説明: getSrcTablesList関数は、ソース内の各表についてカンマで区切られたパターン(CATALOG.SCHEMA.TABLE_NAME as POP_TAB_ALIAS)を繰り返すSELECT文のFROM句を生成するために使用されます。

関数の最初のパラメータ""は、文字列を特定の文字で開始しないことを示します。
2番目のパラメータ"[CATALOG].[SCHEMA].[TABLE_NAME] as [POP_TAB_ALIAS]"は、このパターンを各ソース表について繰り返すことを示します。キーワード[CATALOG]、[SCHEMA]、[TABLE_NAME]および[POP_TAB_ALIAS]は、表「パターン属性リスト」の有効なキーワードを参照しています。
3番目のパラメータ", "は、パターンの解釈された発生を、文字列「,」で区切ることを示します。
関数の4番目のパラメータ""は、文字列が特定の文字を伴わずに終わることを示します。

A.2.57 getStep()メソッド

現在の手順に関する情報を返すために使用します。

使用方法

public java.lang.String getStep(java.lang.String pPropertyName)

説明

このメソッドは現在の手順に関する情報を返します。使用可能な情報のリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な値のリストです。

パラメータ値	説明
SESS_NO	手順が所属するセッションの番号このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
SESS_GUID	セッションのGUID。
NNO	セッションでの手順の番号
NB_RUN	実行の試行数
STEP_NAME	手順名
STEP_TYPE	手順のタイプ
CONTEXT_NAME	実行コンテキストの名前
VAR_INCR	手順変数の増分
VAR_OP	変数を比較するために使用される演算子
VAR_VALUE	変数の強制値
OK_EXIT_CODE	成功の場合の終了コード
OK_EXIT	成功の場合にパッケージを終了
OK_NEXT_STEP	成功の場合の次の手順
OK_NEXT_STEP_NAME	成功の場合の次の手順の名前
KO_RETRY	失敗の場合の再試行数
KO_RETRY_INTERV	失敗の場合の試行間隔
KO_EXIT_CODE	失敗の場合の終了コード
KO_EXIT	失敗の場合にパッケージを終了
KO_NEXT_STEP	失敗の場合の次の手順
KO_NEXT_STEP_NAME	失敗の場合の次の手順の名前

例

The current step is: <%=odiRef.getStep("STEP_NAME")%>

A.2.58 getSubscriberList()メソッド

ジャーナル化された表の各サブスクライバのプロパティを返すために使用します。プロパティは文字列パターンに応じて構成されます。

使用方法

public java.lang.String getSubscriberList( java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

代替可能な構文:

public java.lang.String getSubscriberList( 
java.lang.String pPattern,
java.lang.String pSeparator,

説明

ジャーナル化された表のサブスクライバのリストを返します。pPatternパラメータはリストの各要素ごとに解釈され、繰り返されて、前の要素からパラメータpSeparatorで区切られます。生成された文字列はpStartから始まり、pEndで終わります。要素が選択されていない場合は、pStartとpEndは省略され、空の文字列が返されます。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストを、後述の「パターン属性リスト」に示します。属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例 «My name is [SUBSCRIBER]»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
SUBSCRIBER	サブスクライバの名前

例

Here is list of Subscribers: <%=odiRef.getSubscriberList("\nBegin List\n", "- [SUBSCRIBER]", "\n", "\nEnd of List\n")%>

A.2.59 getSysDate()メソッド

セッションを実行しているマシンのシステム日付を指定された形式で返すために使用します。

使用方法

public java.lang.String getSysDate()

public java.lang.String getSysDate(pDateFormat)

説明

このメソッドは、このメソッドは、セッションを実行しているマシンのシステム日付を返します。t

パラメータ

パラメータ	タイプ	説明
pDateFormat	文字列	システム日付を返すために使用される日付書式。このパターンはJavaの日付・時刻パターンに従う必要があります。詳細は、`http://download.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html`を参照してください。

例

Current year is: <%=odiRef.getSysDate("y")%>

A.2.60 getTable()メソッド

表の完全修飾名を返すために使用します。この表は、ソース表、ターゲット表、あるいはOracle Data Integratorによって処理された一時表または構造表のいずれかです。

使用方法

public java.lang.String getTable(
java.lang.String pMode,
java.lang.String pProperty,
java.lang.String pLocation)

public java.lang.String getTable(
java.lang.String pProperty,
java.lang.String pLocation)

public java.lang.String getTable(
java.lang.String pProperty)

説明

Oracle Data Integratorによって処理された一時表および永続表の完全修飾名を取得します。

パラメータ

タイプ

説明

pMode

文字列

"L": ローカル・オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。この値は、pModeが指定されていない場合に使用されます。

"R": オブジェクト・マスクを使用してオブジェクトの完全パスを作成します。

"A": 自動。使用する適切なマスクを自動的に定義します。

pProperty

文字列

構築される表の名前を示すパラメータ。可能な値のリストを次に示します。

ID: データストア識別子このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
GLOBAL_ID: ターゲット表のGUID。
TARG_NAME: ターゲット・データストアのフルネーム。アクションでは、このパラメータは、DDLコマンドによって処理された現在の表の名前を返します。マッピングのターゲット・データストアでパーティショニングが使用されている場合、このプロパティは、データストア名にパーティショニング句を自動的に含めます。
COLL_NAME: ロード・データストアのフルネーム
INT_NAME: 統合データストアのフルネーム
ERR_NAME: エラー・データストアのフルネーム
CHECK_NAME: エラー・サマリー・データストアの名前
CT_NAME: チェック・データストアのフルネーム
FK_PK_TABLE_NAME: 外部キーによって参照されたデータストアのフルネーム
JRN_NAME: ジャーナル化されたデータストアのフルネーム
JRN_VIEW: ジャーナル化されたデータストアにリンクされたビューのフルネーム
JRN_DATA_VIEW: ジャーナル化されたデータストアにリンクされたデータ・ビューのフルネーム
JRN_TRIGGER: ジャーナル化されたデータストアにリンクされたトリガーのフルネーム
JRN_ITRIGGER: ジャーナル化されたデータストアにリンクされた挿入トリガーのフルネーム
JRN _UTRIGGER: ジャーナル化されたデータストアにリンクされた更新トリガーのフルネーム
JRN_DTRIGGER: ジャーナル化されたデータストアにリンクされた削除トリガーのフルネーム
SUBSCRIBER_TABLE: サブスクライバ・リストが含まれているデータストアのフルネーム
CDC_SET_TABLE: CDCセットのリストが含まれている表のフルネーム
CDC_TABLE_TABLE: CDCセットを使用してジャーナル化された表のリストが含まれている表のフルネーム
CDC_SUBS_TABLE: CDCセットのサブスクライバのリストが含まれている表のフルネーム
CDC_OBJECTS_TABLE: ジャーナル化パラメータとオブジェクトが含まれている表のフルネーム
<flexfield_code>: 現在のターゲット表のフレックスフィールド値

pLocation

文字列

W: 物理カタログのオブジェクトと、現在のタプル(コンテキスト、論理スキーマ)に対応する物理作業スキーマのフルネームを返します。

D: 物理カタログのオブジェクトと、現在のタプル(コンテキスト、論理スキーマ)に対応する物理データ・スキーマのフルネームを返します。

A: Oracle Data Integratorがオブジェクトのデフォルトの場所を決定します。この値は、pLocationが指定されていない場合に使用されます。

例

定義されている物理スキーマ: Pluton.db_odi.dbo

データ・カタログ:	db_odi
データ・スキーマ:	dbo
作業カタログ:	tempdb
作業スキーマ:	temp_owner
ローカル・マスク:	%CATALOG.%SCHEMA.%OBJECT
リモート・マスク:	%DSERVER:%CATALOG.%SCHEMA.%OBJECT
ロード接頭辞:	CZ_
エラー接頭辞:	ERR_
統合接頭辞:	I$_

この物理スキーマを関連付けている論理スキーマ: MSSQL_ODI(コンテキストはCTX_DEV) 表の名前: CUSTOMER

コール対象	戻り値
`<%=odiRef.getTable("L", "COLL_NAME", "W")%>`	`tempdb.temp_owner.CZ_0CUSTOMER`
`<%=odiRef.getTable("R", "COLL_NAME", "D")%>`	`MyServer:db_odi.dbo.CZ_0CUSTOMER`
`<%=odiRef.getTable("L", "INT_NAME", "W")%>`	`tempdb.temp_owner.I$_CUSTOMER`
`<%=odiRef.getTable("R", "ERR_NAME", "D")%>`	`MyServer:db_odi.dbo.ERR_CUSTOMER`

A.2.61 getTargetColList()メソッド

マッピングのターゲット表のアクティブな属性に関する情報を返すために使用します。アクティブな属性とは、アクティブ・マッピングを持つ属性のことです。ターゲット表のすべての属性(アクティブな属性および非アクティブな属性を含む)に関する情報を返すには、getAllTargetColList()メソッドを使用します。

使用方法

public java.lang.String getTargetColList( java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd,
java.lang.String pSelector)

代替可能な構文:

public java.lang.String getTargetColList( java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

public java.lang.String getTargetColList( java.lang.String pPattern,
java.lang.String pSeparator)

説明

マッピングのターゲット表の属性リストを提供します。

代替可能な構文では、未設定のパラメータはすべて空の文字列として設定されます。

パラメータ

パラメータ	タイプ	説明
pStart	文字列	このシーケンスは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストを、後述の「パターン属性リスト」に示します。属性は、パターン文字列内に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute of the target»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このシーケンスは、生成する文字列の終わりの目印です。
pSelector	文字列	次の形式を使用して、最初のリストの要素をフィルタできるブール式を指定する文字列。 <SELECTOR> <演算子> <SELECTOR>など。カッコを使用できます。使用できる演算子: 否定: NOTまたは! 論理和: ORまたは\|\| 論理積: ANDまたは&& 例: (INS AND UPD) OR TRG 有効なセレクタについては後述します。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
I_COL	属性の内部識別子
COL_NAME	属性の名前。
COL_HEADING	属性のヘッダー
COL_DESC	属性の説明
POS	属性の位置
LONGC	属性の長さ(精度)
SCALE	属性のスケール
FILE_POS	属性の開始(索引)
BYTES	属性の物理バイト数
FILE_END_POS	属性の終わり(FILE_POS + BYTES)
IND_WRITE	属性の書込み権限フラグ
COL_MANDATORY	属性の必須文字。有効な値: 0: NULLを許可 1: NOT NULL
CHECK_FLOW	属性のフロー制御フラグ。有効な値: (0: チェックしない、1: チェック) 0: チェックしない 1: チェック
CHECK_STAT	属性の静的制御フラグ。有効な値: (0: チェックしない、1: チェック) 0: チェックしない 1: チェック
COL_FORMAT	属性の論理形式
COL_DEC_SEP	属性の小数点記号
REC_CODE_LIST	属性に維持されたレコード・コードのリスト
COL_NULL_IF_ERR	属性の処理フラグ。有効な値:(0 = 拒否、1 = アクティブ・トレースをNULLに設定、2= 非アクティブ・トレースをNULLに設定) 0: 拒否 1: アクティブ・トレースをNULLに設定 2: 非アクティブ・トレースをNULLに設定
DEF_VALUE	属性のデフォルト値
ALIAS_SEP	別名に対して(テクノロジにより)使用されるセパレータ
SOURCE_DT	属性のデータ型のコード
SOURCE_CRE_DT	属性のデータ型に対する表作成構文
SOURCE_WRI_DT	属性の書込み可能データ型に対する表作成構文
DEST_DT	ターゲット・テクノロジ上のデータ型に変換された、属性のデータ型のコード
DEST_CRE_DT	ターゲット・テクノロジ上のデータ型に変換された属性のデータ型に対する表作成構文
DEST_WRI_DT	ターゲット・テクノロジ上のデータ型に変換された、属性の書込み可能なデータ型に対する表作成構文
SCD_COL_TYPE	データ・モデルでこの属性の緩やかに変化するディメンションに対して定義された動作
MANDATORY_CLAUSE	属性が必須の場合、`NOT NULL`を返します。そうでない場合、そのテクノロジのNULLキーワードを返します。
DEFAULT_CLAUSE	デフォルト値が存在する場合、`DEFAULT <デフォルト値>`を返します。そうでない場合は、空の文字列を返します。
JDBC_TYPE	データ・サービス - ドライバによって返される属性のJDBCタイプ。
<flexfield code>	現在の属性のフレックスフィールド値

セレクタの説明

パラメータ値	説明
INS	LKM: 適用対象外 IKM: 挿入でマークされたマッピング式のみ CKM: 適用対象外
UPD	LKM: 適用対象外 IKM: 更新でマークされたマッピング式のみ CKM: 適用対象外
TRG	LKM: 適用対象外 IKM: ターゲット上で実行されたマッピング式のみ CKM: ターゲット上で実行されたマッピング式
NULL	LKM: 適用対象外 IKM: NULL値可能でない属性をロードするすべてのマッピング式 CKM: NULL値を許容しないすべてのターゲット属性
PK	LKM: 適用対象外 IKM: 主キー属性をロードするすべてのマッピング式 CKM: 主キーの一部であるすべてのターゲット属性
UK	LKM: 適用対象外 IKM: 現在のマッピングに対して選択された更新キー属性をロードするすべてのマッピング式 CKM: 適用対象外
REW	LKM: 適用対象外 IKM: 読取り専用フラグが選択されていない属性をロードするすべてのマッピング式 CKM: 読取り専用フラグが選択されていないすべてのターゲット属性
MAP	LKM: 適用対象外 IKM: 適用対象外 CKM: フロー制御: 現在のマッピングの式でロードされたターゲット表のすべての属性静的制御: ターゲット表のすべての属性
SCD_SK	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Surrogate Key」とマーキングされたすべての属性
SCD_NK	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Natural Key」とマーキングされたすべての属性
SCD_UPD	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Overwrite on Change」とマーキングされたすべての属性
SCD_INS	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Add Row on Change」とマーキングされたすべての属性
SCD_FLAG	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Current Record Flag」とマーキングされたすべての属性
SCD_START	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Starting Timestamp」とマーキングされたすべての属性
SCD_END	LKM、CKM、IKM: データ・モデル定義で「SCD Behavior: Ending Timestamp」とマーキングされたすべての属性
WS_INS	SKM: 属性は、データ・サービスを使用したINSERTを許可するフラグを設定されています。
WS_UPD	SKM: 属性は、データ・サービスを使用したUDATEを許可するフラグを設定されています。
WS_SEL	SKM: 属性は、データ・サービスを使用したSELECTを許可するフラグを設定されています。

例

create table TARGET_COPY <%=odiRef.getTargetColList("(", "[COL_NAME] [DEST_DT] null", ", ", ")", "")%>

A.2.62 getTableName()メソッド

ロード表または統合表の名前を返すために使用します。

使用方法

public java.lang.String getTableName(
java.lang.String pProperty)

説明

このメソッドは、ロードまたは統合に使用される一時表の名前を返します。この名前は修飾されません。

パラメータ

パラメータ	タイプ	説明
pProperty	文字列	取得する表の名前を示すパラメータ。可能な値のリストを次に示します。 INT_SHORT_NAME: 統合表の名前 COLL_SHORT_NAME: ロード表の名前 CT_SHORT_NAME: 統合表の名前。マッピングでフロー制御が使用されている場合、INT_SHORT_NAMEと同じ名前を返します。マッピングで静的制御が使用されている場合、ターゲット表名<table name>を返します。

例

<%= odiRef.getTableName("COLL_SHORT_NAME") %>

A.2.63 getTargetTable()メソッド

マッピングのターゲット表に関する情報を返すために使用します。

使用方法

public java.lang.String getTargetTable(java.lang.String pPropertyName)

説明

このメソッドは、現在のターゲット表に関する情報を返します。使用可能なデータのリストをpPropertyName値の表に示します。

アクションでは、このメソッドはDDLコマンドによって処理されている表に関する情報を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な値のリストです。

パラメータ値	説明
I_TABLE	データストアの内部識別子。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
TABLE_GUID	ターゲット表のGUID。
MODEL_NAME	現在のデータストアのモデルの名前
SUB_MODEL_NAME	現在のデータストアのサブモデルの名前
TECHNO_NAME	ターゲット・テクノロジの名前
LSCHEMA_NAME	ターゲット論理スキーマの名前
TABLE_NAME	ターゲット・データストアの名前。
RES_NAME	ターゲット・リソースの物理名
CATALOG	カタログ名
WORK_CATALOG	作業カタログの名前
SCHEMA	スキーマ名
WORK_SCHEMA	作業スキーマの名前
TABLE_ALIAS	現在のデータストアの別名
TABLE_TYPE	データストアのタイプ
DESCRIPTION	現在のマッピングの説明
TABLE_DESC	現在のマッピングのターゲット・データストアの説明。DDLコマンドの場合、現在の表の説明。
R_COUNT	現在のデータストアの行数
FILE_FORMAT	現在のデータストア(ファイル)の形式
FILE_SEP_FIELD	フィールド・セパレータ(ファイル)
XFILE_SEP_FIELD	16進表記のフィールド・セパレータ(ファイル)
SFILE_SEP_FIELD	フィールド・セパレータ文字列(ファイル)
FILE_ENC_FIELD	フィールドの開始および終了文字(ファイル)
FILE_SEP_ROW	レコード・セパレータ(ファイル)
XFILE_SEP_ROW	16進表記のレコード・セパレータ(ファイル)
SFILE_SEP_ROW	レコード・セパレータ文字列(ファイル)
FILE_FIRST_ROW	ファイル(ファイル)の先頭の、無視する行数
FILE_DEC_SEP	小数点記号(ファイル)
METADATA_DESC	データストアのメタデータの説明(ファイル)
OLAP_TYPE	データストア定義で指定されたOLAPタイプ
IND_JRN	データストアがCDCに含まれることを示すフラグ
JRN_ORDER	一貫したジャーナル化のためのCDCセット内でのデータストアの順序
WS_NAME	データ・サービス - このデータストアのモデル用に生成されたWebサービスの名前
WS_NAMESPACE	データ・サービス - このデータストアのモデル用に生成されたWebサービスの名前
WS_JAVA_PACKAGE	データ・サービス - Webサービス用に生成されたJavaパッケージ
WS_ENTITY_NAME	データ・サービス - Webサービスでこのデータストアに対して使用されるエンティティ名
WS_DATA_SOURCE	データ・サービス - Webサービスでこのデータストアに対して使用されるエンティティ名
PARTITION_NAME	ターゲット・データストアに選択されているパーティションまたはサブパーティションの名前。パーティションが選択されていない場合は、空の文字列を返します。
PARTITION_TYPE	ターゲット・データストアに選択されているパーティションまたはサブパーティションのタイプ。パーティションが選択されていない場合は、空の文字列を返します。 P: パーティション S: サブパーティション
<flexfield code>	現在の表のフレックスフィールド値

例

The current table is: <%=odiRef.getTargetTable("RES_NAME")%>

A.2.64 getTemporaryIndex()メソッド

マッピングで結合またはフィルタを最適化するために定義される一時索引に関する情報を返すために使用します。

使用方法

public java.lang.String getTemporaryIndex(java.lang.String pPropertyName)

説明

このメソッドは、マッピングによって作成または削除されている一時索引に関する情報を返します。

これは、このタスクの「一時索引の作成」オプションを「ソース上」または「ターゲット上」に設定している場合に、ロード・ナレッジ・モジュールまたは統合ナレッジ・モジュールで使用できます。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれる文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
IDX_NAME	索引の名前。この名前は、物理スキーマ用に定義された一時索引の接頭辞を付けて作成されます。
FULL_IDX_NAME	索引の完全修飾名。ターゲット・タブでは、ステージング領域の作業スキーマで索引を作成するためにこの名前が修飾されます。ソース・タブでは、ソースのデフォルト作業スキーマ(LKM)またはステージング領域の作業スキーマ(IKM)で索引を作成するためにこの名前が修飾されます。
COLL_NAME	LKMのロード表の完全修飾名。このプロパティはIKMには適用されません。
CATALOG	索引付けされる表を含むカタログ
SCHEMA	索引付けされる表を含むスキーマ
WORK_CATALOG	索引付けされる表の作業カタログ
WORK_SCHEMA	索引付けされる表の作業スキーマ
DEF_CATALOG	索引付けされる表を含むデフォルト・カタログ
DEF_SCHEMA	索引付けされる表を含むデフォルト・スキーマ
DEF_WORK_CATALOG	索引付けされる表のデフォルト作業カタログ
DEF_WORK_SCHEMA	索引付けされる表のデフォルト作業スキーマ
DEF_WORK_SCHEMA	索引付けされる表のデフォルト作業スキーマ
LSCHEMA_NAME	索引付けされる表の論理スキーマ
TABLE_NAME	索引付けされる表の名前
FULL_TABLE_NAME	索引付けされる表の完全修飾名
INDEX_TYPE_CODE	索引タイプを表すコード
INDEX_TYPE_CLAUSE	このタイプの索引を作成するための句
POP_TYPE_CLAUSE	索引を作成する句のタイプ: J: 結合 F: フィルタ
EXPRESSION	結合またはフィルタ句の式。デバッグ目的で使用します。

例

Create <%=odiRef.getTemporaryIndex (" [INDEX_TYPE_CLAUSE] index [FULL_IDX_NAME] on [FULL_TABLE_NAME] " )%><%=odiRef.getTemporaryIndexColList("(", "[COL_NAME]", ", ", ")")%>

A.2.65 getTemporaryIndexColList()メソッド

マッピングの一時索引の列に関する情報を返すために使用します。

使用方法

public java.lang.String getTemporaryIndexColList(java.lang.String pStart,
java.lang.String pPattern,
java.lang.String pSeparator,
java.lang.String pEnd)

説明

一時索引の列のリストを返します。

このリストには、一時索引の各列につき1つの要素が含まれます。

パラメータ

パラメータ	タイプ	説明
パラメータ	タイプ	説明
pStart	文字列	このパラメータは、生成する文字列の始まりの目印です。
pPattern	文字列	パターンはリスト内に現れるたびに繰り返されます。パターンで使用できる属性のリストは、後述の「パターン属性リスト」を参照してください。各属性は、パターン文字列に出現するたびにその値に置き換えられます。属性は大カッコ([])で囲む必要があります。例: «My string [COL_NAME] is a attribute»
pSeparator	文字列	このパラメータは、各パターンを前のパターンから区切ります。
pEnd	文字列	このパラメータは、生成する文字列の終わりの目印です。

パターン属性リスト

次の表は、異なるパラメータ値を、それに関連付けられた説明とともにあげたものです。

パラメータ値	説明
CX_COL_NAME	ステージング領域上の現在の式のコンテナとして使用されている属性の計算された名前
COL_NAME	索引に含める属性の名前
POS	この索引を最適化する結合またはフィルタ句でのこの属性の最初の出現位置

例

Create <%=odiRef.getTemporaryIndex (" [INDEX_TYPE_CLAUSE] index [FULL_IDX_NAME] on [FULL_TABLE_NAME] " )%><%=odiRef.getTemporaryIndexColList("(", "[COL_NAME]", ", ", ")")%>

A.2.66 getUser()メソッド

現在のセッションを実行しているユーザーに関する情報を返すために使用します。

使用方法

public java.lang.String getUser(java.lang.String pPropertyName)

説明

このメソッドは、現在のセッションを実行しているユーザーに関する情報を返します。使用可能なプロパティのリストをpPropertyNameの値の表に示します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	リクエストされたプロパティの名前が含まれている文字列

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
パラメータ値	説明
I_USER	ユーザー識別子。このパラメータは非推奨であり、11gとの互換性のためにのみ残されています。このIDプロパティは、リポジトリが11g互換性モードのときには有効になりますが、リポジトリが12cモードのときにはエラー・メッセージが返されます。
USER_GUID	ユーザーのGUID。
USER_NAME	ユーザー名
IS_SUPERVISOR	ユーザーがsupervisor (1)か、そうでない(0)かを示すブール値のフラグ

例

This execution is performed by <%=odiRef.getUser("USER_NAME")%>

A.2.67 getVersion()メソッド

ODIの現在のバージョンを返すために使用します。

使用方法

public java.lang.String getVersion()

説明

このメソッドは、実行中のODIインストールの完全バージョン番号を返します。

例

KMテキスト:

This execution is performed in <%=odiRef.getVersion()%>

この場合、次の文字列が返されます。

This execution is performed in 12.1.3.0.0

A.2.68 hasPK()メソッド

現在のデータストアに主キーがあるかどうかを返すために使用します。

使用方法

public java.lang.Boolean hasPK()

説明

このメソッドはブール値を返します。Webサービスが生成されているデータストアに主キーがある場合、戻り値はtrueです。

このメソッドはSKMでのみ使用できます。

例

<% if (odiRef.hasPK()) { %>

         There is a PK :

          <%=odiRef.getPK("KEY_NAME")%> : <%=odiRef.getPKColList("{",
           "\u0022[COL_NAME]\u0022", ", ", "}")%>

<% } else {%>

         There is NO PK.

<% } %>

A.2.69 isColAttrChanged()メソッド

列属性またはコメントが変更されたかどうかを返すために使用します。

使用方法

public java.lang.Boolean 
isColAttrChanged(java.lang.String pPropertyName)

説明

このメソッドは、列属性またはコメントを変更するための列アクションで使用できます。パラメータとして渡された列属性が変更されたかどうかを示すブール値を返します。

パラメータ

パラメータ	タイプ	説明
pPropertyName	文字列	属性コード(次を参照)

次の表は、pPropertyNameで可能な様々な値のリストです。

パラメータ値	説明
DATATYPE	列のデータ型、長さまたは精度が変更されています。
LENGTH	列の長さが変更されています(たとえば、VARCHAR(10)がVARCHAR(12)に変更されています)。
PRECISION	列の精度が変更されています(たとえば、DECIMAL(10,3)がDECIMAL(10,4)に変更されています)。
COMMENT	列コメントが変更されています。
NULL_TO_NOTNULL	列のNULL値可能属性が、NULLからNOT NULLに変更されています。
NOTNULL_TO_NULL	列のNULL値可能属性が、NOT NULLからNULLに変更されています。
NULL	列のNULL値可能属性が変更されています。
DEFAULT	列のデフォルト値が変更されています。

例

<% if (odiRef.IsColAttrChanged("DEFAULT") ) { %>
          /* Column default attribute has changed. */
<% } %>

A.2.70 isVersionCompatible()メソッド

ODIの現在のバージョンが指定されたバージョンと互換性があるかどうかを確認するために使用します。VER1 > VER2 (例: 12.1.3.0.0 > 11.1.1.7.0)の場合、バージョンVER1はバージョンVER2との互換性があります。

使用方法

public boolean isVersionCompatible(java.lang.String compatibleVersion)

説明

指定されたバージョンが製品の現在のバージョンと互換性がある場合、このメソッドはtrueを返します。VER1 > VER2 (例: 12.1.3.0.0 > 11.1.1.7.0)の場合、バージョンVER1はバージョンVER2との互換性があります。

例

KMテキスト:

This version is compatible to 11.1.1.7.0: <%=odiRef.isVersionCompatible("11.1.1.7.0") %>

この場合、次の文字列が返されます。

This version is compatible to 11.1.1.7.0: true

A.2.71 nextAK()メソッド

データストアの次の代替キーに移るために使用します。

使用方法

public java.lang.Boolean nextAK()

説明

このメソッドは、Webサービスが生成されているデータストアの次の代替キー(AK)に移ります。

最初にコールされると、このメソッドはtrueを返し、現在のAKをデータストアの最初のAKに置きます。データストアにAKがない場合はfalseを返します。

次回以降のコールは、現在のAKをデータストアの次のAKに置き、trueを返します。次のAKがない場合はfalseを返します。

このメソッドはSKMでのみ使用できます。

例

次の例では、データストアのすべてのAKに対して反復しています。whileループの繰返しごとに、getAKとgetAKColListメソッドは、データストアの各種のAKに関する情報を返します。

<% while (odiRef.nextAK()) { %>
         <%=odiRef.getAK("KEY_NAME")%>
    Columns <%=odiRef.getAKColList("{", "\u0022[COL_NAME]\u0022", ",
 ", "}")%>
         Message : <%=odiRef.getAK("MESS")%>
<% } %>

A.2.72 nextCond()メソッド

データストアの次の条件に移るために使用します。

使用方法

public java.lang.Boolean nextCond()

説明

このメソッドは、Webサービスが生成されているデータストアの次の条件(チェック制約)に移ります。

最初にコールされると、このメソッドはtrueを返し、現在の条件をデータストアの最初の条件に置きます。データストアに条件がない場合はfalseを返します。

次回以降のコールは、現在の条件をデータストアの次の条件に置き、trueを返します。次の条件がない場合はfalseを返します。

このメソッドはSKMでのみ使用できます。

例

次の例では、データストアのすべての条件に対して反復しています。whileループの繰返しごとに、getCKメソッドは、データストアの各種の条件に関する情報を返します。

<% while (odiRef.nextCond()) { %>
        <%=odiRef.getCK("COND_NAME")%>
                 SQL :<%=odiRef.getCK("COND_SQL")%>
                 MESS :<%=odiRef.getCK("MESS")%>
<% } %>

A.2.73 nextFK()メソッド

データストアの次の外部キーに移るために使用します。

使用方法

public java.lang.Boolean nextFK()

説明

このメソッドは、Webサービスが生成されているデータストアの次の外部キー(FK)に移ります。

最初にコールされると、このメソッドはtrueを返し、現在のFKをデータストアの最初のFKに置きます。データストアにFKがない場合はfalseを返します。

次回以降のコールは、現在のFKをデータストアの次のFKに置き、trueを返します。次のFKがない場合はfalseを返します。

このメソッドはSKMでのみ使用できます。

例

次の例では、データストアのすべてのFKに対して反復しています。whileループの繰返しごとに、getFKとgetFKColListメソッドは、データストアの各種のFKに関する情報を返します。

<% while (odiRef.nextFK()) { %>
        FK : <%=odiRef.getFK("FK_NAME")%>
                Referenced Table : <%=odiRef.getFK("PK_TABLE_NAME")%>
                Columns <%=odiRef.getFKColList("{", "\u0022[COL_NAME]\u0022", ",
 ", "}")%>
                Message : <%=odiRef.getFK("MESS")%>
<% } %>

A.2.74 setNbInsert()、setNbUpdate()、setNbDelete()、setNbErrors()およびsetNbRows()メソッド

現在のタスクに対して挿入、更新、削除された行数またはエラーになった行数を設定するために使用します。

使用方法

public java.lang.Void setNbInsert(public java.lang.Long)

public java.lang.Void setNbUpdate(public java.lang.Long)

public java.lang.Void setNbDelete(public java.lang.Long)

public java.lang.Void setNbErrors(public java.lang.Long)

public java.lang.Void setNbRows(public java.lang.Long)

説明

現在のタスクに設定されたこれらのメソッドにより、次の値が報告されます。

挿入された行数(setNbInsert)
更新された行数(setNbUpdate)
削除された行数(setNbDelete)
エラーになった行数(setNbErrors)
このタスク時に処理された行の総数(setNbRows)

これらの数は、処理された行の実際の数とは別に設定できます。

注意:

このメソッドはJythonコードなどのスクリプト・エンジン・コマンドでのみ使用可能です。<%%>タグで囲まないでください。

例

次のJythonの例では、挿入行数を定数値50に設定し、エラーの行数を#DEMO.NbErrorsというODI変数から導出します。

InsertNumber=50

odiRef.setNbInsert(InsertNumber)

ErrorNumber=#DEMO.NbErrors

odiRef.setNbErrors(ErrorNumber)

A.2.75 setTableName()メソッド

ロード表または統合表の名前を設定するために使用します。

使用方法

public java.lang.Void setTableName(
java.lang.String pProperty,
java.lang.String pTableName)

説明

このメソッドは、ロードまたは統合に使用される一時表の名前を設定します。この名前は任意の値にすることができます。

メソッドの使用時には、ロード表または統合表の名前はODIによって生成されず、標準の命名規則には従いません(たとえば、ロード表に接頭辞C$は付けられません)。ただし、この表名を使用する他のメソッドでは、新しく設定された値が返されます。

最初のパラメータpPropertyは、設定される一時表の名前を示します。2番目のパラメータは、有効な任意の表名にすることができます。

パラメータ

パラメータ	タイプ	説明
pProperty	文字列	設定する表名を示すパラメータ。可能な値のリストを次に示します。 INT_SHORT_NAME: 統合表の名前 COLL_SHORT_NAME: ロード表の名前
pTableName	文字列	一時表の新しい名前

例

<% odiRef.setTableName("COLL_SHORT_NAME", "C" + getInfo("I_SRC_SET")) %>

<% odiRef.setTableName("COLL_SHORT_NAME", odiRef.getOption("Flow # ") + odiRef.getTable("ID")) %>

A.2.76 setTaskName()メソッド

ナレッジ・モジュール、プロシージャまたはアクションでセッション・タスクの名前を設定します。

使用方法

public java.lang.String setTaskName(
java.lang.String taskName)

説明

このメソッドは、タスクの名前をtaskName値に設定します。この値はランタイムで設定されます。このメソッドは、すべてのナレッジ・モジュール、プロシージャおよびアクションで利用できます(グローバル・メソッド)。

パラメータ

パラメータ	タイプ	説明
taskName	文字列	設定するタスク名を示すパラメータ。この値が空の場合、ナレッジ・モジュールまたはプロシージャのタスクに定義された値のまま変わりません。

例

<$=odiRef.setTaskName("Create Error Table " + "<%=odiRef.getTable("L","ERR_NAME","W")%>") $> 
<$=odiRef.setTaskName("Insert Error for " + "<%=odiRef.getFK("FK_NAME")%>") $>
<$=odiRef.setTaskName("Loading " + "<%=odiRef.getTable("L", "COLL_NAME", "W")%>" + " from " + "<%=odiRef.getSrcTablesList("", "RES_NAME", ",", ".")%>" ) $>