Skip to main content link. Accesskey S
  • Help
  • HCL Logo
  • HCL Notes and Domino Application Development wiki
  • THIS WIKI IS READ-ONLY. Individual names altered for privacy purposes.
  • HCL Forums and Blogs
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • API Documentation
Search
Community Articles > 日本語 - Japanese > XPages データソース解説 - 種類
  • Share Show Menu▼
  • Subscribe Show Menu▼

Recent articles by this author

XPages データソース解説 - URL パラメータ

XPages のデータソースとページをアクセスする際の URL パラメータとの関係について解説します。

XPages データソース解説 - スコープ

XPages のデータソースのスコープについて解説します。

XPages データソース解説 - 定義方法

XPages のデータソースの定義方法について解説します。

XPages データソース解説 - 種類

XPages のデータソースの種類について解説します。

XPages データソース解説 - 内部動作

XPages のデータソースの内部動作について解説します。
Community articleXPages データソース解説 - 種類
Added by ~Martha Brekroflar | Edited by ~Martha Brekroflar on January 12, 2012 | Version 5
  • Actions Show Menu▼
expanded Abstract
collapsed Abstract
XPages のデータソースの種類について解説します。
Tags: XPages, データソース
ShowTable of Contents
HideTable of Contents
  • 1 データソースの種類
  • 2 Domino 文書
  • 3 Domino ビュー
NSF データベース上で動作する XPages アプリケーションが、NSF ファイル内のデータをアクセスする際に利用するのがデータソースです。
このシリーズでは、XPagesの重要な基本機能のひとつであるデータソースについて、網羅的に解説します。

シリーズ第一弾は、データソースの種類に付いて解説します。

シリーズ目次:
  • データソースの種類external link
  • データソースの定義方法external link
  • データソースのアクセス方法external link
  • データソースのスコープexternal link
  • データソースとURL パラメータexternal link
  • データソースの内部動作external link

データソースの種類


XPages が標準でサポートするのは以下の2種類のデータソースです。
  • Domino 文書
  • Domino ビュー

これらを順に解説します。

Domino 文書


Notes/Domino 文書をアクセスするためのデータソースです。読み込み/書き込み両モードで利用できます。

以下のプロパティをサポートします。

プロパティ役割
指定場所
action文書を開く際のアクションを指定します。

  (ブランク): 新規文書を作成します。
  openDocument: 既存文書を読み込みモードで開きます。
  EditDocument: 既存文書を編集モードで開きます。

openDocument/EditDocument を指定した場合でも、同時に documentId を指定しない場合には新規文書の作成となります。
データ
allowDeletedDocs一時的に削除された文章でも開くこと許可します。
データベースの「一時的削除を許可」属性が設定されている場合に有効です。

computeDocument文書の再計算が必要な場合に発生するイベントです。
このタイミングで実行するアクションを指定します。
より具体的には、文書がロードされた直後(postOpenDocumentの後)および
文書保存前の最終段階(querySaveDocumentの後、
実際に文書保存が行われる直前)に発生します。
イベント
computeWithFormフォームロジックを実行するタイミングを指定します。
指定したタイミングで文書に対して NotesDocument クラスの
computeWithForm() メソッドを実行します。

  (ブランク): 実行しません。
  onload: 文書のロード時に実行します。
  onsave: 文書の保存時に実行します。
  both: 文書のロード時、保存時両方で実行します。
データ
concurrencyMode同一文書を複数のユーザーが同時に編集した後、保存動作を指示した際の、
競合した編集内容を処理する方法を指定します。

  createResponse: 競合文書を返答文書として生成し保存ます。
  fail: 編集結果を破棄します。
  exception: 例外を発生させます。
  force: 上書き保存します。

デフォルトは createResponse です。
データ
databaseNameこのデータソースが対象とする文書を含むデータベース名を、
サーバー名、パス名を含めて指定します。
XPagesアプリケーションとは異なるサーバーに存在する場合、
「サーバー名!!データベース名」の形式で指定します。
データ
documentIdこのデータソースが対象とする文書の Note ID を指定します。
データ
formNameこのデータソースが対象とする文書のフォーム名を指定します。
データ
ignoreRequestParamsこのデータソースを作成する場合に、URLパラメータとして指定されている値を
無視するか利用するかをtrue/falseで指定します。
複数データソースを同一 XPage で利用する場合などに活用します。
詳しくは、「データソースとURL パラメータ」external linkの説明を参照してください。

