スタートガイド

  1. はじめに
  2. インストール
  3. Tomcatサンプルの実行
  4. アプリケーションの開発と実行
  5. 参考資料

1. はじめに

本資料では、次の方にJClass ServerReport 6.2Jの導入方法をご紹介します。
・JClass ServerReport 6.2J製品版をすでにご購入いただき、お手元に納品メールが届いている方
・これからトライアル版を使ってJClass ServerReport 6.2Jの評価を行う方
はじめて製品をご利用いただくことを前提に、インストールからデザイナの利用、Javaアプリケーションでの出力までの手順をご説明します。

なお、必要に応じて、詳しい説明を記述したドキュメントを紹介していますので、あわせてご確認ください。

2. インストール

すでに製品を購入された方は、製品CDからインストールを行ってください。
トライアル版を利用される場合、「トライアル版のインストール」方法に従って、Webサイトからモジュールをダウンロードしてください。

製品CDからのインストール

<cd-rom_root>/jclass/serverviewsディレクトリを開き、ターゲットコンピュータのOSに対応したインストーラを起動してください。

トライアル版のインストール

Webサイトからトライアル版の利用申請を行ってください。

[ダウンロード]-[トライアル版]-[Java]はこちら

グレープシティからトライアル版モジュールのURLを記載したE-mailが届きます。
モジュールをダウンロード後、インストールを行ってください。

3. Tomcatサンプルの実行

JClass ServerReportには、Tomcat上でバーコードを生成するサンプルWebアプリケーションが付属しており、製品の機能を確認できます。以下の手順でTomcatを起動してください。

Windows :
[スタート]-[プログラム]-[JClass ServerViews 6.2J]-[Tomcatの起動]の選択
または、<install_root>/bin/tomcat-startup.exeの実行
UNIX :
<install_root>/bin/tomcat-startup

Tomcatを起動し、以下のURLをブラウザで開いてください。サンプルのトップページが表示されます。
» http://localhost:8686/server-samples/examples/sreport/index.html

4. アプリケーションの開発と実行

ここでは、デザイナで新規にレポートのページテンプレートをデザインするところから始め、サーブレットプログラムの作成、サーバーへのデプロイを行い、WebアプリケーションでJClass ServerReportを出力するまでの手順を学習できます。

4.1 レポートのデザイン

(1)デザイナの外観

JClass ServerReportデザイナは、ページテンプレート、テキストスタイル、ドロースタイル、およびテーブルスタイルのタグオブジェクトをXMLで生成します。テンプレートやスタイルのプロパティは、それぞれのタブをクリックすることで設定できます。

画像「デザイナの外観」拡大

(2)ページテンプレートタイプの選択

JClass ServerReport デザイナでは、SimpleとFullの2種類のページテンプレートタイプを使用できます。

Simple :
シンプルページテンプレートでは、ヘッダー、フッター、ボディフレームなど、基本的なページを簡単に定義できますが、指定できるレイアウトは制限されます。
Full :
フルページテンプレートでは、ページのすべてのレイアウトを指定できます。この書式は、PDFドキュメントに正確に対応しています。

メニューから[ファイル]-[ドキュメントプロパティ]を選択します。このサンプルでは、フレームを使用するためFullを選びます。

画像「ドキュメントプロパティ」

(3)スタイルの変更

ページテンプレートでは、ページの物理サイズや各フレームの位置とサイズなどを指定できます。フレームとは、ページテンプレート内に配置されて、ドキュメントのテキストとイメージを保持するものです。ここでは、フレームの色とサイズを以下のように設定します。

画像「ページテンプレート」拡大

ページテンプレート
スタイル/プロパティ名 設定値
フレーム
102-153-255
フレーム - サイズ
4.0
高さ 2.0
X 0.5
Y 0.5
(4)デザインの保存

デザイナのメニューから[ファイル]-[名前を付けて保存]を選択し、ここまでデザインした内容を保存します。ファイル名はsample.xmlにします。

画像「デザインの保存」拡大

4.2 アプリケーションの実行

(1)サーブレットプログラムの作成

レポートをPDFとして作成し、Web上で表示するプログラムを作成します。以下のサンプルではページテンプレートをXMLファイルから読み込み、コード上でレポートに出力する文字列を設定しています。

import com.klg.jclass.sreport.FontLibrary;
import com.klg.jclass.sreport.JCDocument;
import com.klg.jclass.sreport.JCPageTemplate;
import com.klg.jclass.sreport.JCFlow;
import com.klg.jclass.sreport.JCTextStyle;

import javax.servlet.*;
import javax.servlet.http.*;
import java.util.List;
import java.net.URL;
import java.awt.Font;
import java.io.*;

