svnno****@sourc*****
svnno****@sourc*****
2009年 4月 1日 (水) 22:13:53 JST
Revision: 3053
http://svn.sourceforge.jp/view?root=jiemamy&view=rev&rev=3053
Author: daisuke_m
Date: 2009-04-01 22:13:53 +0900 (Wed, 01 Apr 2009)
Log Message:
-----------
ドキュメント記述
Modified Paths:
--------------
metis/trunk/src/docbook/userguide/editor-quickstart.xml
metis/trunk/src/test/java/org/jiemamy/documents/JiemamyTest.java
Added Paths:
-----------
metis/trunk/src/images/basic_delete.png
metis/trunk/src/images/basic_handle_01.png
metis/trunk/src/images/basic_handle_02.png
metis/trunk/src/images/contextMenu.png
metis/trunk/src/images/databaseImporter_01.png
metis/trunk/src/images/databaseImporter_02.png
metis/trunk/src/images/databaseImporter_03.png
metis/trunk/src/images/databaseImporter_04.png
metis/trunk/src/images/diagram_01.png
metis/trunk/src/images/diagram_02.png
metis/trunk/src/images/diagram_03.png
metis/trunk/src/images/foreignKeyEdit_01.png
metis/trunk/src/images/palette.png
metis/trunk/src/images/sqlExporter_01.png
metis/trunk/src/images/tableEdit_01.png
-------------- next part --------------
Modified: metis/trunk/src/docbook/userguide/editor-quickstart.xml
===================================================================
--- metis/trunk/src/docbook/userguide/editor-quickstart.xml 2009-04-01 09:46:43 UTC (rev 3052)
+++ metis/trunk/src/docbook/userguide/editor-quickstart.xml 2009-04-01 13:13:53 UTC (rev 3053)
@@ -16,7 +16,7 @@
</copyright>
<abstract>
<title>概要</title>
- <para>Jiemamy Eclipse Model Editorの基礎的な使用方法を、実例に沿いながら説明します。</para>
+ <para>Jiemamy Eclipse Model Editorの基礎的な使用方法を説明し、実例に沿いながら操作をしてみます。</para>
</abstract>
<productname>Jiemamy Eclipse Model Editor</productname>
<releaseinfo>version 0.2.0</releaseinfo>
@@ -74,28 +74,142 @@
</figure>
</sect1>
</chapter>
+
+ <chapter id="diagram">
+ <title>ダイアグラム</title>
+ <sect1>
+ <title>エンティティ</title>
+ <para>テーブルとビューをあわせて、エンティティと呼びます。エンティティはダイアグラム上で矩形のノードとしてあらわされます。
+エンティティ名の左側に T のマークがあるものがテーブル、V のマークがあるものがビューを表します。デフォルトの色は下図の通りです。
+ </para>
+ <note>
+ <para>ノードの色は変更できますので、色でエンティティの種類を確実に判断することはできません。</para>
+ </note>
+ <figure>
+ <title>エンティティノード</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/diagram_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <para>矩形の最上段がエンティティ種別マークとエンティティ名、罫線を挟んでその下側がカラム名とデータ型のリストになります。</para>
+ <note>
+ <para>現行のバージョンでは、ビューのカラムは表示されません。</para>
+ </note>
+ <para>テーブルにおいて、主キーに設定されたカラムは、そのカラム名とデータ型にアンダーラインがつきます。</para>
+ </sect1>
+ <sect1>
+ <title>リレーション</title>
+ <para>外部キーの関係は、ダイアグラム上でコネクションとしてあらわされます。制約を受けるテーブルから参照されるテーブルに向けての
+矢印がリレーションです。
+ </para>
+ <figure>
+ <title>リレーション</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/diagram_02.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <para>コネクションの上にはラベルが表示され、1行目が外部キー名（無名の場合は表示されません）、2行目以降が「制約を受けるカラムの名前 ->
+参照されるカラムの名前」のフォーマットで対応関係が表示されます。
+ </para>
+ </sect1>
+ <sect1>
+ <title>メモ</title>
+ <para>ダイアグラム上にメモを記述することができます。メモは下図のように角丸矩形のノードで表示されます。</para>
+ <figure>
+ <title>メモ</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/diagram_03.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ </sect1>
+ <!--
+ <sect1>
+ <title>メモ・コネクション</title>
+ <para>メモと、その他のノードを接続する説明用のコネクションは、(TODO)</para>
+ </sect1>
+ -->
+ </chapter>
<chapter id="edit-table">
<title>基本操作1 テーブル</title>
+ <para>この章では、テーブルの操作を解説します。</para>
<sect1>
<title>テーブルの追加と削除</title>
- <para>(TODO)</para>
+ <procedure>
+ <step><para>テーブルの追加は、まずパレットの「エンティティ」カテゴリから「テーブル」を選択します。</para></step>
+ <step><para>その状態で、ダイアグラム上をクリックします。</para></step>
+ </procedure>
+ <para>以上で、ダイアグラム上にテーブルが1つ作成されます。</para>
+ <tip>
+ <para>ダイアグラムをクリックした場合、デフォルトサイズ（必要に応じてサイズが自動調整される）のノードが作成されます。
+ダイアグラムをドラッグした場合は、ドラッグしたサイズでテーブルが生成されます。この場合、手動でサイズ調整しない限り、カラムが隠れてしまう場合があります。
+ </para>
+ </tip>
+ <figure>
+ <title>パレット</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <para>テーブルの削除は、削除したいテーブルを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。
+メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。
+ </para>
+ <tip>
+ <para>複数のノードを同時に選択し、全てを同時に削除することも可能です。</para>
+ </tip>
+ <figure>
+ <title>コンテキストメニュー</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
</sect1>
<sect1>
<title>テーブルの移動</title>
- <para>(TODO)</para>
+ <para>ノードをドラッグ＆ドロップすることにより、位置を移動することができます。また、ノードを選択した時、縁に8カ所配置されているハンドルを
+ドラッグすることにより、ノードのサイズを変更することができます。
+ </para>
+ <figure>
+ <title>ノードのハンドル</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/basic_handle_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <tip>
+ <para>手動でノードのサイズを変更した場合は、カラム数に応じてサイズが自動調整されなくなります。一度手動調整したノードを自動調整に戻すには、
+コンテキストメニューから「サイズ調整(Z)」＞「サイズを自動調整(S)」を選択します。
+ </para>
+ </tip>
</sect1>
<sect1>
<title>テーブルの編集</title>
- <para>(TODO)</para>
+ <para>テーブルをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、テーブル編集ダイアログが開きます。</para>
+ <para>このダイアログでは、テーブルに関する全ての情報を編集することができます。最上段の「テーブル名(N)」欄で、テーブル名を指定します。</para>
+ <figure>
+ <title>テーブル編集ダイアログ</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/tableEdit_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
</sect1>
<sect1>
<title>カラムの追加と削除</title>
- <para>(TODO)</para>
+ <para>テーブル編集ダイアログの「カラム(C)」タブで「追加(A)」をクリックすると、最下段にカラムを追加することができます。
+また、上部のリストでカラムを選択し、「挿入(I)」をクリックすると、選択している位置（選択したカラムの1つ上）にカラムを挿入することができます。
+ </para>
+ <para>上部のリストでカラムを選択し、「削除(R)」をクリックすると、選択したカラムを削除することができます。</para>
</sect1>
<sect1>
<title>カラムの編集</title>
- <para>(TODO)</para>
+ <para>上部のリストで選択したカラムは、下部の「カラム情報」で編集を行う事ができます。以下に、代表的な項目を説明します。</para>
+ <itemizedlist>
+ <listitem><para>「カラム名(M)」 -- カラム名を設定します。</para></listitem>
+ <listitem><para>「データ型(T)」 -- カラムのデータ型を設定します。設定したデータベースにより、選択肢が変化します。</para></listitem>
+ <listitem><para>データ型オプション -- データ型によって、右側に「サイズ」等の追加のコントロールが表示される場合があります。</para></listitem>
+ <listitem><para>「主キー(P)」 -- このカラムを主キーカラムとする場合にチェックします。</para></listitem>
+ <listitem><para>「NOT NULL(N)」 -- このカラムにNOT NULL制約を付加する場合にチェックします。</para></listitem>
+ </itemizedlist>
+ <para>編集が終わり、変更を適用する場合はOKを、適用しない場合はCancelをクリックし、ダイアログを終了します。</para>
</sect1>
</chapter>
@@ -103,25 +217,145 @@
<title>基本操作2 外部キー</title>
<sect1>
<title>外部キーの追加と削除</title>
- <para>(TODO)</para>
+ <procedure>
+ <step><para>外部キーの追加は、まずパレットの「エンティティ」カテゴリから「外部キー」を選択します。</para></step>
+ <step><para>その状態で、まず制約を受けるテーブルをクリックします。</para></step>
+ <step><para>続いて、参照されるテーブルをクリックします。</para></step>
+ </procedure>
+ <para>以上で、ダイアグラム上に外部キーが1つ作成されます。</para>
+ <tip>
+ <para>外部キーは、自分自身のテーブルを参照することも可能です。2回続けて同じテーブルをクリックすることにより、このような外部キーも
+作成することができます。
+ </para>
+ </tip>
+ <figure>
+ <title>パレット</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <para>外部キーの削除は、削除したい外部キーを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。
+メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。
+ </para>
+ <tip>
+ <para>複数のコネクションを同時に選択し、全てを同時に削除することも可能です。</para>
+ </tip>
+ <figure>
+ <title>コンテキストメニュー</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
</sect1>
<sect1>
<title>外部キーの編集</title>
- <para>(TODO)</para>
+ <para>外部キーをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、外部キー編集ダイアログが開きます。</para>
+ <para>このダイアログでは、外部キーに関する全ての情報を編集することができます。最下段の「マッピング」、参照元カラムと参照先カラムの
+対応関係（マッピング）を設定します。
+ </para>
+ <figure>
+ <title>外部キー編集ダイアログ</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/foreignKeyEdit_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
</sect1>
<sect1>
<title>ベンドポイント</title>
- <para>(TODO)</para>
+ <para>コネクションを選択した時に現れるハンドル（図中の青で示したハンドル）をドラッグすることにより、ベンドポイントを作成することができます。
+また、既に作成したベンドポイントのハンドル（図中の赤で示したハンドル）をドラッグすることにより、ベンドポイントの移動ができます。
+さらに、ベンドポイントのハンドルを、その左右のベンドポイントの延長線上に配置することにより、ベンドポイントの削除ができます。
+ </para>
+ <figure>
+ <title>コネクションのハンドル</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/basic_handle_02.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
</sect1>
</chapter>
- <chapter id="import">
- <title>インポート</title>
- <para>(TODO)</para>
+ <chapter id="compose">
+ <title>インポートとエクスポート</title>
+ <sect1>
+ <title>データベース・インポート</title>
+ <para>既存のデータベースからJiemamyに、スキーマをインポートすることができます。</para>
+ <procedure>
+ <step>
+ <para>右クリックで表示されるコンテキストメニューから「インポート(I)」＞「Database Importer」を選択します。</para>
+ <figure>
+ <title>Database Importerの選択</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/databaseImporter_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ </step>
+ <step>
+ <para>ポップアップしたウィザードで、まず「データベース種別(D)」にてインポート元のDBの種類（SQL方言）を設定します。</para>
+ <figure>
+ <title>DBインポートウィザード</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/databaseImporter_02.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ </step>
+ <step>
+ <para>「追加(A)」ボタンをクリックし、JDBCドライバを含むjarファイルを選択します。ドライバの動作にあたって複数のjarが必要な場合は、
+このステップを繰り返します。
+ </para>
+ </step>
+ <step>
+ <para>ドライバjarに含まれるDriverクラスが「JDBCドライバクラス(C)」に表示されるので、適切なドライバクラスを選択します。</para>
+ </step>
+ <step>
+ <para>「接続URI(I)」に、データベース接続URIを設定します。</para>
+ </step>
+ <step>
+ <para>「接続ユーザ名(U)」と「接続パスワード(P)」に、接続アカウントを設定します。</para>
+ </step>
+ <step>
+ <para>「スキーマ名(S)」とにスキーマ名を設定します。空欄でも構いません。</para>
+ </step>
+ <step>
+ <para>以上を設定の上、「接続テスト(T)」ボタンをクリックし、結果のダイアログを確認します。</para>
+ <figure>
+ <title>接続に成功した場合</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/databaseImporter_03.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <figure>
+ <title>接続に失敗した場合の一例（この例は、PostgreSQLで、パスワードが異なる場合）</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/databaseImporter_04.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ </step>
+ <step>
+ <para>接続できることを確認したら、Finishボタンをクリックします。</para>
+ </step>
+ <step>
+ <para>インポートにはしばらく時間がかかる可能性があります。完了し次第、完了した旨のダイアログが表示されます。</para>
+ </step>
+ </procedure>
+ </sect1>
+ <sect1>
+ <title>SQL・エクスポート</title>
+ <para>Jiemamyで作成したモデルは、SQLとしてエクスポートすることができます。</para>
+ <para>右クリックで表示されるコンテキストメニューから「エクスポート(E)」＞「SQL Exporter」を選択します。</para>
+ <figure>
+ <title>SQL Exporterの選択</title>
+ <screenshot>
+ <mediaobject><imageobject><imagedata fileref="images/sqlExporter_01.png"></imagedata></imageobject></mediaobject>
+ </screenshot>
+ </figure>
+ <para>(TODO)</para>
+ </sect1>
</chapter>
- <chapter id="export">
- <title>エクスポート</title>
+ <chapter id="caseStudy">
+ <title>ケース・スタディ</title>
+ <para>ここでは、Jiemamyでダイアグラムを作成し、SQLにエクスポートするまでを、順を追って説明します。</para>
<para>(TODO)</para>
</chapter>
Added: metis/trunk/src/images/basic_delete.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/basic_delete.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/basic_handle_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/basic_handle_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/basic_handle_02.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/basic_handle_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/contextMenu.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/contextMenu.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/databaseImporter_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/databaseImporter_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/databaseImporter_02.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/databaseImporter_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/databaseImporter_03.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/databaseImporter_03.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/databaseImporter_04.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/databaseImporter_04.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/diagram_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/diagram_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/diagram_02.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/diagram_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/diagram_03.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/diagram_03.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/foreignKeyEdit_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/foreignKeyEdit_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/palette.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/palette.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/sqlExporter_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/sqlExporter_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: metis/trunk/src/images/tableEdit_01.png
===================================================================
(Binary files differ)
Property changes on: metis/trunk/src/images/tableEdit_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: metis/trunk/src/test/java/org/jiemamy/documents/JiemamyTest.java
===================================================================
--- metis/trunk/src/test/java/org/jiemamy/documents/JiemamyTest.java 2009-04-01 09:46:43 UTC (rev 3052)
+++ metis/trunk/src/test/java/org/jiemamy/documents/JiemamyTest.java 2009-04-01 13:13:53 UTC (rev 3053)
@@ -7,8 +7,6 @@
import java.io.FileInputStream;
import java.io.FileOutputStream;
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.FilenameUtils;
import org.jiemamy.Jiemamy;
import org.jiemamy.JiemamyFactory;
import org.jiemamy.composer.exporter.DefaultSqlExportConfig;