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　フィールドの詳細