public class ServerReport_Sample extends HttpServlet {
  public void service(HttpServletRequest request, HttpServletResponse response) {
    try{
      String inFile = "/sample.xml";
      JCDocument document = null;

      // 不必要なフォントをロードしないようにするため、フォントの自動ロードをfalseに設定します。
      FontLibrary.setAutoLoad(false);

      // 日本語フォントのマップ情報を読み込みます。
      ServletContext context = getServletContext();
      URL url1 = context.getResource("/");
      FontLibrary.addFontNameMap(url1, "windows");

      // 日本語TrueTypeフォントを読み込みます。
      FontLibrary.addFont("C:/windows/fonts/msmincho.ttc");
      FontLibrary.addFont("C:/windows/fonts/msgothic.ttc");

      // イメージを出力するための Stream を生成します。
      ServletOutputStream out = response.getOutputStream();

      // XML ファイルで定義されているページテンプレートを読み込みます。
      List template = null;
      try {
        String path = context.getRealPath("/");
        template = JCPageTemplate.loadTemplates(new java.io.File(path + inFile));
      }
      catch (IOException e) {
         e.printStackTrace();
      }

      // PDF 形式でドキュメントを作成します。
      document = new JCDocument(out, template, JCDocument.PDF_PRINTER);

      // ドキュメントのスタイルを設定します。
      JCTextStyle normal = new JCTextStyle("Normal", document);
      normal.setFont(new Font("font1", Font.PLAIN, 14));

      // ドキュメントにフローオブジェクトのインスタンスを作成します。
      JCFlow flow = new JCFlow(document);
      flow.setCurrentTextStyle(normal);

      // ドキュメントにテキストを出力します。
      flow.print("こんにちは。これはサンプルテキストです。");

      // PDF にドキュメントを出力します。
      document.print();

      out.flush();
      out.close();

    }catch(Exception e){
      e.printStackTrace();
    }
  }
}
(2)フォント名マップファイルの作成

PDFとRTFでサポートされている標準のフォント(TimesRoman、Helvetica、Courier)以外のフォントを使用するには、フォント名マップファイルを作成し、JClass ServerReport でそのフォントを使用できるように設定する必要があります。
ここでは、Windows環境用のフォント名マップファイル(windows.properties)を作成します。

font1            = MS-PMincho
font1,Bold       = MS-PMincho,Bold
font1,Italic     = MS-PMincho,Italic
font1,BoldItalic = MS-PMincho,BoldItalic
font2            = MS-PGothic
font2,Bold       = MS-PGothic,Bold
font2,Italic     = MS-PGothic,Italic
font2,BoldItalic = MS-PGothic,BoldItalic
(3)サーブレットのコンパイル

サーブレットプログラムをコンパイルします。上記のソースファイルがあるフォルダに移動し、javacコマンドでコンパイルします。なお、コンパイル時はJClass ServerReportのクラスライブラリ(jcsreport.jar)とサーブレット用のクラスライブラリ(servlet-api.jar)をクラスパスに指定してください。

>javac -classpath C:¥JClassServerViews62J¥lib¥jcsreport.jar;
C:¥Java¥apache-tomcat-6.0.20¥lib¥servlet-api.jar";. ServerReport_Sample.java
(4)web.xmlファイルの作成

次に、サーブレットのURLを指定するためのweb.xmlを用意します。ここでは、Servlet 2.4仕様で記述しています。

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="2.4" xmlns=http://java.sun.com/xml/ns/j2ee
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
  http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
  <servlet>
    <servlet-name>ServerReport_Sample</servlet-name>
    <servlet-class>ServerReport_Sample</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>ServerReport_Sample</servlet-name>
    <url-pattern>/ServerReport_Sample</url-pattern>
  </servlet-mapping>
</web-app>

4.3 Webアプリケーションの配布

作成したJSPファイルをWeb上で実行するためにWebアプリケーションを配布します。構成は次のとおりです。

画像「Webアプリケーションの構成」

アプリケーションのコンテキストルート
Tomcatを使用する場合には、Tomcatのインストールフォルダ下のwebappsフォルダに、新たにServerReport_StartupGuideフォルダを作成します。

WEB-INF/classes/ServerReport_Sample.class
ServerReport_Sample.javaのコンパイル済みファイルを配置します。

WEB-INF/lib/jcsreport.jar
JClass ServerReportのランタイムJARを配置します。

WEB-INF/web.xml
サーブレットのURLを指定するためのweb.xmlを配置します。

sample.xml
デザイナで作成したページテンプレートファイルを配置します。

jcsreport.jarは、製品のインストールルートのlibフォルダからコピーして使用してください。

4.4 アプリケーションの実行

Tomcat起動後、web.xmlで指定したディレクトリにWebブラウザでアクセスします。
» http://localhost:8080/ServerReport_StartupGuide/ServerReport_Sample

以下のようなページが表示されれば、アプリケーションの作成は成功です。

画像「実行画面」拡大

なお、アプリケーションの開発と実行について詳しくは、「導入ガイド」や「プログラマズガイド」をご覧ください。

5. 参考資料

JClass ServerReportには、オンラインヘルプをはじめとするさまざまなドキュメントが付属します。

製品付属のドキュメント

リリースノート

主な特長、新機能、動作環境、既知の不具合、システム要件など
<install_root>/readme.html

JClass導入ガイド

製品のインストールからアプリケーションの開発手順など
<install_root>/docs/getstarted/index.html

プログラマズガイド

デザイナの使い方、Javaアプリケーションの開発方法、プロパティの説明など
<install_root>/docs/sreport/index.html

JClass ServerViews APIリファレンス

JClass ServerViews APIとして提供されるクラスやメソッドの詳細情報
<install_root>/docs/api/index.html

JClass ServerViews タグライブラリリファレンス

JClass ServerViews タグライブラリとして提供されるタグや属性の詳細情報
<install_root>/docs/tlddocs/index.html