com.change_vision.jude.api.inf.project
インタフェース ProjectAccessor

com.change_vision.jude.api.inf.project.ProjectAccessor

public ProjectAccessor

astah*プロジェクトを操作するインターフェース。

メソッドの概要

abstract void	addEntityEditListener(EntityEditListener listener) モデル編集リスナーを追加します。
abstract void	addProjectEventListener(ProjectEventListener listener) プロジェクトイベントリスナーを追加します。
abstract void	close() astah*プロジェクトを閉じます。
abstract void	create(String projectPath, boolean useDefinedTaggedValues) astah*プロジェクトを作成します。
abstract void	create(String projectPath) astah*プロジェクトを作成します。
abstract void	create() astah*プロジェクトを作成します。
abstract void	create(String projectPath, String templatePath, boolean useDefinedTaggedValues) astah*プロジェクトを作成します。
abstract void	create(String projectPath, String templatePath) astah*プロジェクトを作成します。
abstract INamedElement[]	findElements(Class elementKind, String name) 要素の種類と名前で要素を検索します。
abstract INamedElement[]	findElements(Class elementKind) 要素の種類で要素を検索します。
abstract INamedElement[]	findElements(ModelFinder picker) ModelFinderで要素を検索します。
abstract int	getAstahAPIModelVersion() astah*APIがモデルを保存する場合のモデルバージョンを取得します。
abstract String	getAstahAPIVersion() astah*APIのバージョンを取得します。
abstract String	getAstahEdition() astah*本体のエディションを取得します。
abstract String	getAstahInstallPath() インストールされたastah*の場所を取得します。
abstract int	getAstahModelVersion() astah*本体がモデルを保存する場合のモデルバージョンを取得します。
abstract String	getAstahVersion() astah*本体のバージョンを取得します。
abstract IModel	getCurrentProject() 推奨されていません。 getProject()を使うこと。将来のバージョンでこのAPIは削除する。
abstract IDiagramEditorFactory	getDiagramEditorFactory() DiagramEditorを作成するオブジェクトを返します。
abstract IEntity	getEntity(String id) 指定IDを持つIEntityを返します。
abstract IModelEditorFactory	getModelEditorFactory() ModelEditorを作成するオブジェクトを返します。
abstract IModel	getProject() プロジェクトの起点となるモデルを取得します。
abstract int	getProjectModelVersion() 現在開いているastah*プロジェクトのモデルバージョンを取得します。
abstract String	getProjectPath() 現在開いているastah*プロジェクトの保存場所を取得します。
abstract ITransactionManager	getTransactionManager() トランザクションを管理するオブジェクトを返します。
abstract IViewManager	getViewManager() ビューを管理するオブジェクトを返します。
abstract boolean	hasProject() プロジェクトが開かれているかどうかを取得します。
abstract boolean	hasSameElement(String name) プロジェクト中に同名Elementがあるかを返します。
abstract boolean	hasSameElement(String name, Class clazz) プロジェクト中に同名かつ同じ型のElementがあるかを返します。
abstract boolean	isProjectModified() 現在開いているプロジェクトが編集状態かを返します。
abstract void	open(String projectName) astah*プロジェクトを開きます。
abstract void	open(String projectName, boolean isIgnoreModelVersion) astah*プロジェクトを開きます。
abstract void	open(String projectName, boolean isIgnoreModelVersion, boolean lockMode, boolean allowReadOnly) astah*プロジェクトを開きます。
abstract void	open(InputStream in) astah*プロジェクトを開きます。
abstract void	open(InputStream in, boolean isIgnoreModelVersion) astah*プロジェクトを開きます。
abstract void	removeEntityEditListener(EntityEditListener listener) モデル編集リスナーを削除します。
abstract void	removeProjectEventListener(ProjectEventListener listener) プロジェクトイベントリスナーを削除します。
abstract void	save() astah*プロジェクトを保存します。
abstract void	saveAs(String projectName) astah*プロジェクトを指定名で保存します。
abstract void	validateProject() astah*プロジェクトの不正モデルを確認します。

メソッドの詳細

open

abstract void open(String projectName)

astah*プロジェクトを開きます。

パラメータ:

projectName - プロジェクト名

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

NonCompatibleException - モデルバージョンが古い（プロジェクトを最後に編集したastah*よりもAPIのバージョンが古い）です。または、他製品のモデルを開こうとしています。

ClassNotFoundException - 読み込めないモデルがあります

IOException - 入出力エラーです

ProjectLockedException - プロジェクトファイルがロックされています

open

abstract void open(String projectName,
                   boolean isIgnoreModelVersion)

astah*プロジェクトを開きます。

パラメータ:

projectName - プロジェクト名

isIgnoreModelVersion - モデルバージョンチェックの有無を指定します

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

NonCompatibleException - モデルバージョンが古い（プロジェクトを最後に編集したastah*よりもAPIのバージョンが古い）です。または、他製品のモデルを開こうとしています。

ClassNotFoundException - 読み込めないモデルがあります

IOException - 入出力エラーです

ProjectLockedException - プロジェクトファイルがロックされています

open

