全文検索を指定すると、データベース内の次の文書を返します。

• 現在のエージェントが未処理とみなす文書。
• および検索条件に一致する文書。

定義が行われるクラスAgentContext
構文public DocumentCollection unprocessedFTSearchRange(String query, int maxdocs, int start)
throws NotesException
public DocumentCollection unprocessedFTSearchRange(String query, int maxdocs, int sortopt, int otheropt, int start)
throws NotesException

パラメータString query

全文検索の検索条件です。

取得する文書数の最大値です。0 を指定すると、一致する文書をすべて取得します。

次のいずれかを使用してソートオプションを指定します。
• Database.FT_SCORES (デフォルト) は、適合スコアを使用して、適合性の高い順にソートします。
• Database.FT_DATECREATED_DES を指定すると、文書作成日によりソートされます (降順)。
• Database.FT_DATECREATED_ASC を指定すると、文書作成日によりソートされます (昇順)。
• Database.FT_DATE_DES を指定すると、文書の日付によりソートされます (降順)。
• Database.FT_DATE_ASC を指定すると、文書の日付によりソートされます (昇順)。

Integer。次の定数を使用して、その他の検索オプションを指定します。オプションを複数指定するには、論理 OR 演算子を使用します。
• Database.FT_DATABASE を指定すると、検索範囲に Lotus Domino データベースが含まれます。
• Database.FT_FILESYSTEM を指定すると、検索範囲に Lotus Domino データベース以外のファイルが含まれます。
• Database.FT_FUZZY を指定すると、あいまい検索が実行されます。
• Database.FT_STEMS を指定すると、検索の基準として語幹が使用されます。

返される開始文書です。

処理されていない、検索に一致する文書コレクションを返します。選択したオプションでソートされています。

動作方法このメソッドは、次の 2 段階で動作します。

• まず、エージェントが「未処理」であるとみなした文書コレクションが検索されます。エージェントの種類により、どの文書が未処理と考えられるかが決まります。この文書コレクションは、getUnprocessedDocuments によって返されるものと同じです。
• 次に、未処理の文書に対して全文検索が行われ、検索に一致する文書のコレクションが返されます。

返される文書次の表に、unprocessedFTSearch によって返される文書を示します。エージェントの実行前に、1 度文書が選択されます。

エージェントの実行対象	unprocessedFTSearch によって返される文書が満たすべき要件
データベースのすべての文書	[エージェントのプロパティ] ボックスで指定された検索条件に一致すること このメソッドで指定された全文検索条件に一致すること
作成または変更されたすべての文書	このエージェントが updateProcessedDoc を使用して処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] ボックスで指定された検索条件に一致すること このメソッドで指定された全文検索条件に一致すること
ビューのすべての未読文書	開かれておらず、ビューに存在すること [エージェントのプロパティ] ボックスで指定された検索条件に一致すること このメソッドで指定された全文検索条件に一致すること
ビューのすべての文書	ビューに存在すること [エージェントのプロパティ] ボックスで指定された検索条件に一致すること このメソッドで指定された全文検索条件に一致すること
すべての選択文書	ビューで選択されていること [エージェントのプロパティ] ボックスで指定された検索条件に一致すること このメソッドで指定された全文検索条件に一致すること
なし	現在の文書であること

updateProcessedDoc の使い方新規作成および変更された文書で実行されるエージェントの場合、updateProcessedDoc を使用して各文書を「処理済み」としてマークする必要があります。これによって、文書がエージェントから (再度変更されない限り) 1 度しか処理されないことが保証されます。各文書に対してこのメソッドを呼び出さないと、エージェントは次に実行されたときに同じ文書を処理します。
updateProcessedDoc メソッドは、メソッドの呼び出し元の特定のエージェントに対してのみ、文書を処理済みとしてマークします。あるエージェントで updateProcessedDoc を使用しても、別のエージェントが処理する文書には影響ありません。

他のすべてのエージェントとビューアクションでは、updateProcessedDoc は無効となります。

ビューアクションunprocessedFTSearch はビューアクション内で使用された場合、選択した文書に対して実行されるエージェントと同じ文書を返します。
全文索引データベースに全文索引が作成されていなくてもこのメソッドは動作しますが、処理効率は低下します。索引を調べるには、isFTIndexed を使用します。ローカルデータベースに索引を作成するには、updateFTIndex を使用します。
デフォルトでは、このメソッドは最大 5,000 件の文書を返します。索引付きのデータベースまたは索引は付いていないがクライアントのエージェントで実行されているデータベースの場合は、Notes.ini 変数 FT_MAX_SEARCH_RESULTS でこの制限を変更します。索引が付いておらず、サーバーのエージェントで実行されているデータベースの場合は、Notes.ini 変数 TEMP_INDEX_MAX_DOC も設定する必要があります。絶対的な最大値は 2,147,483,647 となります。

オプションソートオプションを指定しないと、文書は適合スコアによりソートされます。コレクションを適合スコアに従ってソートすると、最も関連性の高い文書が先頭に配置されます。コレクション内の各文書の適合スコアにアクセスするには、Document の FTSearchScore プロパティを使用します。
日付によるソートを指定した場合は、適合スコアは取得されません。返された DocumentCollection を Newsletter オブジェクトに渡すと、ソートオプションに応じて文書作成日または適合スコアのいずれかを使用して、文書リンクレポートが書式化されます。

検索構文語句を検索するには語句をそのまま入力します。ただし検索キーワードは引用符で囲む必要があります。リテラル内の二重引用符はエスケープ処理してください。
ワイルドカード、演算子、およびその他の検索構文も使用できます。構文規則について詳しくは、『Lotus Notes ヘルプ』の「特定のテキストを含む文書をデータベースで検索する」を参照してください。

クロスリファレンスLotusScript NotesDatabase クラスの UnprocessedFTSearchRange メソッド
例
関連項目

Java クラス内で文書を検索して収集する
エージェントにアクセスする

用語集