使用外部資料儲存庫

本節介紹 CsvDataSourceServlet。CsvDataSourceServlet 範例是使用 CSV 檔案做為外部資料儲存庫的實作範例。本節也會提供如何執行及測試 CsvDataSourceServlet 的逐步操作說明。

注意：在開始本節之前，請先完成「開始使用資料來源」一節。

隆重推出 CsvDataSourceServlet

CsvDataSourceServlet 類別位於 examples 套件中。此類別提供將 CSV 檔案用做外部資料儲存庫的範例實作。CsvDataSourceServlet 繼承自 DataSourceServlet、實作 generateDataTable()，且必須在 bq 容器內執行。

下方提供 CsvDataSourceServlet 的程式碼片段。generateDataTable 函式會將資料提供給程式庫。這個函式會建立資料表說明、定義資料表資料欄，並在資料表中填入透過 CSV 檔案取得的資料。系統從要求的視覺化視覺化查詢中指定的網址讀取 CSV 檔案。程式庫會將資料資料表傳回至查詢視覺化所需的所有其他動作。

/**
 * 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 檔案

<data_source_library_install>/examples/src/html 目錄中會提供 csv_example.csv 檔案。其中包含下列值：

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 檔案的來源，就會看到該檔案中包含三個視覺化內容。下列程式碼片段重現這些視覺化規格。

  • 以下這行將指定本節所介紹的 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');

如要進一步瞭解如何指定圖表及使用查詢語言，請參閱「使用圖表工具簡介」和「查詢語言參考資料」。

請按照下列指示操作，或調整下方的操作說明，以視覺化方式呈現 CsvDataSourceServlet 提供的資料：

  1. 將 all_examples.html 檔案從 <data_source_library_install>/examples/src/html 目錄複製到 <tomcat_home>/webapps/myWebApp/ 目錄。
  2. 請點選下列連結：http://localhost:8080/myWebApp/all_examples.html，您應該會看到下列視覺化內容。


「進階資料來源」範例在定義功能與事件流程中討論。

後續步驟

「定義功能與事件流程」一節將說明下一個範例。或者，您也可以瀏覽下列連結：