abstract void open(String projectName,
                   boolean isIgnoreModelVersion,
                   boolean lockMode,
                   boolean allowReadOnly)

astah*プロジェクトを開きます。

パラメータ:

projectName - プロジェクト名

isIgnoreModelVersion - モデルバージョンチェックの有無を指定します

lockMode - ロックモード trueの場合、プロジェクトファイルをロックします

allowReadOnly - trueの場合、プロジェクトファイルがロックされている場合、読込み専用モードで開きます

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

NonCompatibleException - モデルバージョンが古い（プロジェクトを最後に編集したastah*よりもAPIのバージョンが古い）です。または、他製品のモデルを開こうとしています。

ClassNotFoundException - 読み込めないモデルがあります

IOException - 入出力エラーです

ProjectLockedException - プロジェクトファイルがロックされています

saveAs

abstract void saveAs(String projectName)

astah*プロジェクトを指定名で保存します。

パラメータ:

fileName - ファイル名

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

IOException - 入出力エラーです

ProjectLockedException - プロジェクトファイルがロックされています

open

abstract void open(InputStream in)

astah*プロジェクトを開きます。

パラメータ:

in - 入力ストリーム

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

NonCompatibleException - モデルバージョンが古い（プロジェクトを最後に編集したastah*よりもAPIのバージョンが古い）です

ClassNotFoundException - 読み込めないモデルがあります

IOException - 入出力エラーです

ProjectLockedException - プロジェクトファイルがロックされています

open

abstract void open(InputStream in,
                   boolean isIgnoreModelVersion)

astah*プロジェクトを開きます。

パラメータ:

in - 入力ストリーム

isIgnoreModelVersion - モデルバージョンチェックの有無を指定します

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

NonCompatibleException - モデルバージョンが古い（プロジェクトを最後に編集したastah*よりもAPIのバージョンが古い）です

ClassNotFoundException - 読み込めないモデルがあります

IOException - 入出力エラーです

getProject

abstract IModel getProject()

プロジェクトの起点となるモデルを取得します。

戻り値:

モデル

hasProject

abstract boolean hasProject()

プロジェクトが開かれているかどうかを取得します。

戻り値:

プロジェクトが開かれていればtrue。

getCurrentProject

abstract IModel getCurrentProject()

推奨されていません。 getProject()を使うこと。将来のバージョンでこのAPIは削除する。

プロジェクトの起点となるモデルを取得します。

戻り値:

モデル

close

abstract void close()

astah*プロジェクトを閉じます。 Close astah* Project.

create

abstract void create(String projectPath,
                     boolean useDefinedTaggedValues)

astah*プロジェクトを作成します。

パラメータ:

projectPath - プロジェクトのパス(ファイル名も含む)

useDefinedTaggedValues - ユーザー定義タグ付き値の読み込みの指定

例外:

IOException - 入出力エラーです

create

abstract void create(String projectPath)

astah*プロジェクトを作成します。(ユーザー定義タグ付き値は読み込みません。)

パラメータ:

projectPath - プロジェクトのパス(ファイル名も含む)

例外:

IOException - 入出力エラーです

create

abstract void create()

astah*プロジェクトを作成します。(プロジェクトのパスは指定ません,saveAs()する時、 プロジェクトのパスを指定しなければならない。　ユーザー定義タグ付き値は読み込みません。)

例外:

IOException - 入出力エラーです

save

abstract void save()

astah*プロジェクトを保存します。

例外:

LicenseNotFoundException - ライセンスが見つかりません

ProjectNotFoundException - プロジェクトが見つかりません

IOException - 入出力エラーです

ProjectLockedException - プロジェクトがロックされています

validateProject

abstract void validateProject()

astah*プロジェクトの不正モデルを確認します。

例外:

ProjectNotFoundException - プロジェクトが存在しません

InvalidEditingException - 不正なモデルが存在します

getTransactionManager

abstract ITransactionManager getTransactionManager()

トランザクションを管理するオブジェクトを返します。

戻り値:

トランザクションを管理するオブジェクト

getModelEditorFactory

abstract IModelEditorFactory getModelEditorFactory()

ModelEditorを作成するオブジェクトを返します。

戻り値:

ModelEditorを作成するオブジェクト

getDiagramEditorFactory

abstract IDiagramEditorFactory getDiagramEditorFactory()

DiagramEditorを作成するオブジェクトを返します。

戻り値:

DiagramEditorを作成するオブジェクト

findElements

abstract INamedElement[] findElements(Class elementKind,
                                      String name)

要素の種類と名前で要素を検索します。 ITopicPresentationなどのプレゼンテーションは検索対象となりません。

パラメータ:

elementKind - 要素の種類。APIのクラス名で要素の種類を表します。例：クラスの場合、IClassを指定します。

name - 要素の名前。名前をnullまたは""で指定した場合、要素の種類で検索します。

戻り値:

INamedElement[] 取得される要素は順不同です。

例外:

ProjectNotFoundException - プロジェクトが存在しません

findElements

abstract INamedElement[] findElements(Class elementKind)

要素の種類で要素を検索します。 ITopicPresentationなどのプレゼンテーションは検索対象となりません。

