<CSP:SEARCH>

CLASSNAME

必須項目の CLASSNAME 名属性は、実行されるクエリ、つまり SQL クエリの FROM 節に対し、クラス名を指定します。これは、SQL テーブル名ではなく クラス名 であることに注意してください。クラス名と SQL 名は、異なる場合があります。

WHERE

WHERE 属性には、コンマで区切られた 1 つ以上のフィールド名 (プロパティ名ではなく SQL 名。プロパティ名と SQL 名は異なる場合があります) のリストがあり、(SQL クエリの WHERE 節にあるフィールドの) 検索条件として使用されます。検索ページには、各フィールドに対しユーザが検索値を入力できるフィールドを表示します。

WHERE 属性を省略した場合、検索ページは、検索フィールドにオブジェクト ID 列を使用します。SELECT 属性を省略した場合、WHERE 属性は SQL クエリの SELECT リストも指定します。

SELECT 属性同様、WHERE 属性内では、フィールド名として、以下のような式を使用できます。以下はその概要です。

以下は、WHERE 属性の使用例です。

<!-- Define a search function -->
<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person"
WHERE="Name,SSN,Spouse->Name">

<!-- invoke the search function -->
<FORM>
<INPUT TYPE="button" VALUE="Search" ONCLICK="mySearch();">
</FORM>

WHERE 節のフィールドで使用する条件は、PREDICATES 属性により指定します。

以下は、エイリアスを持つ WHERE 属性の使用例です。ISCLName というプロパティと、ISCLFName という別のプロパティを持つクラスがあると仮定します。これらのプロパティを "ISCLName” および ”ISCLFName” の代わりにそれぞれ "Last Name" および ”First Name” として検索ページに表示する場合、以下のようにエイリアスを指定します。

<csp:search NAME="my_search" CLASSNAME="Test.NewClass4" 
WHERE="ISCLName Last Name, ISCFName First Name">

SELECT

検索結果に表示される値を制御するには、SELECT 属性を使用します。これには、検索クエリの SELECT リストとして使用する、コンマで区切られた 1 つ以上の SQL フィールド名が含まれます。

例えば、以下のようになります。

<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person"
WHERE="Name" SELECT="Name,SSN,Spouse->Name Spouse,Home.City City">

この場合、検索ページの結果は、SELECT 属性で指定した 4 列を表示します。

WHERE 属性では、Spouse->Name のように、-> (参照) 構文を使用して関連するクラスで定義されているプロパティを参照できます。埋め込みオブジェクトのプロパティを参照するには、ドット構文 Home.City を使用します。エイリアス (列のヘッダとして使用される名前) を定義するには、Name Alias のようにフィールド名の後にエイリアスを記述します。

SELECT 属性を省略する場合、WHERE 属性で指定されるフィールドを使用します。

PREDICATES

PREDICATES 属性を使用して、検索ページが WHERE 属性のフィールドを使用する方法を制御します。この属性には、コンマで区切られた演算子名のリスト (以下の表参照) を含みます。これは WHERE 属性にリストされたフィールドに対応します。

PREDICATES 属性を省略する場合、検索ページは、すべての文字列プロパティには %startswith を、その他のプロパティには = を使用します。PREDICATES リスト内に対応する項目を持たない WHERE リスト内の任意の項目には、既定の演算子を使用します。

以下の比較演算子を、PREDICATES 属性内で使用できます。

以下は、PREDICATES 属性の使用例です。

<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person"
WHERE="Name,SSN,Spouse->Name"
PREDICATES="%startswith,=,contains"
>

この場合、検索ページは、Name が値で始まり、SSN が値と等しく、Spouse.Name が値を持つ Sample.PersonOpens in a new tab のすべてのインスタンスを検索します。

select 演算子が述語のリストに存在する場合、対応するフィールドの候補の値がすべて検索ページのドロップダウン・リストに表示されます。例えば、以下のようになります。

<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Employee"
WHERE="Name,Company->Name Company"
PREDICATES="%startswith,select"
>

この場合、検索ページはすべての Company Name を含むドロップダウン・リストを表示します。リストは、実行時に適切な SQL クエリを発行することにより生成されます。

SELECT %ID, Name FROM Sample.Company ORDER BY Name

検索ページは、ユーザが選択した値を使用して、最も効率的な方法でメインの検索を実行します。例えば、この場合、(JOIN ではなく) 任意の Company ID 値で Sample.EmployeeOpens in a new tab のすべてのインスタンスを検索します。

多数の (場合によっては何千もの) 値をとる可能性があるフィールドに対しては、select 演算子を使用しないでください。

ORDER

ORDER 属性を使用して、検索結果を最初に並べる順番を制御できます。これには、検索クエリの ORDER BY 節として使用される、コンマで区切られた 1 つ以上の SQL フィールド名が含まれます。

SHOWSQL

アプリケーションのトラブルシューティングには、CSP 検索ページで使用している実際の SQL クエリが役に立つ場合があります。これを実行するには、SHOWSQL 属性を 1 に設定します。これは、検索ページのクエリ結果および SQL クエリのテキストを表示します。

OPTIONS

OPTIONS 属性により、CSP 検索ページの特徴を制御できます。この値は、以下を 1 つ以上含む、コンマで区切られたリストです。

例えば、以下の検索関数の定義は、ソートを指定するラジオ・ボタン付きのポップアップ検索ページを実行します。

<!-- Define a search function -->
<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person" 
WHERE="Name,SSN" OPTIONS="popup,sortbox">

<!-- invoke the search function -->
<FORM>
<INPUT TYPE="button" VALUE="Search" ONCLICK="mySearch();">
</FORM>

CAPTION

CAPTION 属性により、検索ページの一番上に表示される表題を変更できます。例えば、以下のようになります。

<!-- Define a search function -->
<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person" 
WHERE="Name,SSN" CAPTION="This is my Search Page:">

<!-- invoke the search function -->
<FORM>
<INPUT TYPE="button" VALUE="Search" ONCLICK="mySearch();">
</FORM>

FEATURES

FEATURES 属性により、ポップアップ検索ウィンドウのサイズと外観を指定できます。CSP は、JavaScript 関数 window.open を呼び出して、ポップアップ検索ウィンドウを生成します。この関数は、新規ウィンドウの機能を制御する引数 features を取ります。CSP は、features 引数に FEATURES 属性の値を使用します。

FEATURES 属性には、コンマで区切られた特性値のリストが含まれます。スペースや空白は使用できません。リストの各要素ごとに形式があります。

feature[=value]

有効な特性名に関するリストは、JavaScript 関数リファレンスの Window.open メソッドを参照してください。

例えば、以下は、初期の高さと幅が 350 ピクセルのポップアップ検索ページの定義です。

<!-- Define a search function -->
<CSP:SEARCH NAME="mySearch" CLASSNAME="Sample.Person" WHERE="Name,SSN"
OPTIONS="popup" FEATURES="height=350,width=350">

<!-- invoke the search function -->
<FORM>
<INPUT TYPE="button" VALUE="Search" ONCLICK="mySearch();">
</FORM>

MAXROWS

MAXROWS 属性では、検索結果テーブルで表示する最大行数を指定できます。