org.iplass.mtp.impl.fulltextsearch

インタフェース FulltextSearchService

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

Service

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

AbstractFulltextSeachService, FulltextSearchLuceneService

public interface FulltextSearchService
extends Service

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	deleteAllIndex() テナントの全Indexデータを削除する。
void	deleteAllIndex(int tenantId) テナントの全Indexデータを削除する。
void	execCrawlEntity(int tenantId, java.lang.String... defNames) クロール処理を実行する。
void	execCrawlEntity(java.lang.String... defNames) クロール処理を実行する。
java.util.List<FulltextSearchResult>	execFulltextSearch(java.lang.String defName, java.lang.String keyword) 全文検索を実行し、検索結果情報を返す。
void	execRefresh() リフレッシュ処理を実行する。
<T extends Entity> SearchResult<T>	fulltextSearchEntity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityProperties, java.lang.String keyword) 全文検索を実行し、検索結果を返す。
<T extends Entity> SearchResult<T>	fulltextSearchEntity(java.lang.String keyword, FulltextSearchOption option) 全文検索を実行し、検索結果を返す。
<T extends Entity> SearchResult<T>	fulltextSearchEntity(java.lang.String defName, java.lang.String keyword) 全文検索を実行し、検索結果を返す。
java.util.List<java.lang.String>	fulltextSearchOidList(java.lang.String defName, java.lang.String keyword) 全文検索を実行し、検索結果のOIDリストを返す。
java.util.Map<java.lang.String,java.sql.Timestamp>	getLastCrawlTimestamp(java.lang.String... defNames) Entityの最終クロール時刻を返す。
int	getMaxRows() 検索時の最大検索結果件数を返す。
boolean	isThrowExceptionWhenOverLimit() 検索結果が最大件数以上の場合、エラーにするかを返す。
boolean	isUseFulltextSearch() 全文検索機能が利用可能かを返す。

インタフェースから継承されたメソッド org.iplass.mtp.spi.Service

destroy, init

メソッドの詳細

isUseFulltextSearch

boolean isUseFulltextSearch()

全文検索機能が利用可能かを返す。

戻り値:

true:利用可能

getMaxRows

int getMaxRows()

検索時の最大検索結果件数を返す。

戻り値:

最大検索結果件数

isThrowExceptionWhenOverLimit

boolean isThrowExceptionWhenOverLimit()

検索結果が最大件数以上の場合、エラーにするかを返す。

戻り値:

true: エラー

execCrawlEntity

void execCrawlEntity(int tenantId,
                     java.lang.String... defNames)

クロール処理を実行する。 Entity定義名が未指定の場合、全Entityを対象にする。

パラメータ:

tenantId - テナントID

defNames - Entity定義名

execCrawlEntity

void execCrawlEntity(java.lang.String... defNames)

クロール処理を実行する。 Entity定義名が未指定の場合、全Entityを対象にする。

パラメータ:

defNames - Entity定義名

execRefresh

void execRefresh()

リフレッシュ処理を実行する。

deleteAllIndex

void deleteAllIndex(int tenantId)

テナントの全Indexデータを削除する。

パラメータ:

tenantId - テナントID

deleteAllIndex

void deleteAllIndex()

テナントの全Indexデータを削除する。

getLastCrawlTimestamp

java.util.Map<java.lang.String,java.sql.Timestamp> getLastCrawlTimestamp(java.lang.String... defNames)

Entityの最終クロール時刻を返す。

パラメータ:

defNames - Entity定義名

戻り値:

最終クロール時刻のMap

fulltextSearchEntity

<T extends Entity> SearchResult<T> fulltextSearchEntity(java.lang.String defName,
                                                        java.lang.String keyword)

全文検索を実行し、検索結果を返す。

パラメータ:

defName - Entity定義名

keyword - キーワード

戻り値:

検索結果のEntityデータリスト

fulltextSearchEntity

<T extends Entity> SearchResult<T> fulltextSearchEntity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityProperties,
                                                        java.lang.String keyword)

全文検索を実行し、検索結果を返す。 entityPropertiesのkeyで指定したEntity定義名を検索対象とする。 また返すEntityデータに含まれるPropertyはentityPropertiesのvalueで指定したProperty名のリストを対象とする。

パラメータ:

entityProperties - 対象Entity定義名とプロパティ名のリストをセットにしたMap

keyword - キーワード

戻り値:

検索結果のEntityデータリスト

fulltextSearchEntity

<T extends Entity> SearchResult<T> fulltextSearchEntity(java.lang.String keyword,
                                                        FulltextSearchOption option)

全文検索を実行し、検索結果を返す。 optionのkeyで指定したEntity定義名を検索対象とする。 また返すEntityデータに含まれるPropertyはconditionsのpropertiesで指定したProperty名のリストを対象とする。

パラメータ:

keyword - キーワード

option - 全文検索時のオプション

戻り値:

検索結果のEntityデータリスト

fulltextSearchOidList

java.util.List<java.lang.String> fulltextSearchOidList(java.lang.String defName,
                                                       java.lang.String keyword)

全文検索を実行し、検索結果のOIDリストを返す。

パラメータ:

defName - Entity定義名

keyword - キーワード

戻り値:

検索結果のOIDリスト

execFulltextSearch

java.util.List<FulltextSearchResult> execFulltextSearch(java.lang.String defName,
                                                        java.lang.String keyword)

全文検索を実行し、検索結果情報を返す。

パラメータ:

defName - Entity定義名

keyword - キーワード

戻り値:

検索結果情報