Skip to content

Commit

Permalink
modified title and plugin_development.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
t-morita committed Mar 21, 2016
1 parent 45abcf1 commit dc77506
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 20 deletions.
8 changes: 4 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
master_doc = 'index'

# General information about the project.
project = u'mrcube'
project = u'MRCube'
copyright = u'2016, Takeshi Morita'
author = u'Takeshi Morita'

Expand Down Expand Up @@ -232,7 +232,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'mrcube.tex', u'mrcube Documentation',
(master_doc, 'mrcube.tex', u'MRCube Documentation',
u'Takeshi Morita', 'manual'),
]

Expand Down Expand Up @@ -262,7 +262,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'mrcube', u'mrcube Documentation',
(master_doc, 'mrcube', u'MRCube Documentation',
[author], 1)
]

Expand Down Expand Up @@ -297,7 +297,7 @@
# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_title = u'MRCube 1.0 ドキュメント'
epub_author = author
epub_publisher = author
epub_copyright = copyright
Expand Down
24 changes: 8 additions & 16 deletions docs/source/plugin_development.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
=================
プラグイン開発
=================
==============

.. contents:: コンテンツ
:depth: 2

MR\ :sup:`3` \のプラグイン作成に関するクラス(org.semanticweb.mmm.mr3.plugin.MR3Pluginクラス)及びプラグインの作成方法について説明する.また,プラグインのサンプルを示す.

-----------------------------------------------------
MR\ :sup:`3` \Pluginクラス
-----------------------------------------------------
--------------------------
org.semanticweb.mmm.mr3.plugin.MR3Pluginクラス(以下,MR3Pluginクラス)は,abstract public void exec()抽象メソッドをもつ抽象クラスである.MR\ :sup:`3` \のプラグインを作成するには,MR3Pluginクラスを継承して,execメソッドをオーバーライドする.MR3Pluginクラスは,ユーティリティメソッドを提供する.プラグイン作成者は,MR3Pluginクラスが提供するユーティリティメソッドを用いることで,Jenaが提供するcom.hp.hpl.mesa.rdf.jena.model.Modelインタフェース(以下,Model)からMR\ :sup:`3` \のグラフへの変換とMR\ :sup:`3` \のグラフからJenaのModelを得ることが可能となる.以下に,ユーティリティメソッドを示す.(JavaDoc MR3Plugin)

protected JDesktopPane getDesktopPane()
Expand Down Expand Up @@ -47,9 +45,8 @@ protected Model getSelectedPropertyModel()
protected Model getProjectModel()
プロジェクトをJenaのModelに変換する.

-----------------------------------------------------
プラグイン作成方法
-----------------------------------------------------
------------------

1. MR3Pluginクラスのサブクラスを作り,public void exec()メソッドをオーバーライドする.
2. マニフェストファイルに,プラグインクラス名とプラグイン名を以下のように記述し,プラグインクラスとマニフェストファイルをjarファイルでまとめる.(プラグインクラス名とプラグイン名は必須.creator, date, descriptionはオプション.)
Expand All @@ -66,15 +63,13 @@ protected Model getProjectModel()

MR\ :sup:`3` \を起動するとファイル->プラグインにメニューが追加される.メニューを実行すると,プラグインクラスで実装したexecメソッドが実行される.

-----------------------------------------------------
サンプルプラグイン
-----------------------------------------------------
------------------

以下に,MR\ :sup:`3` \のプラグインの実例を示す.ここで示すプラグインは,MR\ :sup:`3` \に含まれている.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
マニフェストファイル
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~

.. code-block:: mf
Expand Down Expand Up @@ -123,9 +118,8 @@ MR\ :sup:`3` \を起動するとファイル->プラグインにメニューが
description: This is owl import plugin.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
サンプルプラグイン1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~

サンプルプラグイン1では,subjectがhttp://mr3.sample.resource,predicateがhttp://mr3.sample.property,objectがSampleであるStatementから,JenaのModelを作成する.MR3PluginクラスのreplaceRDFModeメソッドを用いて,作成したJenaのModelをMR3のRDFグラフへ変換する.以下は,サンプルプラグイン1のソースコードである.

Expand Down Expand Up @@ -166,9 +160,8 @@ MR\ :sup:`3` \を起動するとファイル->プラグインにメニューが
}
}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
サンプルプラグイン2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~

サンプルプラグイン2では,MR\ :sup:`3` \PluginクラスのgetRDFModelメソッドを用いてMR\ :sup:`3` \のRDFグラフからJenaのModelを獲得する.獲得したModelをRDFに変換して内部ウィンドウに出力する.以下は,サンプルプラグイン2のソースコードである.

Expand Down Expand Up @@ -223,9 +216,8 @@ MR\ :sup:`3` \を起動するとファイル->プラグインにメニューが
}
}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
SugiyamaLayoutPlugin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~

SugiyamaLayoutPluginは,JGraphpadに付属するSugiyamaLayoutAlgorithm.javaをMR\ :sup:`3` \用に修正したクラスを利用して作成したプラグインである.SugiyamaLayoutAlgorithmクラスは,performsメソッドをもっている.performsメソッドは,org.jgraph.JGraphを引数にとり,グラフの整形を行う.SugiyamaLayoutPluginでは,MR3PluginクラスのgetRDFGraph,getClassGraph,getPropertyGraphメソッドを利用して,MR\ :sup:`3` \のグラフをJGraphオブジェクトとして受け取り,それをSugiyamaLayoutAlgoritmクラスのperformsメソッドに渡すことで,グラフを整形を行うことができる.以下は,SugiyamaLayoutPluginクラスのソースコードである.

Expand Down

0 comments on commit dc77506

Please sign in to comment.