Getting Start

Getting Start - Yukara Wisdom

このページでは、Yukara Wisdomの簡単な導入方法を紹介します。個々の詳しい設定などは、それぞれのページを参照してください。

このドキュメントは、下記の方を対象としています。

  • Yukara Wisdom を初めて使う方
  • Eclipse で Java の開発を行ったことのある方

このドキュメントの手順通りに進めることで、Yukara Wisdom の基盤システムと、その上で動作する Java サンプルコード検索エンジンが利用可能になります。Java サンプルコード検索エンジンにはあらかじめ The Seasar Project (http://www.seasar.org/) の成果である Java ソースプログラムがいくつか登録されていますので、その中から有用なサンプルコードを利用することができます。

事前準備

Yukara Wisdomを利用するには、下記のソフトウェアがあらかじめインストールされている必要があります。

Wisdom Serverの導入

Yukara Wisdom は、叡智を集約して提供するサーバと、それを利用するクライアントで構成されています。前者のサーバ (Wisdom Server) はTomcat等のJava Application Server上に配備して利用します。

まず、Yukara Downloadページ から Yukara Wisdom Server (All-in-One, x.x.x) をダウンロードし、任意の場所へ解凍します。このパッケージは Wisdom Wisdom が配備された Tomcat 6 と, データベースサーバである H2 Database が同梱してあり、解凍したフォルダの直下にある suite-start.bat または suite-start.sh を実行すると Wisdom Server が起動します。

Wisdom Server についてより詳しくは、Server Settings ページを参照してください。

Wisdom Clientの導入

次に、先ほど導入した Wisdom Server の叡智を利用するためのクライアントプログラム (Wisdom Client) を導入します。現在、Wisdom Client は統合開発環境の Eclipse のプラグインとして公開しています。

まず、Eclipse (3.4以上)を起動し、メニューバーの "Help" から "Software Updates..." メニューを選択します。すると、"Software Updates and Add-ons" というウィンドウが表示されますので、その上部から "Available Software" タブを選択します。

Available Software - Software Updates

次に、ウィンドウの右のほうにある "Add Site..." ボタンを押します。すると、"Add Site" ダイアログが表示されますので、そこに "http://yukara.ashikunep.org/eclipse" と入力し、"OK" ボタンを押します。

"http://yukara.ashikunep.org/eclipse"

成功するとウィンドウに先ほど入力したサイトが追加され、しばらく待つと下図のようにツリーが展開されます。ここから "Yukara Wisdom" というアイテムにチェックを入れ、ウィンドウ右上の "Install..." ボタンを押します。

Install "Yukara Wisdom" feature

続いて、インストールするフィーチャーの確認画面が表示されます。"Yukara Wisdom" と "Yukara Wisdom Source Bundle" が一覧に含まれていることを確認して"Next"ボタンを押します。

Review features

次に、ライセンスの確認画面が表示されます。The Ashikunep Kotan は Apache License, Version 2.0 を採用していますので、問題なければ "Finish" を押してインストールを開始します。

Review license

以上で Wisdom Client の導入は完了です。Wisdom Client は利用する Wisdom Server などの設定が必要になるので、次の "Wisdom Clientの設定" に進んでください。

Wisdom Clientの設定

次に、Wisdom Client の設定を行います。Wisdom Client は Wisdom Server から次のように情報を取得しています。

  1. Wisdom Server に質問を発行する
  2. Wisdom Server に質問の結果を問い合わせる
  3. Wisdom Server から質問の結果を受信できたら、Wisdom Client上に表示する

このため、Wisdom Client には Wisdom Server の位置や、問い合わせ方法などを設定する必要があります。

まず、メニューバーの "Window" (Mac OSX の場合は "Eclipse") メニューから "Preferences" を選択します。すると、"Preferences" ウィンドウが開きますので、ウィンドウ左部の項目から Wisdom Client の設定画面 "Yukara" > "Wisdom" を開きます。

このページには "Server Settings" と "Engine Settings" のグループがありますが、ここでは "Server Settings" のグループを下記のように編集してください。

項目名 設定内容 備考
Server URL http://localhost:8080/wisdom-server-publisher 質問を発行する先のURL
Check Limit Count 10 (規定値) 結果を問い合わせる最大回数
Check Interval(seconds) 1 (規定値) 結果を問い合わせる間隔 (秒単位)

Preferences

編集後、"OK" ボタンを押せば設定は完了です。次はいよいよ Yukara Wisdom を利用して Java サンプルコードを探してみます。

Java サンプルコードの検索

今回のチュートリアルで導入した Yukara Wisdom Server (All-in-One) パッケージには、あらかじめ Java サンプルコード検索エンジンが組み込まれています。このエンジンは「現在書いているソースコードを元に、参考になりそうなサンプルコードを提案する」機能を持っています。より詳しくは、Java サンプルコード検索エンジンのページを参照してください。

まず、このエンジンを利用するにはソースコードを書いている途中でなければならないため、Eclipse のワークスペース上に Java プロジェクトを作成し、適当なクラスを作成します。ここでは、下記のような簡単な com.example.Hello クラスを作成してみます。

com/example/Hello.java

package com.example;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

public class Hello {

    public static void main(String...args) {
        DateFormat format =
            SimpleDateFormat.getInstance();
        Date parsed = format.parse(args[0]);
        /* CARET HERE */
    }
}

上記の "/* CARET HERE */" の部分にキャレットを合わせた状態で、メニューバーの "Yukara" から "Wisdom" を選択します。すると、下記のようなダイアログが表示されますので "Title" に "Hello, wisdom!" と入力して "OK" ボタンを押します。

Wisdom input dialog

すると、Suggestions ビューが表示され、そこに "Hello, wisdom!" という名前のセクションが表示されます。ここには灰色のアイコンが2つ表示され、1つは先ほどダイアログに入力した "Hello, wisdom!" という文字列をオウム返しするエンジン (Echo)、もう1つが Java サンプルコード検索エンジン (Java Sample Code...)の質問結果を表しています。ただし、アイコンが灰色のうちは Wisdom Server の返事を待っている状態なので、結果を利用することはできません。

Suggestions (pending)

しばらく待つと、先ほどのアイコンに色が付きます。色がついたアイコンはクリックすることで質問の結果が展開され、その中から利用したい叡智を選択することができます。

Suggestions (available)

ここで、表示されたリンクをクリックすることで、質問結果の詳細情報を表示できます。Java サンプルコード検索エンジンの結果をクリックすれば、サンプルとなりそうな Java のソースコードと、その詳しい情報を確認することができます。

Suggestion detail (s2-framework)

以上で、Yukara Wisdom の簡単な使い方についての紹介は終了です。より詳しくは、個々のページを参照してください。