EDMTextIndex(テキストインデクサーの実行)

機能

テキストインデクサーを実行します。

形式

EDMTextIndex { -c 処理対象文書クラス名 | -f 処理対象文書クラス定義ファイルパス }
             〔-l テキスト抽出処理長上限値〕〔-m | -o | -p FAILED〕〔-s〕〔-r〕

オプション

-cまたは-fは,コマンドの次に指定してください。その他のオプションフラグの指定順序は任意です。

-c 処理対象文書クラス名
単一のクラスを対象とする場合に処理対象文書クラスを指定します。
-f 処理対象文書クラス定義ファイルパス
  • 一つ以上のクラスを処理対象にするときに,処理対象文書クラス定義ファイルのパスを指定します。パスの指定方法については「3.2.2 文法」を参照してください。
  • 処理対象文書クラス定義ファイルについては,「3.6 処理対象文書クラス定義ファイル」を参照してください。
-l テキスト抽出処理長上限値
  • 環境設定ファイルのMaxOfLengthエントリと同様,テキスト抽出長の上限値を指定できます。
  • 実行時はオプションフラグに指定した値が優先されます。
  • オプションを指定しない場合は,環境設定ファイルの値をデフォルト値とします。
-m | -o | -p FAILED
  • -mを指定すると,処理対象文書クラスの中で更新された文書を処理対象にします。
  • -oを指定すると,処理対象文書クラスのすべての文書を処理対象にします。
  • -p FAILEDを指定すると,処理対象文書クラスの中でテキスト抽出に失敗した文書を処理対象にします。
  • -m,-o,または-pオプションフラグを一緒に指定した場合はエラーメッセージKMBV12002-Eを出力してプログラムを終了します。
-s
マスタレンディションおよびサブレンディションの文書をRenditionType検索の対象とします。
-r
テキスト抽出処理でエラーが発生したときに,エラーメッセージを出力してコマンドを終了します。

注意事項

指定できるオプション(オプションフラグとフラグ引数)と省略時の処理を表4-3に示します。

表4-3 指定できるオプションと省略時の処理

オプションフラグフラグ引数説明省略時の処理
-c処理対象文書クラス名処理対象文書クラスが一つの場合に使用します。省略できません。
-cか-fかのどちらか一つを必ず指定してください。
-f処理対象文書クラス定義ファイルパス処理対象文書クラスを複数個指定する場合に使用します。省略できません。
-cか-fかのどちらか一つを必ず指定してください。
-lテキスト抽出処理長上限値テキスト抽出処理で出力する文書長の上限値を指定します。(単位:バイト)
(指定範囲:0~5242780)
デフォルト値は5242780(バイト)です。全文検索プラグインで登録できるインデクスファイルの上限値に従います。※1
-m処理対象文書クラスの中で更新された文書を処理対象にします。処理対象文書クラスの中で全文検索インデクスファイルが未登録の文書を処理対象にします。
-o処理対象文書クラスのすべての文書を処理対象にします。処理対象文書クラスの中で全文検索インデクスファイルが未登録の文書を処理対象にします。
-pFAILED処理対象文書クラスの中でテキスト抽出に失敗した文書を処理対象にします。処理対象文書クラスの中で全文検索インデクスファイルが未登録の文書を処理対象にします。
-rテキスト抽出処理でエラーが発生した場合,文書のインデクス登録処理を中断し,コマンドを終了します。このとき,エラーとなった文書は,テキスト抽出に失敗した文書として扱います。2,※3ワーニングメッセージを出力して,文書のインデクス登録処理を続行します。
-sマスタレンディションにRenditionType検索の対象となる文書がない場合,サブレンディションの文書を検索の対象にします。マスタレンディションの文書だけをRenditionType検索の対象にします。
注※1
上限値を超えるデータが打ち切られた文書の場合,メッセージKMBV12009-Iが出力されます。ただし,XML文書の場合は,KMBV12009-Iの出力後にKMBV12037-Wが出力されます。
注※2
テキスト抽出処理でエラーが発生したときのワーニングメッセージと,-rオプション指定時のエラーメッセージの対応を次に示します。

ワーニングメッセージエラーメッセージエラー内容-rオプション指定時の動作
KMBV12035-WKMBV12301-E構造指定全文検索ファイル作成時にエラー文書のインデクスの登録処理を中断し,エラーメッセージを出力してコマンドを終了します。
KMBV12036-WKMBV12302-E構造指定全文検索ファイル作成時にエラー
KMBV12037-WKMBV12303-E文書のテキストデータ登録時にエラー
KMBV12044-WKMBV12305-E文書のテキスト抽出処理が失敗
KMBV12048-WKMBV12306-E文書のテキスト抽出処理が失敗
KMBV12251-WKMBV12307-E文書のテキスト抽出処理が失敗
KMBV12252-WKMBV12308-E文書のテキスト抽出処理が失敗
KMBV12254-WKMBV12309-Eプロパティ値の取得用処理が失敗
注※3
-rオプション指定時にテキスト抽出処理でエラーが発生した場合は,書誌情報の登録指定は無視されます。文書のインデクス登録処理を中断し,エラーメッセージを出力してからコマンドを終了します。

コマンド実行例

(指定例1)
EDMTextIndex -c InputDocumentClass
処理対象文書クラスInputDocumentClassに所属する文書の中で,全文検索インデクスファイルが未登録の文書に対して処理を実行します。
(指定例2)
EDMTextIndex -c InputDocumentClass -o
処理対象文書クラスInputDocumentClassに所属するすべての文書に対して処理を実行します。全文検索インデクスファイルが登録済みの文書も処理対象になり,全文検索インデクスファイルを上書きします。
(指定例3)
EDMTextIndex -c InputDocumentClass -m
処理対象文書クラスInputDocumentClassに所属する文書の中で,更新された文書に対して処理を実行します。
(指定例4)
EDMTextIndex -c InputDocumentClass -l 4000
処理対象文書クラスInputDocumentClassに所属する文書の中で,全文検索インデクスファイルが未登録の文書に対して処理を実行します。
1文書当たりのテキスト抽出処理文書長の上限値を4,000バイト(MaxOfLength)とします。
(指定例5)
EDMTextIndex -c inputDocumentClass -p FAILED
処理対象文書クラスInputDocumentClassに所属するテキスト抽出が失敗した文書に対して処理を実行します。
(指定例6)
EDMTextIndex -c inputDocumentClass -r
処理対象文書クラスInputDocumentClassに所属する,すべての未登録文書に対して処理を実行します。テキスト抽出処理でエラーが発生した場合,文書のインデクス登録処理を中断し,コマンドを終了します。エラーとなった文書は,テキスト抽出に失敗した文書として扱います。