getAllDocumentsByKey (View - Java™)

ビュー内の列の値に基づいて文書を検索します。 ユーザーはキーまたはキーのベクトルを作成し、それぞれのキーはビュー内のソートされた列の値に対応します。 このメソッドは、その列の値がキーに一致するすべての文書を返します。

定義位置

View

構文

public DocumentCollection getAllDocumentsByKey(java.util.Vector keys)
    throws NotesException
public DocumentCollection getAllDocumentsByKey(Object key)
    throws NotesException
public DocumentCollection getAllDocumentsByKey(java.util.Vector keys, boolean exact)
    throws NotesException
public DocumentCollection getAllDocumentsByKey(Object key, boolean exact)
    throws NotesException

パラメータ

java.util.Vector keys

ビュー内のソート済みの列と比較される String、Number、DateTime、または DateRange オブジェクトです。ベクトルの 1 番目の要素はビューのソートされた最初の列と比較され、2 番目の要素はビューのソートされた 2 番目の列と比較されます。

Object key

ビュー内の最初のソート済み列と比較される String、Number、DateTime、または DateRange オブジェクトです。

boolean exact

完全一致で検索する場合は true を指定します。 false を指定するかこのパラメータを省略すると、部分的に一致するものも検索されます。

戻り値

DocumentCollection

ビュー内で列の値が各キーの値と一致したすべての文書。 一致するエントリがない場合、コレクションは空で、カウント数はゼロになります。

使用法

キーを使用して getAllDocumentsByKey メソッドを使用するには、ベクトル内のキーごとに少なくとも 1 列はソートしておく必要があります。

このメソッドは、列の値がキーに一致するすべての文書を返します。 最初の文書のみを検索するには、getDocumentByKey を使用してください。

このメソッドで返される文書は特定の順序で表示されることはありません。また、列の値にアクセスすることもできません。このような目的に対しては getAllEntriesByKey を使用してください。

一致するアイテムの大文字、小文字は区別されません。 例えば、Turban は turban と一致します。 完全一致では、cat は cat と一致しますが、category とは一致しません。 また、20 は 20 と一致しますが、201 とは一致しません。 部分一致では、「T」が「Tim」や「turkey」とも一致し、「attic」とは一致しません。「cat」は「catalog」や「category」とも一致し、「coat」や「bobcat」とは一致しません。

部分一致を複数のキーで使用すると、結果として一部の文書が検索されない場合があります。 最初のキーを部分一致にした場合、2 番目の列でそのキーが完全一致と同じようにソートされていないと、順序の異なる文書は検索されません。

同じ列内で (「¥¥」特殊文字を使用して) カテゴリとサブカテゴリによってフォーマットされている列がある場合、このメソッドでは文書は検出されません。

文書のビューエントリ情報を取り出すには、getAllEntriesByKey メソッドを使用します。

クロスリファレンス

LotusScript® NotesView クラスの GetAllDocumentsByKey メソッド