パラメータ:

elementKind - 要素の種類。APIのクラス名で要素の種類を表します。例：クラスの場合、IClassを指定します。

戻り値:

INamedElement[] 取得される要素は順不同です。

例外:

ProjectNotFoundException - プロジェクトが存在しません

findElements

abstract INamedElement[] findElements(ModelFinder picker)

ModelFinderで要素を検索します。 ITopicPresentationなどのプレゼンテーションは検索対象となりません。

パラメータ:

ModelFinder - 要素の検索条件が実装されるクラス。自分の検索条件を実装する必要があります。

戻り値:

INamedElement[] 取得される要素は順不同です。

例外:

ProjectNotFoundException - プロジェクトが存在しません

create

abstract void create(String projectPath,
                     String templatePath,
                     boolean useDefinedTaggedValues)

astah*プロジェクトを作成します。

パラメータ:

projectPath - プロジェクトのパス(ファイル名も含む)

templatePath - テンプレートのパス(ファイル名も含む)

useDefinedTaggedValues - ユーザー定義タグ付き値の読み込みの指定

例外:

IOException - 入出力エラーです

ProjectNotFoundException - プロジェクトが見つかりません

create

abstract void create(String projectPath,
                     String templatePath)

astah*プロジェクトを作成します。(ユーザー定義タグ付き値は読み込みません。)

パラメータ:

projectPath - プロジェクトのパス(ファイル名も含む)

templatePath - テンプレートのパス(ファイル名も含む)

例外:

IOException - 入出力エラーです

ProjectNotFoundException - プロジェクトが見つかりません

getProjectModelVersion

abstract int getProjectModelVersion()

現在開いているastah*プロジェクトのモデルバージョンを取得します。

戻り値:

astah*プロジェクトのモデルバージョン

例外:

ProjectNotFoundException - プロジェクトが見つかりません

getAstahEdition

abstract String getAstahEdition()

astah*本体のエディションを取得します。

戻り値:

astah*本体のエディション "professional" "UML" "community" "think" "SysML"

getAstahVersion

abstract String getAstahVersion()

astah*本体のバージョンを取得します。

戻り値:

astah*本体のバージョン

getProjectPath

abstract String getProjectPath()

現在開いているastah*プロジェクトの保存場所を取得します。

戻り値:

astah*本体がモデルを保存する場所

例外:

ProjectNotFoundException - プロジェクトが見つかりません

getAstahInstallPath

abstract String getAstahInstallPath()

インストールされたastah*の場所を取得します。

戻り値:

astahのインストールパス

getAstahModelVersion

abstract int getAstahModelVersion()

astah*本体がモデルを保存する場合のモデルバージョンを取得します。

戻り値:

astah*本体がモデルを保存する場合のモデルバージョン

getAstahAPIVersion

abstract String getAstahAPIVersion()

astah*APIのバージョンを取得します。

戻り値:

astah*APIのバージョン

getAstahAPIModelVersion

abstract int getAstahAPIModelVersion()

astah*APIがモデルを保存する場合のモデルバージョンを取得します。

戻り値:

astah*APIがモデルを保存する場合のモデルバージョン

getViewManager

abstract IViewManager getViewManager()

ビューを管理するオブジェクトを返します。

戻り値:

ビューを管理するオブジェクト

例外:

InvalidUsingException - 例外が発生した場合

addProjectEventListener

abstract void addProjectEventListener(ProjectEventListener listener)

プロジェクトイベントリスナーを追加します。

パラメータ:

listener - プロジェクトイベントリスナー

removeProjectEventListener

abstract void removeProjectEventListener(ProjectEventListener listener)

プロジェクトイベントリスナーを削除します。

パラメータ:

listener - プロジェクトイベントリスナー

addEntityEditListener

abstract void addEntityEditListener(EntityEditListener listener)

モデル編集リスナーを追加します。

パラメータ:

listener - モデル編集リスナー

removeEntityEditListener

abstract void removeEntityEditListener(EntityEditListener listener)

モデル編集リスナーを削除します。

パラメータ:

listener - モデル編集リスナー

getEntity

abstract IEntity getEntity(String id)

指定IDを持つIEntityを返します。 現在開いているプロジェクト全体から、指定IDを持つモデル要素または図要素を検索して返します。 プロジェクトが開かれていない場合など検索できない場合は、nullを返します。

パラメータ:

id - 検索するIEntityのID文字列

戻り値:

見つかったIEntityのオブジェクト

isProjectModified

abstract boolean isProjectModified()

現在開いているプロジェクトが編集状態かを返します。

戻り値:

true 編集状態 / false 未編集状態

hasSameElement

abstract boolean hasSameElement(String name)

プロジェクト中に同名Elementがあるかを返します。

パラメータ:

name - 検索するElementの名前

戻り値:

true 同名Elementあり / false 同名Elementなし

hasSameElement

abstract boolean hasSameElement(String name,
                                Class clazz)

プロジェクト中に同名かつ同じ型のElementがあるかを返します。

パラメータ:

name - 検索するElementの名前

clazz - 検索するElementのクラス

戻り値:

true 同名Elementあり / false 同名Elementなし