getAllDocumentsByKey (NotesView - JavaScript)

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

定義場所

NotesView

構文

getAllDocumentsByKey(key:any) : NotesDocumentCollection

getAllDocumentsByKey(keys:java.util.Vector) : NotesDocumentCollection

getAllDocumentsByKey(key:any, exact:boolean) : NotesDocumentCollection

getAllDocumentsByKey(keys:java.util.Vector, exact:boolean) : NotesDocumentCollection

パラメータ 説明
key ビュー内のソートされた最初の列と比較される String、Number、NotesDateTime、NotesDateRange オブジェクト。
keys ビュー内のソートされた列と比較される String、Number、NotesDateTime、NotesDateRange オブジェクト。ベクトルの最初の要素は、ビュー内のソートされた最初の列と比較され、 2 番目の要素はソートされた 2 番目の要素と比較されるというように対応します。
exact 完全一致で検索する場合は true を指定します。 部分一致で検索する場合は、このパラメータに false を指定するか、省略します。
戻り値 説明
NotesDocumentCollection ビュー内で列の値が各キーの値と一致したすべての文書。 一致する文書がない場合、コレクションは空になり、カウントはゼロです。

使用法

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

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

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

一致するアイテムの大文字、小文字は区別されません。 例えば、Turban は turban と一致します。 完全一致では、cat は cat と一致しますが、category とは一致しません。 また、20 は 20 と一致しますが、201 とは一致しません。 部分一致の場合、T は Tim や turkey と一致しますが、 attic とは一致しません。 また、cat は catalog や category と一致しますが、 coat や bobcat とは一致しません。 部分一致を複数のキーで使用すると、結果として一部の文書が検索されない場合があります。 最初のキーを部分一致にした場合、2 番目の列でそのキーが完全一致と同じようにソートされていないと、順序の異なる文書は検索されません。

文書に関するビューエントリ情報を取得するには、 getAllEntriesByKey メソッドを使用してください。

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

例

以下のボタンは、最初のソート列が指定のストリングで始まるビュー内のすべての文書を取得します。
var v:NotesView = database.getView("main");
var dc:NotesDocumentCollection = v.getAllDocumentsByKey(requestScope.query);
if (dc.getCount() == 0) {
	requestScope.status = "No subjects starting with that query";
	return;
}
var doc:NotesDocument = dc.getFirstDocument();
while (doc != null) {
	requestScope.status += "¥n" + 
		doc.getItemValueString("subject");
	var tmpdoc = dc.getNextDocument();
	doc.recycle();
	doc = tmpdoc;
}
以下のボタンは、最初のソート列が「カテゴリ 1」で始まり、2 番目のソート列が指定されたストリングで始まるビュー内のすべての文書を取得します。
var v:NotesView = database.getView("categorized");
var query = new java.util.Vector();
query.addElement("Category 1");
query.addElement(requestScope.query);
var dc:NotesDocumentCollection = v.getAllDocumentsByKey(query);
if (dc.getCount() == 0) {
	requestScope.status = "No subjects starting with that query";
	return;
}
var doc:NotesDocument = dc.getFirstDocument();
while (doc != null) {
	requestScope.status += "¥n" + 
		doc.getItemValueString("subject");
	var tmpdoc = dc.getNextDocument();
	doc.recycle();
	doc = tmpdoc;
}

言語間の参照

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

Java™ View クラスの getAllDocumentsByKey メソッド

親トピック: NotesView (JavaScript)