Apdesigner プログラマーズガイド

12.3.2 アクセスクラス

アクセスクラスは、Interstage Shunsaku APIのXML文書が検索できるインタフェースを扱いやすいようにしたクラスです。このクラスの特徴を説明します。

+検索式をメソッドとして表現する

アクセスクラスでは、1つの検索式を1つのメソッドとして表現します。また、検索する文字列のように動的に変更したい値は、メソッドのパラメタで指定できます。検索式とは、Interstage Shunsakuから特定のXML文書を検索する場合に指定する条件の式です。
このメソッドは、Shunsakuアクセスソース生成ウィザードの[検索メソッドの作成]ページで指定した情報をもとに生成されます。以下に生成されるメソッドの例を示します。

例)

public void searchOs(String os) throws ShunException {
    String escapeKey1;
    String queryString;
    
    escapeKey1 = toEscapeString(os);
    // 検索式の作成
    queryString = "/software/os = '" + escapeKey1 + "'";
    // XML文書を検索する
    getPreparedStatement(queryString, "/");
}

Shunsakuアクセスソース生成ウィザードでは、よく利用するメソッドを必ず生成します。生成するメソッドは、XML文書にある全ての要素を検索するsearchAllXMLsByANDメソッドとsearchAllXMLsByORメソッドです。

+引数にソート式を指定する

アクセスクラスでは、検索結果を参照するメソッドの引数にソート式が指定できます。ソート式とは、検索結果をソートする場合に指定する条件の式です。
ソート式は、static宣言したフィールドに定義します。static宣言したフィールドを指定できるメソッドは、getResultDataメソッドとgetResultSetメソッドです。
static宣言したフィールドは、Shunsakuアクセスソース生成ウィザードの[ソート式の作成]ページで指定した情報をもとに生成されます。
以下にstatic宣言したフィールドの例を示します。

例)

public static final String SORT_NAME = "/software/name/text()";

+検索結果をデータクラスに対応づける

アクセスクラスでは、検索結果に含まれる1つ1つのXML文書をデータクラスに対応づけることができます。この機能を利用するにはgetResultDataメソッドを呼び出します。
アプリケーションが実際に利用するデータは、XML文書の要素に持つデータです。データクラスでは、XML文書を解析してデータを取り出すことができます。
データクラスとXML文書の対応づけは、指定の要素がXML文書にあるかないかで判断します。指定の要素はパス式で表現します。

データクラスとXML文書を対応づけるパスは、Shunsakuアクセスソース生成ウィザードの[データクラスの定義]ページで指定します。