6.1 クラスの概要

IwsSearchCondクラスは,検索条件を格納するクラスです。

このクラスはマルチスレッドには対応していません。マルチスレッド環境で利用する場合は,それぞれのスレッド内でこのクラスのインスタンスを生成してください。

クラス定義
public class IwsSearchCond
extends java.lang.Object
パッケージ名
jp.co.hitachi_system.iwsearch.lib.client

一度の検索で同時に指定できる検索条件の文字列の上限は,次の表のとおりです。これより大きい検索条件を指定して検索すると,IwsSearcher.searchで検索エラーとなります。

ただし,文章検索は30,001文字目以降を無視します。また,UCS-2の範囲を超える文字は1文字を2文字として数えます。

表6-1 一度の検索で同時に指定できる検索条件の文字列の上限

検索条件上限
文章検索以外の文字列で指定する検索条件各検索条件の文字列の合計で2,000文字
文章検索30,000文字

検索結果のソート順や取得件数など,指定可能な各パラメータの初期値は次のとおりです。

表6-2 指定可能な各パラメータの初期値

メソッド機能概要初期値
setCount一度に取得する検索結果の件数を指定します。10
setCountOnlyヒット件数返却機能の使用有無を設定します。Fales
setDate日時検索条件を指定します。
setDateFilterType日時検索の範囲タイプを数値で指定します。0(DATE_TYPE_NONE)
setEndDate終了日時検索条件を指定します。
setHighLightClassName検索結果のハイライト箇所に埋め込まれる<span>タグに指定するクラス属性名を指定します。Highlight
setKeyword検索キーワードを指定します。
setMaxSize絞り込み条件としてコンテンツの最大サイズをbyte数で指定します。0
setMinSize絞り込み条件としてコンテンツの最小サイズをbyte数で指定します。0
setOrder検索結果の昇順降順を指定します。desc(降順)
setSearchLoginID検索ユーザーログインIDを指定します。
setSentence文章検索条件を指定します。
setSimilarID類似コンテンツ検索をするエントリIDを指定します。
setSnippetSize検索結果のスニペットのサイズをUTF-8のbyte数で指定します。
setSort検索結果のソートキーを指定します。SORT_KEY_SCORE
setStartIndex取得する検索結果の開始インデクスを指定します。1
setUseHighLight検索結果のタイトルとスニペットにハイライトタグを埋め込むかどうかを指定します。true
setUseHtmlEscape検索結果のタイトルとスニペット文字列に含まれるHTML特殊文字をエスケープするかどうかを指定します。true

IwsSearchCondクラスのメソッドを次の表に示します。

表6-3 IwsSearchCondクラスのメソッド

メソッド機能概要
IwsSearchCond検索条件オブジェクトを生成します。
addAddressアドレスによる絞り込みを追加します。
addAttribute属性による絞り込みを追加します。
addAttributeOr組み合わせた属性条件のどれかに一致した検索条件を追加します。
addAuthorユーザー名による絞り込みを追加します。
addCrawlType検索対象のクロールタイプを追加します。
addExtension拡張子による絞り込みを追加します。
addFileNameファイル名による絞り込みを追加します。
clearAddressListこれまでに追加したアドレスをすべて削除します。
clearAttributeこれまでに追加した属性をすべて削除します。
clearAttributeOrこれまでに追加した組み合わせた属性条件のどれかに一致した検索条件をすべて削除します。
clearAuthorListこれまでに追加したユーザー名をすべて削除します。
clearCrawlTypeこれまでに追加したクロールタイプをすべて削除します。
clearExtensionこれまでに追加した拡張子をすべて削除します。
clearFileNameListこれまでに追加したファイル名をすべて削除します。
getAddressList追加したアドレスをリスト形式で返します。
getAttribute追加した属性をハッシュマップ形式で返します。
getAttributeOr追加した組み合わせた属性条件のどれかに一致した検索条件を,ハッシュマップのリスト形式で返します。
getAuthorList追加したユーザー名をリスト形式で返します。
getCount現在指定されている検索結果取得件数を返します。
getCountOnly現在指定されているヒット件数返却機能の有無を返します。
getCrawlTypeList現在指定されている検索対象のクロールタイプをリスト形式で返します。
getDate現在指定されている日時検索条件を返します。
getDateFilterType現在指定されている日時検索の範囲タイプをコードで返します。
getEndDate現在指定されている終了日時検索条件を返します。
getExtensionList現在指定されている拡張子をリスト形式で返します。
getFileNameList現在指定されているファイル名をリスト形式で返します。
getHighLightClassName現在指定されているハイライトタグ用のクラス属性名を返します。
getKeyword現在指定されている検索キーワードを返します。
getMaxSize現在指定されている検索対象コンテンツ最大サイズを返します。
getMinSize現在指定されている検索対象コンテンツ最小サイズを返します。
getOrder現在指定されているソート順を返します。
getSearchLoginID現在指定されている検索ユーザーアカウント名を返します。
getSentence現在指定されている文章検索条件を返します。
getSimilarID現在指定されている類似コンテンツ検索するエントリIDを返します。
getSnippetSize現在指定されているスニペットサイズを返します。
getSort現在指定されている検索結果のソートキーを返します。
getStartIndex現在指定されている検索結果開始インデクスを返します。
getUseHighLight現在指定されているハイライトタグの埋め込みの有無を返します。
getUseHtmlEscape現在指定されているHTMLエスケープの有無を返します。
setCount一度に取得する検索結果の件数を指定します。
setCountOnlyヒット件数返却機能の使用有無を設定します。
setDate日時検索条件を指定します。
setDateFilterType日時検索の範囲タイプを数値で指定します。
setEndDate終了日時検索条件を指定します。
setHighLightClassName検索結果のハイライト箇所に埋め込まれる<span>タグに指定するクラス属性名を指定します。
setKeyword検索キーワードを指定します。
setMaxSize絞り込み条件としてコンテンツの最大サイズをbyte数で指定します。
setMinSize絞り込み条件としてコンテンツの最小サイズをbyte数で指定します。
setOrder検索結果の昇順降順を指定します。
setSearchLoginID検索ユーザーログインIDを指定します。
setSentence文章検索条件を指定します。
setSimilarID類似コンテンツ検索をするエントリIDを指定します。
setSnippetSize検索結果のスニペットのサイズをUTF-8のbyte数で指定します。
setSort検索結果のソートキーを指定します。
setStartIndex取得する検索結果の開始インデクスを指定します。
setUseHighLight検索結果のタイトルとスニペットにハイライトタグを埋め込むかどうかを指定します。
setUseHtmlEscape検索結果のタイトルとスニペット文字列に含まれるHTML特殊文字をエスケープするかどうかを指定します。
<この節の構成>
6.1.1 フィールドの詳細