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

クラス Query

java.lang.Object

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

すべての実装されたインタフェース:

Serializable, Delegatable<SearchQuery>, SearchQuery

public class Query
extends Object
implements SearchQuery

検索クエリを指定するためのクラスです。

バージョン:

8.0.0

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected SearchQuery	delegate 実装の委譲インスタンス

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Query() クエリを初期化します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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	getDelegator() 委譲先の実装クラスを取得します。
SearchQuery	setCondition(Searchable condition) 検索条件を設定します。
SearchQuery	setOffset(long offset) 検索条件にマッチしたコンテンツのうち何件目からを検索結果に出力するかを指定します。
SearchQuery	setRows(long rows) 検索条件にマッチしたコンテンツから最大で何件の検索結果を出力するかを指定します。
SearchQuery	setSnippetsNumber(int number) 単位フィールド毎に出力するスニペット数を設定します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

delegate

protected final SearchQuery delegate

実装の委譲インスタンス

コンストラクタの詳細

Query

public Query()

クエリを初期化します。

メソッドの詳細

setCondition

public SearchQuery setCondition(Searchable condition)

検索条件を設定します。

定義:

setCondition インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.setCondition(jp.co.intra_mart.foundation.contentssearch.model.query.Searchable)

addFilterQuery

public SearchQuery addFilterQuery(Searchable... conditions)

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

定義:

addFilterQuery インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.addFilterQuery(jp.co.intra_mart.foundation.contentssearch.model.query.Searchable[])

addFieldToOutput

public SearchQuery addFieldToOutput(Field... fields)

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

定義:

addFieldToOutput インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

jp.co.intra_mart.foundation.contentssearch.model.query.SearchQuery#addFieldToOutput(java.lang.String[])

addSortBy

public SearchQuery addSortBy(Field field,
                             boolean descending)

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

定義:

addSortBy インタフェース内 SearchQuery

パラメータ:

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

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

戻り値:

検索クエリ

関連項目:

jp.co.intra_mart.foundation.contentssearch.model.query.SearchQuery#addSortBy(java.lang.String, boolean)

addFacetFields

public SearchQuery addFacetFields(Field... fields)

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

定義:

addFacetFields インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

jp.co.intra_mart.foundation.contentssearch.model.query.SearchQuery#addFacetFields(java.lang.String[])

addFacetQuery

public SearchQuery addFacetQuery(Searchable... conditions)

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

定義:

addFacetQuery インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.addFacetQuery(jp.co.intra_mart.foundation.contentssearch.model.query.Searchable[])

addSnippetsFields

public SearchQuery addSnippetsFields(Field... fields)

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

定義:

addSnippetsFields インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

jp.co.intra_mart.foundation.contentssearch.model.query.SearchQuery#addSnippetsFields(java.lang.String[])

setSnippetsNumber

public SearchQuery setSnippetsNumber(int number)

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

定義:

setSnippetsNumber インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.setSnippetsNumber(int)

setOffset

public SearchQuery setOffset(long offset)

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

定義:

setOffset インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.setOffset(long)

setRows

public SearchQuery setRows(long rows)

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

定義:

setRows インタフェース内 SearchQuery

パラメータ:

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

戻り値:

検索クエリ

関連項目:

SearchQuery.setRows(long)

getDelegator

public SearchQuery getDelegator()

委譲先の実装クラスを取得します。

定義:

getDelegator インタフェース内 Delegatable<SearchQuery>

戻り値:

実装クラス

関連項目:

Delegatable.getDelegator()