DocumentCollection (Java)

指定された基準で選択された、データベースからの文書のコレクションを表します。

構文

public class DocumentCollection extends NotesBase

包含関係

包含元: AgentContextDatabaseView

包含要素: Document

プロパティ

Count (getCount を使用)

IsSorted (isSorted を使用)

Parent (getParent を使用)

Query (getQuery を使用)

UntilTime (getUntilTime を使用)

メソッド

addDocument

clone

contains

deleteDocument

FTSearch

getDocument

getFirstDocument

getLastDocument

getNextDocument

getNthDocument

getPrevDocument

intersect

markAllRead

markAllUnread

merge

putAllInFolder

recycle

removeAll

removeAllFromFolder

stampAll

stampAllMulti メソッド

subtract

updateAll

アクセス

DocumentCollection は、データベース内の全文書のサブセットを表します。サブセット内の文書は、データベース検索に使用される次のいずれかのメソッドまたはプロパティにより決定されます。

使用法

DocumentCollection、ViewEntryCollectionViewNavigator の各オブジェクトは、いずれもデータベース内の文書へのアクセスを提供します。DocumentCollection オブジェクトは以下の場合に使用します。

ビューにはデータベース自体によってすでに索引が作成されているので、ビューを使用すると文書に効率良くアクセスできます。 ただし、ビューを使用しても必ずしも目的の文書にアクセスできるわけではありません。ViewEntryCollection と ViewNavigator は、ViewEntry と文書情報を含むビューエントリへのアクセスを提供します。ViewNavigator は、文書だけでなくカテゴリと合計へのアクセスも提供します。

コレクションのソート

コレクション内の文書がソートされるのは、コレクションが検索の結果として作成されたときです。これとは対照的に、ViewEntryCollection と ViewNavigator からアクセスした文書は、ビューの順番に並びます。

現在のポインタ

現在のポインタは、文書コレクション用に保持されます。すべてのナビゲーションメソッドは、現在のポインタを取得された文書に設定します。ただし次の例外があります。Add メソッドと Delete メソッドは現在のポインタを移動しません。また、現在のポインタを最初の文書に設定するメソッドがあります。それらは、FTSearch、removeAll (リモート IIOP のみ)、putAllInFolder、removeAllFromFolder、stampAll です。

削除スタブ

削除スタブは、コレクション作成後に削除された文書、または読者レベルのアクセス権を持たない文書に対して返されます。文書が実際に存在するか (true)、または削除スタブであるか (false) を調べるには、Document の isValid を使用します。