外部データストアを使用する

このセクションでは、CsvDataSourceServlet について説明します。CsvDataSourceServlet は、CSV ファイルを外部データストアとして使用する実装例です。このセクションでは、CsvDataSourceServlet の実行とテストの詳しい手順についても説明します。

注: このセクションを開始する前に、データソースを使ってみるセクションを完了する必要があります。

CsvDataSourceServlet のご紹介

CsvDataSourceServlet クラスは examples パッケージにあります。このクラスは、CSV ファイルを外部データストアとして使用する実装例を提供します。CsvDataSourceServlet は DataSourceServlet を継承し、generateDataTable() を実装し、サーブレット コンテナ内で実行する必要があります。

CsvDataSourceServlet のスニペットを以下に示します。generateDataTable 関数は、データをライブラリに公開します。この関数は、データテーブルの説明を作成し、データテーブルの列を定義して、CSV ファイルから取得したデータをデータテーブルに入力します。CSV ファイルは、リクエストする可視化のクエリで指定された URL から読み取られます。ライブラリは、データテーブルをクエリのビジュアリゼーションに戻すために必要な他のすべてのアクションを処理します。

/**
 * A demo servlet for serving a simple, constant data table.
 * This servlet extends DataSourceServlet, but does not override the default
 * empty implementation of method getCapabilities(). This servlet therefore ignores the
 * user query (as passed in the 'tq' url parameter), leaving the
 * query engine to apply it to the data table created here.
 *
 * @author Nimrod T.
 */
public class CsvDataSourceServlet extends DataSourceServlet {

  /**
   * Log.
   */
  private static final Log log = LogFactory.getLog(CsvDataSourceServlet.class.getName());

  /**
   * The name of the parameter that contains the url of the CSV to load.
   */
  private static final String URL_PARAM_NAME = "url";

  /**
   * Generates the data table.
   * This servlet assumes a special parameter that contains the CSV URL from which to load
   * the data.
   */
  @Override
  public DataTable generateDataTable(Query query, HttpServletRequest request)
      throws DataSourceException {
    String url = request.getParameter(URL_PARAM_NAME);
    if (StringUtils.isEmpty(url)) {
      log.error("url parameter not provided.");
      throw new DataSourceException(ReasonType.INVALID_REQUEST, "url parameter not provided");
    }

    Reader reader;
    try {
      reader = new BufferedReader(new InputStreamReader(new URL(url).openStream()));
    } catch (MalformedURLException e) {
      log.error("url is malformed: " + url);
      throw new DataSourceException(ReasonType.INVALID_REQUEST, "url is malformed: " + url);
    } catch (IOException e) {
      log.error("Couldn't read from url: " + url, e);
      throw new DataSourceException(ReasonType.INVALID_REQUEST, "Couldn't read from url: " + url);
    }
    DataTable dataTable = null;
    ULocale requestLocale = DataSourceHelper.getLocaleFromRequest(request);
    try {
      // Note: We assume that all the columns in the CSV file are text columns. In cases where the
      // column types are known in advance, this behavior can be overridden by passing a list of
      // ColumnDescription objects specifying the column types. See CsvDataSourceHelper.read() for
      // more details.
      dataTable = CsvDataSourceHelper.read(reader, null, true, requestLocale);
    } catch (IOException e) {
      log.error("Couldn't read from url: " + url, e);
      throw new DataSourceException(ReasonType.INVALID_REQUEST, "Couldn't read from url: " + url);
    }
    return dataTable;
  }
}

CsvDataSourceServlet の実行とテスト

このセクションでは、CsvDataSourceServlet の実行とテストの方法を説明します。

CsvDataSourceServlet を実行してテストするには、次のセクションで説明するように、CSV ファイルを作成してウェブ アプリケーションを更新し、データソースをクエリする可視化を設定します。

CSV ファイルの作成

ファイル csv_example.csv は、<data_source_library_install>/examples/src/html ディレクトリにあります。次の値が含まれます。

Employee,Manager
Roger,John
Robert,John
Jane,Roger
Jack,Jane
Bob,Jane

このファイルをスタートガイドで作成した <tomcat_home>/webapps/myWebApp ディレクトリにコピーします。

Apache Tomcat でのウェブ アプリケーションの更新

以下の手順に沿って、Apache Tomcat 上のウェブ アプリケーションを更新します。次の手順は、Windows システム上の Apache Tomcat に固有のものです。

  1. 以前に WEB-INF ディレクトリにコピーした web.xml ファイルには、この例に必要な定義とマッピングがすでに含まれています。これを定義する行は次のとおりです。
    <servlet>
  <servlet-name>CSV Example</servlet-name>
  <description>
  CsvDataSourceServlet
  </description>
  <servlet-class>CsvDataSourceServlet</servlet-class>
</servlet>

<servlet-mapping>
  <servlet-name>CSV Example</servlet-name>
  <url-pattern>/csv</url-pattern>
</servlet-mapping>
  2. Tomcat を開始するか、Tomcat がすでに実行されている場合は再起動します。
     
  3. 次のリンクをクリックします。 http://localhost:8080/myWebApp/csv?url=http://localhost:8080/myWebApp/csv_example.csv

    画面には、画面の幅に応じて 6 ～ 7 行のテキストが表示されます。
    テキストは google.visualization.Query.setResponse
    で始まり、{c:[{v:'Bob'},{v:'Jane'}]}]}}); で終わります。

    これは、サンプルの CSV データソースが可視化に送信するレスポンスです。

ビジュアル表示を使用してデータを表示する

<data_source_library_install>/examples/src/html ディレクトリにある all_examples.html ファイルを使用すると、データの可視化を表示できます。

all_examples.html ファイルのソースを表示すると、このファイルにビジュアリゼーションが 3 つ含まれていることがわかります。次のスニペットは、これらのビジュアリゼーションの仕様を再現します。

  • 次の行は、このセクションで説明する csv の例を示しています。
    query = new google.visualization.Query('csv?url=http://localhost:8080/myWebApp/csv_example.csv');
    次の行は、組織図の可視化を指定します。 
    var chart = new google.visualization.OrgChart(document.getElementById('csv_div'));
  • 次の行では、スタートガイド セクションで説明している simpleexample を指定しています。
    var query = new google.visualization.Query('simpleexample?tq=select name,population');
    次の行は、円グラフの視覚化を指定します。 
    var chart = new google.visualization.PieChart(document.getElementById('simple_div'));
  • 次の行は、機能の定義とイベント フローのセクションで説明している advanced の例を示しています。
    query = new google.visualization.Query('advanced?tableId=planets&tq=select planet,mass');
    次の行は、棒グラフのビジュアリゼーションを示しています。 
    var chart = new google.visualization.BarChart(document.getElementById('advanced_div'));

グラフを指定し、クエリ言語を使用する方法については、グラフツールの使用の概要とクエリ言語リファレンスをご覧ください。

CsvDataSourceServlet で提供されるデータの可視化を表示するには、以下の手順を行います。

  1. all_examples.html ファイルを <data_source_library_install>/examples/src/html ディレクトリから <tomcat_home>/webapps/myWebApp/ ディレクトリにコピーします。
  2. リンク http://localhost:8080/myWebApp/all_examples.html をクリックすると、次のような表示になります。


高度なデータソースの例は、機能とフローを定義するで説明されています。

次のステップ

次の例は、機能とイベントフローの定義で説明しています。または、次のリンクをご覧ください。