11.2.9 getSnippet

<この項の構成>
(1) 機能
(2) 定義
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

検索キーワードがヒットした周辺文字列から作成したスニペットを返します。

IwsSearchCond.setUseHighLightで検索結果のハイライトを指定している場合,検索キーワード部分はハイライトクラス属性を指定されている<span>タグで囲まれています。また,スニペット内にHTMLで特殊な扱いの文字がある場合,その文字をエスケープします。エスケープする文字についてはIwsSearchCond.setUseHtmlEscapeを参照してください。

(2) 定義

public java.lang.String getSnippet()

(3) 引数

なし

(4) 戻り値

この検索結果エントリのスニペットを返します。

本文が無い場合は空の文字列を返します。

(5) 例外

なし