loadedページロード時にこのデータソースを生成するかどうかを指定します。
条件によりデータソースを準備するかどうかをコントロールする場合に利用します。

parentId新規文書を既存文書の子文書として作成する場合に、親となる文書の
Note ID を指定します。
データ
postNewDocument新規文書の作成後に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
postOpenDocument既存文書をオープンした後に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
postSaveDocument文書を保存した後に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
queryNewDocument新規文書を作成する前に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
queryOpenDocument既存文書をオープンする前に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
querySaveDocument文書を保存する前に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
requestParamPrefixこのデータソースを作成する場合に参照するURLパラメータのキー名の
プレフィックスを指定します。
複数データソースを同一 XPage で利用する場合に活用します。
詳しくは、「データソースとURL パラメータ」external linkの説明を参照してください。

saveLinksAsNotes クライアントで作成したリッチテキストフィールドを含む文書を
XPage で編集、保存した場合、保存されるデータは HTML 形式となります。
そのため、リッチテキスト内にデータベースや文書へのリンクが含まれる場合、
それらは URL 形式のホットスポットに変換されます。
その際、URL のプロトコルとして http:// と notes:// の
いずれを利用するかを指定します。

  UseWeb: http:// プロトコルを利用します。
  UseNotes: notes:// プロトコルを利用します。

デフォルトは UseNotes です。

保存した文書を Notes クライアントで開き、ホットスポットをクリックした際、
notes:// が利用されている場合には Notes クライアントで開くことができますが、
http:// が利用されている場合には、ブラウザを開こうとします。

scopeこのデータソースの有効スコープを指定します
application/session/view/requestの中から選択します。
デフォルトは view スコープです。
詳しくは、「データソースのスコープ」external linkの説明を参照してください。

varこのデータソースを保存する変数名を指定します。
コントロールに対してこのデータソースをデータバインドする場合や、
JavaScript のロジックの中からアクセスする場合に利用します。
データ
webQuerySaveAgentデータソースを保存する前に実行するエージェントを指定します。
8.5.2 より、XPages から実行したエージェントでも、
インメモリー文書をアクセスすることが可能になっています。
そのため、エージェント内で、SaveOptionsフィールドに0を設定することにより、
データソースの保存をキャンセルすることができます。


これらのプロパティは全て、「プロパティ」ビューの「全てのプロパティ」タブから設定することができます。


また、指定場所が「データ」あるいは「イベント」となっているものに関しては、それぞれ専用の設定タブあるいはビューが用意されています。



Domino ビュー


Notes/Domino ビューをアクセスするためのデータソースです。読み込みモードで利用します。

以下のプロパティをサポートします。

プロパティ役割
指定場所
categoryFilterビューがカテゴリー分けされている場合に、
ビューに含まれるコンテンツを特定のカテゴリに含まれるものだけに制限します。
絞込みを行うカテゴリー名を指定します。
データ
databaseNameこのデータソースが対象とするビューを含むデータベース名を、
サーバー名、パス名を含めて指定します。
XPagesアプリケーションとは異なるサーバーに存在する場合、
「サーバー名!!データベース名」の形式で指定します。
データ
dataCacheこのデータソースが複数の HTTP リクエスト間でキャッシュするデータの種類を指定します。

  full: ビューエントリーの全てのデータ(列値などを含む)をキャッシュします。
  id: Note ID のみキャッシュします。
  nodata: 何もキャッシュしません。

デフォルトは full です。

部分更新を利用しながら、ビューデータソースが提供するエントリの情報を
アクセスするような XPage を作成する際に、パフォーマンスチューニングのために
利用します。

アクセスするエントリ情報として列値まで必要な場合には、full を指定します。
Note ID のみでよい場合には id を指定します。
エントリ情報を必要としない場合には nodata を指定できます。
データキャッシュに必要なメモリーはこの順で減少します。

expandLevelビューがカテゴリーや返答文書といった階層を持つ場合に、
展開して表示するレベルを指定します。

  0: 全ての階層を展開して表示します。
  1: 1レベルめだけを(つまり、全ての階層を省略して)表示します。
  2: 2レベルめまでを(つまり、1レベルめだけを展開して)表示します。
         :

