IBM Books
(C) IBM Corp. 2000

Net Search Extender 管理およびユーザーズ・ガイド

DB2EXT.HIGHLIGHT

ある文書を検索結果であると判断された理由に関する情報を入手するために、 db2ext.highlight 関数を使用します。 より具体的には、 以下の作業を行うためにこの関数を使用できます。

db2ext.highlight 関数は db2ext.textsearch 表値関数と一緒にしか使用できないことに注意してください。 この表値関数は索引を検索し、その結果を HIGHLIGHT 関数が使用します。

db2ext.textsearch 関数の使用については、DB2EXT.TEXTSEARCHを参照してください。

関数の構文

>>-db2ext.highlight--------------------------------------------->
 
>--(--document-content--,--hit-information--,--hit-processing-information--)-><
 
 

関数パラメーター

入力パラメーターを以下に示します。

document content CLOB(100K)
TEXT または XML フォーマットの UTF8 文書だけがサポートされています。 この値を大きくするには、DB2EXTHL (ユーティリティー)を参照してください。

hit information BLOB(20K)
ヒット情報を含むストリング。 これは、numberOfHits パラメーターが指定されている場合に、 db2ext.textsearch 関数によって戻されます。

hit processing information VARCHAR(1024)
このパラメーターはオプションと値の対のリストです。 この対は、" " 文字で囲んだストリング文字をコンマ「,」文字で区切ったものです。 指定した文書で強調表示を処理する方法を指定します。 オプションを何も指定しないと、元の文書が戻されます。

TAGS = ("STRING", "STRING")
このオプションを使用すると、 ユーザーは文書内のヒットの前後に挿入するタグを指定できます。 このオプションを省略した場合は、文書内のヒットの前後にタグは追加されません。

WINDOW_NUMBER = INTEGER
このオプションは、 強調表示関数が文書の部分 (またはウィンドウ) をいくつ戻すようにするかを指定します。 各ウィンドウには 1 つ以上のヒットが含まれています。 各ウィンドウの最初のヒットにより、ユーザーに戻される文書の部分が決まります。 これらのヒットは、周囲のテキストで囲まれている場合とそうでない場合があります。

このオプションを省略した場合、デフォルトとして 0 を取り、 開始および終了タグ (指定されている場合) を含む文書全体が戻されます。 このとき、WINDOW_SIZE オプションは無視されます。

WINDOW_SIZE = INTEGER
このオプションはウィンドウの推奨サイズをバイト数で指定します。 この実際のサイズは、ヒット数、ヒットの長さ、 および開始タグと終了タグのサイズによって異なります。 このオプションを省略した場合、0 がデフォルトとなり、 周囲のテキストなしでヒットだけが戻されます。

WINDOW_SEPARATOR = "STRING"
このオプションは、1 つのウィンドウと次のウィンドウとを区切るために使用するタグを指定します。 このオプションを省略した場合、"..." がデフォルト値になります。

FORMAT = "STRING"
このオプションは文書のフォーマットを指定します。 有効な値は XML または TEXT です。 このオプションを省略した場合、デフォルト値として TEXT を取ります。 フォーマット値が、索引作成時に指定した値と同じになるようにしてください。

MODEL_NAME = "STRING"
このオプションは、指定した XML 文書に関連するモデル名を指定します。 FORMATTEXT の場合、 このオプションを指定するとエラー条件になるので注意してください。

SECTIONS = ("section-name1", ..., "section-nameN")
XML 文書の場合、強調表示を関係のあるセクションに制限することができます。 たとえば、そのセクションをモデル・ファイルに定義できます。 セクションを指定するには、1 つ以上のセクション名をコンマで区切ります。 このオプションを省略した場合、XML 文書全体が強調表示されます。 FORMATTEXT の場合は、このオプションは無視されるので注意してください。

関数パラメーター

戻りパラメーターを以下に示します。

CLOB(200K)
HIGHLIGHT 関数は、関数自身による文書の変更部分を含む CLOB 値を戻します。

使用法

次の例は、HIGHLIGHT 関数の使い方を示しています。

select p.id,
       p.title,
       db2ext.highlight(p.content,
       t.hitinformation,
       'TAGS = ("<bf>", "</bf>"),
       WINDOW_NUMBER = 5,
       WINDOW_SIZE = 200,
       WINDOW_SEPARATOR = "...",
       FORMAT = "XML", 
       SECTIONS = ("section1-name", "section2-name")')
 
FROM patent p, table (db2ext.textsearch(
       '"relational database systems"',
       'DB2EXT',
       'TI_FOR_CONTENT',
       0,
       20,
       CAST(NULL as BIGINT),
       15)) t
 
WHERE p.id = t.primkey

100 KB を超える文書を使用すると、SQL 照会が終了し、SQL エラーが発生します (SQL 1476N と sql エラー -433)。 これを回避するには、db2exthl コマンドを使用して、 文書の内容のサイズを大きくしてください。 詳しくは、DB2EXTHL (ユーティリティー)を参照してください。

特殊文字 (「改行」など) は現状のまま戻されます。

制約


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]