前のトピック: SDK インターフェースによる新しいカスタム アダプタの作成次のトピック: CAFedSearch コンポーネントによる新しいカスタム検索アダプタの設定


新しいカスタム アダプタ Jar ファイルのコンパイル

カスタム アダプタ jar ファイルを正常にコンパイルします。

次の手順に従ってください:

  1. 新しいカスタム検索アダプタをコンパイルします。 Java クラスパスに以下の jar ファイルがあることを確認します。
    jsr311-api-1.0.jar

    この jar ファイルは、以下の CA SDM ディレクトリにあります。

    %NX_ROOT%¥java¥lib¥CXF¥
    
    cafedsearch-core.jar

    このファイルは、以下のディレクトリにあります。

    %NX_ROOT%¥bopcfg¥www¥CATALINA_BASE_FS¥webapps¥cafedsearch¥WEB-INF¥lib
    
    cafedsearch-adapter-sdk-1.0.0.jar

    このファイルは、以下のディレクトリにあります。

    %NX_ROOT%¥bopcfg¥www¥CATALINA_BASE_FS¥webapps¥cafedsearch¥WEB-INF¥lib
    
    log4j-1.2.15.jar (オプション)

    このファイルは、以下のディレクトリにあります。

    %NX_ROOT%¥java¥lib
    
  2. SearchAdapter クラスを拡張し、抽象メソッド用の実装を提供する新しい Java クラスを記述します。
    search
    

    CAFedSearch コンポーネントは、検索メソッド パラメータを呼び出して渡します。 これらのパラメータは、クライアントからの検索リクエストごとに SearchOptions パラメータに組み込まれます。

    注: CAFedSearch コンポーネントは Java クラスの 1 つのインスタンスのみを管理するため、ユーザの実装はスレッド セーフであることを確認してください。 検索操作ごとに、検索メソッドが同じインスタンスで呼び出されます。

  3. 検索メソッド用の SearchOptions パラメータには、以下のメソッドがあります。
    getSearchTerms()

    検索文字列を取得する方法を指定します。

    getStartIndex()

    開始インデックス メソッド(クライアントが項目の検索を開始する番号)を指定します。 インデックスは 1 から開始します。

    getItemsPerPage()

    クライアントが予期する検索結果の最大数を指定します。

    注: 他の Java クラス メソッドを使用することもできます。 例: getUserId()

  4. 検索結果を取得するために、収集された情報を外部検索エンジン API に送信します。

    注: Java クラス メソッドの詳細については、Java のマニュアルを参照してください。

  5. 検索メソッドは、ResultCollection クラスのインスタンスを返します。 ResultCollection のインスタンスを作成し、以下のメソッドを使用して、値を入力します。
    setSources(String name)

    検索アダプタの名前を指定します。 この名前は大文字と小文字が区別されます。また、ユーティリティ設定ファイルで指定されている名前と正確に一致する必要があります。 利便性のために SearchAdapter によって getName() メソッドが提供されるため、このメソッドを使用してください。

    以下に例を示します。

    results.setSources(getName());
    
    setTotalResults (int total)

    検索結果の総数を指定します。

    setStartIndex(int startIndex)

    結果の開始インデックスを指定します。 この値は、検索エンジンからの結果に従います。

    results.setStartIndex(startIndex);
    
  6. setSearchResultItems メソッドを呼び出すことで、ResultItems のコレクションを ResultCollection オブジェクトに渡す必要があります。 ResultItem のインスタンスを一度に追加するには、addSearchResultItem() メソッドを使用します。

    注: ResultCollection Java クラスの詳細については、Java のマニュアルを参照してください。

  7. ResultItem クラスには、以下の重要なメソッドがあり、そのメソッドは、各検索結果項目(行)に対して入力する必要があります。
    setContentText(String txt)

    検索結果の実際のコンテンツを設定するメソッドを指定します。

    setContentHTML(String txt)

    HTML(HTML タグを含めることができる)コンテンツを設定するメソッドを指定します。 検索エンジンが強調表示された HTML を与える場合は、このメソッドを使用して、強調表示されたテキストを設定します。

    注: 検索エンジンにこの機能がない場合は、テキストを強調表示する単純な Java クラス メソッドを記述できます。 CA Open Space アダプタには、検索結果内の検索語を太字にする単純なメソッドを持っています。

    setTitleHTML(String titleHTML)

    HTMLタイトル(HTML タグを含めることができる)を設定するメソッドです。

    setTitleText(String titleText)

    プレーン タイトル(HTML タグを含めることができない)を設定するメソッドです。

    setSource(String source)

    ソース属性を設定するメソッドです。 典型的な呼び出しは item setSource(getName()); になります。

    注: 検索アダプタがさらにほかの jar ファイルを必要とする場合は、build.xml をカスタマイズすることによって、アダプタ jar ファイルをコンパイルして用意します。 Ant バイナリが build.xml を使用するのに必要です。 jar ファイルをコンパイルして作成するには、Ant を使用して build.xml 内のターゲットを実行します。この build.xml は、ソース(src)フォルダとともに保持してください。 build.properties ファイルはオプションです。 Ant バイナリの詳細については、Ant のヘルプを参照してください。

    jar ファイルが正常にコンパイルされました。