jp.co.intra_mart.foundation.contentssearch.model.query

インタフェース SearchQuery

すべてのスーパーインタフェース:

Delegatable<SearchQuery>, Serializable

既知の実装クラスのリスト:

Query

public interface SearchQuery
extends Delegatable<SearchQuery>, Serializable

検索クエリを指定するためのインターフェースです。

バージョン:

8.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SearchQuery	addFacetFields(Field... fields) ファセット検索に使用するフィールドを設定します。
SearchQuery	addFacetQuery(Searchable... conditions) ファセット検索に使用する条件を設定します。
SearchQuery	addFieldToOutput(Field... fields) 検索結果に出力するフィールドを設定します。
SearchQuery	addFilterQuery(Searchable... conditions) フィルタ検索用の検索クエリを設定します。
SearchQuery	addSnippetsFields(Field... fields) 検索結果にスニペットを出力するフィールドを指定します。
SearchQuery	addSortBy(Field field, boolean descending) 検索結果のソート条件を設定します。
SearchQuery	setCondition(Searchable condition) 検索条件を設定します。
SearchQuery	setOffset(long offset) 検索条件にマッチしたコンテンツのうち何件目からを検索結果に出力するかを指定します。
SearchQuery	setRows(long rows) 検索条件にマッチしたコンテンツから最大で何件の検索結果を出力するかを指定します。
SearchQuery	setSnippetsNumber(int number) 単位フィールド毎に出力するスニペット数を設定します。

インタフェースから継承されたメソッド jp.co.intra_mart.foundation.contentssearch.common.Delegatable

getDelegator

メソッドの詳細

setCondition

SearchQuery setCondition(Searchable condition)

検索条件を設定します。

パラメータ:

condition - 条件。nullを与える事はできません。

戻り値:

検索クエリ

addFilterQuery

SearchQuery addFilterQuery(Searchable... conditions)

フィルタ検索用の検索クエリを設定します。

パラメータ:

conditions - 条件。nullを与える事はできません。

戻り値:

検索クエリ

addFieldToOutput

SearchQuery addFieldToOutput(Field... fields)

検索結果に出力するフィールドを設定します。

パラメータ:

fields - フィールド名。nullを与える事はできません。

戻り値:

検索クエリ

addSortBy

SearchQuery addSortBy(Field field,
                      boolean descending)

検索結果のソート条件を設定します。

パラメータ:

field - フィールド名。nullを与える事はできません。

descending - 昇順ソートの場合はfalseを、降順ソートの場合はtrueを設定します。

戻り値:

検索クエリ

addFacetFields

SearchQuery addFacetFields(Field... fields)

ファセット検索に使用するフィールドを設定します。

パラメータ:

fields - フィールド名。nullを与える事はできません。

戻り値:

検索クエリ

addFacetQuery

SearchQuery addFacetQuery(Searchable... conditions)

ファセット検索に使用する条件を設定します。

パラメータ:

conditions - 検索条件 nullを与える事はできません。

戻り値:

検索クエリ

addSnippetsFields

SearchQuery addSnippetsFields(Field... fields)

検索結果にスニペットを出力するフィールドを指定します。

パラメータ:

fields - フィールド名。nullを与える事はできません。

戻り値:

検索クエリ

setSnippetsNumber

SearchQuery setSnippetsNumber(int number)

単位フィールド毎に出力するスニペット数を設定します。

パラメータ:

number - スニペット数。1以上の値を設定して下さい。

戻り値:

検索クエリ

setOffset

SearchQuery setOffset(long offset)

検索条件にマッチしたコンテンツのうち何件目からを検索結果に出力するかを指定します。

パラメータ:

offset - 出力を開始するコンテンツのオフセット

戻り値:

検索クエリ

setRows

SearchQuery setRows(long rows)

検索条件にマッチしたコンテンツから最大で何件の検索結果を出力するかを指定します。

パラメータ:

rows - 出力する検索結果の最大値。

戻り値:

検索クエリ