データベース内のすべてのデータ文書が入っている DocumentCollection オブジェクトを取得するには、Database の getAllDocuments を使用します。現在のエージェントの指定に依存する文書、たとえば、選択された文書、エージェントの最後の実行後に変更された文書などを取得するには、AgentContext の getUnprocessedDocuments を使用します。指定した時刻以降に修正された文書を取得するには、Database の getModifiedDocuments を使用します。

DocumentCollection クラスには、文書アクセス用の次のプロパティとメソッドがあります。

• getFirstDocument と getNextDocument は、ループで最初の文書から順番に文書を取得するために使用できます。ループは次の文書が null になるまで継続します。
• getLastDocument と getPrevDocument は、ループで最後の文書から逆の順番で文書を取得するために使用できます。ループは前の文書が null になるまで継続します。
• getCount はコレクション内の文書数を取得するために、getNthDocument はコレクション内の一連の文書のうち特定の文書を取得するために使用できます。
• getDocument は、現在の文書コレクション内の指定された文書を検索します。

文書コレクション内の文書は、コレクションが検索の結果生成されたものである場合にだけ順序が付けられます。それ以外の場合は、文書は特定の順序にはなっていません。

DocumentCollection オブジェクトを作成した後に調整するには、addDocument と deleteDocument を使用します。

エージェントを使用して未処理文書の処理をする場合、それらの文書には更新済みとしてマークする必要があります。これは、これ以降にエージェントを実行する際に、古い文書として認識されるようにするためです。これには、NotesDocumentCollection の updateAll か AgentContext の updateProcessedDoc を使用します。

DocumentCollection クラスには、次のプロパティが含まれています。

• getCount は、コレクション内の文書数を含む int 型の値を返します。
• isSorted は、文書コレクションがソートされている場合に true を返します。
• getParent は、コレクションを含むデータベースを表す Database オブジェクトを返します。
• getQuery は、コレクションを作成した検索のテキストを含む String 型の値を返します。
• getUntilTime は、Database の getModifiedDocuments によって作成されたコレクションのデータベース終了時刻を表す DateTime オブジェクトを返します。

Java クラス内で文書にアクセスする

用語集