デフォルトは0です。

ignoreRequestParamsこのデータソースを作成する場合に、URLパラメータとして指定されている値を
無視するか利用するかをtrue/falseで指定します。
複数データソースを同一 XPage で利用する場合などに活用します。
詳しくは、「データソースとURL パラメータ」external linkの説明を参照してください。

keysビューがソートされた列を持つ場合、その列の値によって絞込みを行います。
単純文字列、あるいは複数の文字列からなる配列値を指定します。
ひとつのキーがひとつのソートされた列に相当します。
指定文字列がソートされた列の数より少ない場合には、
指定がない列の値は絞込みに利用されません。
データ
keysExactMatchkeys プロパティで指定した値を完全一致で利用するかどうかを true/falseで指定します。
部分一致を指定した場合、指定したキーを先頭に持つ列値が一致します。
データ
loadedページロード時にこのデータソースを生成するかどうかを指定します。
条件によりデータソースを準備するかどうかをコントロールする場合に利用します。

parentIdビューに含まれるコンテンツを、特定の文書の返答文書およびその子孫に制限します。
絞込みを行う親文書の Note ID を指定します。

postOpenViewビューをオープンした後に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
queryOpenViewビューをオープンする前に発生するイベントです。
このタイミングで実行するアクションを指定します。
イベント
requestParamPrefixこのデータソースを作成する場合に参照するURLパラメータのキー名の
プレフィックスを指定します。
複数データソースを同一 XPage で利用する場合に活用します。
詳しくは、「データソースとURL パラメータ」external linkの説明を参照してください。

scopeこのデータソースの有効スコープを指定します
application/session/view/requestの中から選択します。
デフォルトは view スコープです。
詳しくは、「データソースのスコープ」external linkの説明を参照してください。

searchビューに対して全文検索の絞込みを行います。
検索文字列を指定します。
この機能を利用するためには、データベースに対して全文索引が
作成されている必要があります。
データ
searchExactMatch全文検索時に完全一致を検査するかどうかを true/false で指定します。
searchFuzzy全文検索時にあいまい検索を行うかどうかを true/false で指定します。
searchList全文検索に使用する検索文字列を複数、配列の形で指定します。
配列内の全ての文字列が含まれるよう絞込みが行われます。

searchMaxDocs全文検索結果に含める最大件数を指定します。
searchVariants全文検索時に単語の語尾変化を考慮するかどうかを true/false で指定します。
sortColumnビューをソートする列名を指定します。
指定する列には元のビューでソートが設定されている必要があります。
データ
sortOrderビューのソート順を指定します。

  ascending: 昇順に並べます。
  descending: 降順に並べます。

startKeysビューを表示する際、先頭となるエントリーをキーで指定します。
指定方法は keys パラメータと同です。

varこのデータソースを保存する変数名を指定します。
コントロールに対してこのデータソースをデータバインドする場合や、
JavaScript のロジックの中からアクセスする場合に利用します。
データ
viewNameこのデータソースが対象とするビューの名前を指定します。
データ

これらのプロパティは全て、「プロパティ」ビューの「全てのプロパティ」タブから設定することができます。


また、指定場所が「データ」あるいは「イベント」となっているものに関しては、それぞれ専用の設定タブあるいはビューが用意されています。



  • Actions Show Menu▼


expanded Attachments (0)
collapsed Attachments (0)
Edit the article to add or modify attachments.
expanded Versions (5)
collapsed Versions (5)
Version Comparison     
VersionDateChanged by              Summary of changes
This version (5)Jan 12, 2012, 5:07:21 AM~Martha Brekroflar  
4Jan 12, 2012, 5:02:56 AM~Yoshi Froluchekettu  Minor Change
3Jan 12, 2012, 2:24:05 AM~Yoshi Froluchekettu  
1Jan 12, 2012, 2:14:00 AM~Yoshi Froluchekettu  
0Jan 12, 2012, 2:14:37 AM~Yoshi Froluchekettu  
expanded Comments (0)
collapsed Comments (0)
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedAbout
  • HCL Software
  • HCL Digital Solutions community
  • HCL Software support
  • BlogsDigital Solutions blog
  • Community LinkHCL Software forums and blogs
  • About HCL
  • Privacy
  • Accessibility