Repository

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > リポジトリ >

Repository

Repositoryは全てのモデルやパッケージ・要素などを含む主要なコンテナです。このRepositoryが持つModelsコレクションを利用して、再帰的にすべての情報を利用することができます。また、直接要素やパッケージを参照するための便利なメソッドもいくつか用意してあります。

 

 

プロジェクト内の関係するテーブル

なし

 

属性

属性

R/W

説明

App

App

R

Appオブジェクトを取得します。

Authors

Collection

(Author)

R

プロジェクトに定義された作者のコレクションです。

BatchAppend

bool

RW

多くの要素や属性・操作を追加する場合、このプロパティをTrueにすると処理速度が改善できる場合があります。追加が終わったらプロパティをFalseにすると、一括で処理されます。

これにより、環境によっては10倍以上の処理速度の向上につながります。

Clients

Collection

(client)

R

プロジェクトに定義された顧客のコレクションです。

ConnectionString

string

R

開いているプロジェクトファイルのパスか、リポジトリサーバへの接続文字列です。

接続文字列の中の "DBType=n;" で表現される内容から、プロジェクトの種類を把握することが可能です。

0 - MYSQL

1 - SQLSVR

2 - ADOJET

3 - ORACLE

4 - POSTGRES

5 - ASA  

8 - ACCESS2007

9 - FIREBIRD

CurrentSelection

EASelection

R

現在選択されている要素に関する情報を取得するためのオブジェクトを取得します。

(ビルド1500以降で利用可能)

DataMinerManager

DataMinerManager

R

データ分析のためのオブジェクトを取得します。

(ビルド1500以降で利用可能)

Datatypes

Collection

(Datatype)

R

プロジェクトに定義されたデータ型のコレクションです。データベースのデータ型とプログラム言語のデータ型の両方の情報が含まれています。

EAEdition

EAEditionTypes

R

Enterprise Architectのエディションを示します。

 

注意:

このプロパティは、ユニファイド版およびアルティメット版の場合にはCorporateを戻します。これらのエディションを判別する場合には、EAEditionExを利用してください。

EAEditionEx

EAEditionTypes

R

Enterprise Architectのエディションを示します。

EnableCache

bool

RW

中に含まれる要素の多いパッケージを読み込む場合に、パッケージの内容を先読みしてキャッシュするかどうかの設定です。Trueでこの機能を有効にします。

EnableUIUpdates

bool

RW

この値をFalseにすると、モデルの変更内容を描画しなくなりますので、処理が早くなります。

最新の情報に更新するには、Repository.RefreshModelView を利用します。

FlagUpdate

bool

RW

Trueを設定すると、EAに LastUpdate の値を更新するように指示します。

InstanceGUID

string

R

実行中のEAのインスタンスごとに異なる、IDの値です。

IsSecurityEnabled

bool

R

コーポレート版のセキュリティ機能(アクセス権)が有効になっているかどうかを確認します。Trueで有効であることを示します。

Issues

Collection

(Issue)

R

システムの問題点のコレクションです。

LastUpdate

string

R

実行中のEAのインスタンスおよびインスタンスの実行時を区別するための文字列です。

LibraryVersion

int

R

ライブラリのバージョンを取得します。

多くの場合には、Enterprise Architectのビルド番号と同じです。

Models

Collection

(Package)

R

モデル内のツリーの最上位に位置する「モデルルート」のコレクションです。

それぞれのモデルルートは、パッケージを含んでいます。モデルルートはパッケージの特別な形です。モデルルートのParentIDは0になっています。全てのモデルルートを参照することで、プロジェクト内の階層をすべてたどることができます。

また、AddNewを利用することで、新しいモデルルートを作成することができます。モデルルートは削除することもできますが、削除した場合にはモデルルートに含まれるすべてのパッケージ・要素・ダイアグラムも同時に削除されます。

ObjectType

ObjectType

R

このオブジェクトの種類を区別するために利用することができます。

ProjectGUID

string

R

プロジェクト固有のGUIDを返します。

ProjectRoles

Collection

R

定義済みの、プロジェクトの役割のコレクションです。
(ビルド904以降で利用可能)

PropertyTypes

Collection

(PropertyType)

R

プロジェクトに定義されたタグ付き値の型のコレクションです。

Resources

Collection

(Resource)

R

プロジェクトに定義された担当者のコレクションです。

SchemaComposer

SchemaComposer

R

スキーマコンポーザー機能を制御するためのSchemaComposerオブジェクトを取得します。

(ビルド1220以降で利用可能)

SearchWindow

SearchWindow

R

独自の検索結果を表示するためのオブジェクトを取得します。

(ビルド1500以降で利用可能)

SecurityUser

SecurityUser

R

現在ログオンしているユーザーの、セキュリティ(アクセス権)に関するオブジェクトを取得します。

(ビルド1500以降で利用可能)

Simulation

Simulation

R

シミュレーション機能を制御するためのSimulationオブジェクトを取得します。

Stereotypes

Collection

(Stereotype)

R

プロジェクトに定義されたステレオタイプのコレクションです。

SuppressEADialogs

bool

RW

アドインのEA_OnPostNewElementEA_OnPostNewConnectorを利用する場合に、Enterprise Architectの標準ダイアログを非表示にするために利用します。

Trueで非表示・Falseで表示(既定値)になります。これらの値は、上記のPostイベント発生直前にFalseに設定されますので、非表示にする場合には、Postイベントの中で毎回設定する必要があります。

SuppressSecurityDialog

bool

RW

セキュリティ(アクセス権)機能が有効なプロジェクトに対してログインが失敗した場合に、Enterprise Architect標準のログインダイアログを表示するかどうかを指定します。

Tasks

Collection

(Task)

R

プロジェクトに定義されたタスクのコレクションです。

Terms

Collection

(Term)

R

プロジェクトの用語集のコレクションです。

 

 

操作

操作

戻り値の型

説明

ActivateDiagram

(int DiagramID)

なし

指定されたIDのダイアグラムがタブとして存在する場合には、そのダイアグラムをアクティブにします(そのダイアグラムを表示します)。

 

引数:

  • DiagramID: int -  アクティブにするダイアグラムのIDです。

ActivatePerspective

(string long)

bool

この操作は現在は利用できません。バージョン7以前で利用可能です。

ActivateTab

(string Name)

なし

指定された名前に一致するタブをアクティブにします(タブの内容を表示します)。一致する名前のタブがない場合には、エラーが発生します。

 

引数:

  • Name: string -  指定された名前に一致するタブをアクティブにします。

ActivateTechnology

(string TechnologyID)

なし

指定されたMDGテクノロジーを既定のMDGテクノロジーに設定します。

 

引数:

  • TechnologyID: string - 既定のMDGテクノロジーに設定するテクノロジーのIDを指定します。

ActivateToolbox

(string Toolbox,

int Options)

bool

指定したツールボックスを開きます。戻り値は現在利用されていません。

 

引数:

  • Toolbox: string - 指定されたタイトルのツールボックスのカテゴリをアクティブにします。
  • Options: int - 利用されていません。

AddDefinedSearches

(string sXML)

なし

検索ルールを一時的に追加します。Enterprise Architectを再起動するたびに検索ルールを再度追加する必要があります。

 

引数:

  • sXML: string - この引数に設定可能な検索ルールのXMLデータは、モデルの検索ダイアログで「出力」ボタンを押すと取得できます。

AddDocumentationPath

(string Name,

string Path,

long Type)

なし

この操作は現在は利用できません。バージョン11.1以前で利用可能です。

AddPerspective

(string Perspective,

int Options)

bool

この操作は現在は利用できません。バージョン7以前で利用可能です。

AddPropertiesTab

(string TabName,

 string PropXML)

bool

アドインサブウィンドウ内にプロパティビューを追加します。

追加に成功したらtrueを返します。(ビルド1500以降で利用可能)

(参考:PropertiesTab

 

引数:

  • TabName: string - 作成するタブ名です。
  • PropXML: string - タブの中身をXML形式で指定します。

 

XML文字列の例

 

<?xml version='1.0'?>

<properties>

 <group name='theGroup1'>

   <property id='1' type='text' default='' readonly='false' >

     <name>TestText</name>

     <description>this has id=1</description>

   </property>

   <property id='2' type='combobox' default='' readonly='false' >

     <name>TestCombo</name>

     <value>Two</value>

     <description>this has id=2</description>

     <valuelist>

       <item>One</item>

       <item>Two</item>

       <item>Three</item>

     </valuelist>

   </property>

   <property id='3' type='date' default='currentdate' showcheckbox='false' readonly='false' >

     <name>TestDate</name>

     <value></value>

     <description>this has id=3</description>

   </property>

   <property id='4' type='checkbox' default='true' readonly='false' >

     <name>TestCheckbox</name>

     <description>this has id=4</description>

   </property>

   <property id='5' type='spin' default='1' min='0' max='100' readonly='false' >

     <name>TestSpin</name>

     <value>7</value>

     <description>this has id=5</description>

   </property>

   <property id='6' type='int' default='1' readonly='false' >

     <name>TestInt</name>

     <value>100</value>

     <description>this has id=6</description>

   </property>

   <property id='7' type='double' default='1' readonly='false' >

     <name>TestDouble</name>

     <value>3.333</value>

     <description>this has id=7</description>

   </property>

   <property id='8' type='memo' default='' readonly='false' >

     <name>TestMemo</name>

     <value></value>

     <description>this has id=8</description>

   </property>

 </group>

 <group name='theGroup2'>

   <property id='22' type='text' default='' readonly='false' >

     <name>Test1</name>

     <value></value>

     <description>this has id=22</description>

     <valuelist>

       <item></item>

     </valuelist>

   </property>

 </group>

</properties>

AddTab

(string TabName,

string ControlID)

activeX コントロール

タブウィンドウにActiveX COMコントロールを配置します。Enterprise Architect側でコントロールを作成し、成功した場合にはそのIUnknown型のポインタを返します。

(参照:カスタムビューの作成

 

引数:

  • TabName: string - TabNameは表示されるタブの名前になります。
  • ControlID: string - ControlIDはコントロールのProgIDです。例. Project1.UserControl1

AddWindow

(string WindowName,

string ControlID)

activeX コントロール

アドインサブウィンドウにActiveX COMコントロールを配置し、独自のサブウィンドウとして利用できるようになります。

 

Enterprise Architect側でコントロールを作成し、成功した場合にはそのIUnknown型のポインタを返します。

引数:

  • WindowName: string - WindowNameは表示されるウィンドウの名前になります。アドインサブウィンドウに1つのみ追加されている場合には、サブウィンドウのタイトルになります。複数追加した場合にはタブとして表示されます。
  • ControlID: string - ControlIDはコントロールのProgIDです。

例. Project1.UserControl1

AdviseConnectorChange

(int ConnectorID)

なし

アドインやクライアントが特定の接続が変更したことを通知するための機能です。

EAで表示されているダイアグラムに接続が含まれている場合には、接続を再描画します。

 

引数:

  • ConnectorID: int - 対象の接続のIDです。

AdviseElementChange

(int ObjectID)

なし

アドインやクライアントが特定の要素が変更したことを通知するための機能です。EAで表示されているダイアグラムに要素が含まれている場合には、要素を再描画します。

 

引数:

  • ObjectID - 対象の要素のIDです。

CallSBPI

(string sbpiPrefix,

string method,

string packedParameters)

string

外部ツールとの連携機能を呼び出し、指定した処理を実行します。

(ビルド1500以降で利用可能)

 

引数:

  • sbpiPrefix: string - 外部サーバのプレフィックスを指定します。
  • name: string - 呼び出す、外部サーバの関数名を指定します。
  • packedParameters: string - 名前と値を結合したJSON文字列です。空にはできません。

ChangeLoginUser

(string Name,

string Password)

bool

指定されたログインIDとパスワードでログインを行います。セキュリティ機能が有効でない場合、エラーが発生します。

戻り値は処理の結果を示します。Trueでログインに成功したことを示します。

 

引数:

  • Name: string - ユーザーのログインIDです。
  • Password: string - ユーザーのパスワードです。

ClearAuditLogs

(object StartDateTime,

object EndDateTime)

bool

監査のログを削除します。

StartDateTime および EndDateTime の両方がNULLでない場合には、指定した範囲内の情報を削除します。

 

成功した場合にはtrueが返ります。

  • 削除処理を元に戻すことはできませんので、事前にSaveAuditLogメソッドでログを保存してください。
  • 実行するユーザーが適切なアクセス権を持っていない場合には、falseが返ります。

 

引数:

  • StartDateTime: DateTime  - 削除する範囲の開始日を指定します。
  • EndDateTime; DateTime  - 削除する範囲の終了日を指定します。

ClearOutput

(string Name)

なし

指定された名前の出力サブウィンドウタブの全ての情報を消去します。

 

引数:

  • Name: string - タブの名前を指定します。

CloseAddins()

なし

.NETで作成されたアドインがEA終了後に残ることがないようにするために、オートメーションコントローラによって呼ばれる操作です。

CloseDiagram

(int DiagramID)

bool

指定されたIDのダイアグラムが表示されている場合には、そのダイアグラムを閉じます。戻り値は処理の結果を示します。Trueで正常に処理されたことを示します。

 

引数:

  • DiagramID: int - 対象のダイアグラムのIDを指定します。

CloseFile()

なし

開いているプロジェクトを閉じます。

CreateDocumentGenerator()

Document Generator

EA.DocumentGenerator オブジェクトを取得します。

CreateModel

(CreateModelType CreateType,

string FilePath,

int ParentWnd)

 

bool

新規にプロジェクトファイルを作成します。あるいは、DBMSリポジトリを利用している場合に、ショートカットファイルを作成します。

 

作成に成功した場合にtrueを返します。それ以外の場合にはfalseを返します。

 

引数:

  • CreateType: CreateModelType - 作成方法を指定します。DBMSのショートカットを作成する場合には、詳細を指定するためのダイアログが表示されます。
  • FilePath: string - 新規に作成するファイルの位置を指定します。
  • ParentWnd: int - DBMSのショートカットを作成する場合には、詳細を指定するためのダイアログが表示されます。このダイアログの親ウィンドウとなるウィンドウハンドルを指定します。

CreateOutputTab

(string Name)

なし

指定された名前の出力サブウィンドウタブを作成します。

 

引数:

  • Name: string - 作成するタブの名前を指定します。

Compact()

なし

JavaからAPIを利用する場合にのみ利用できます。

Javaの場合にはEnterprise ArchitectのAPIオブジェクトに対してはガーベジコレクションが動作しないため、オブジェクトを破棄しても内部的にオブジェクト(が使用するメモリ領域)は残ったままになります。このメソッドを定期的に実行することにより、こうした不要なメモリを解放することができます。

DeletePerspective

(string Perspective,

int Options)

bool

この操作は現在は利用できません。バージョン7以前で利用可能です。

DeleteTechnology

(string ID)

bool

MDGテクノロジーをモデルブラウザ内のリソースタブから削除します。

成功した場合にはTrueを返却します。

 

注意:

このメソッドは、プロジェクトに読み込まれたテクノロジーファイルに対してのみ有効です。Enterprise Architectを実行しているマシンに配置されているテクノロジーに対しては利用できません。

「MDGテクノロジーの利用」もご覧ください。

 

引数:

  • ID: string - MDGテクノロジーのIDを指定します。

EnsureOutputVisible

(string Name)

なし

指定された名前の出力サブウィンドウタブが表示されているかどうか確認します。出力サブウィンドウが非表示の場合には表示されます。

引数:

  • Name: String - 対象のタブの名前を指定します。

ExecutePackageBuildScript

(int ScriptOptions,

string PacakgeGuid)

なし

指定されたパッケージに対して動作解析の設定で定義されたコマンドを実行します。GUIDを指定しない場合には現在モデルブラウザで選択されているパッケージが対象になります。

 

引数:

  • ScriptOptions: int - 次のいずれかの値になります。
  • 1 = ビルド
  • 2 = テスト
  • 3 = 実行
  • 4 = ワークベンチ変数の作成
  • 5 = デバッグ

 

  • PackageGuid: string - 実行対象のパッケージのGUIDを指定します。

Exit()

なし

EAをすぐに終了します。.Netで開発をする場合で、ガーベジコレクターが全てのCOMオブジェクトをすぐに開放してくれない場合に利用します。

ExtractImagesFromNote

(string Notes,

string WriteImagePath,

string RelativeImagePath)

string

引数として渡されたノートの文字列内に存在する、画像マネージャーで管理されている画像へのリンクを、外部ファイルへの画像のリンクに置換します。戻される文字列は、リンクを置換した内容となります。

 

引数:

  • Notes:string - 対象のノートの文字列となります。パッケージやダイアグラム・要素のノートの文字列です。
  • WriteImagePath: string - 画像の出力先のパスとなります。指定するパスは存在しなければなりません。
  • RelativeImagePath: string - ノートの内容を置換した際のパスに設定する相対パスを渡します。(例:"..\Images\")

ExtractSBPIParameter

(string packedParameters,

string name)

string

外部ツールとの連携機能を呼び出し、指定した名前に対応する値を取得します。

(ビルド1500以降で利用可能)

 

引数:

  • packedParameters: string - 名前と値を結合したJSON文字列です。空にはできません。
  • name: string - パラメータの名前を指定します。

GenerateMDGTechnology

(string FileName)

bool

MTSファイルの設定を元にMDGテクノロジーファイルを生成します。生成に成功するとtrueを返します。

(ビルド1400以降で利用可能)

 

引数:

  • FileName:string - MTSファイルのパスおよびファイル名です。

GetActivePerspective()

string

この操作は現在は利用できません。バージョン7以前で利用可能です。

GetAllDiagramImagesAndMap

(string Directory)

 

bool

モデル内の全てのダイアグラムについて、画像マップを指定したディレクトリに生成します。ダイアグラムの画像はPNG形式で出力され、ダイアグラムのGUIDがファイル名になります。画像マップはテキスト形式で出力されます。

プロジェクトのオプションの「ダイアグラムの保存時に画像マップを自動的に生成」のオプションが有効である必要があります。

(ビルド1400以降で利用可能)

 

引数:

  • Directory:string - 出力先のディレクトリのパスを指定します。

(参考:クラウド

GetAttributeByGuid

(string Guid)

Attribute

属性のGUIDを指定して、Attributeオブジェクトを取得します。

 

引数:

  • Guid: string - 指定されたGUIDの属性を返します。

GetAttributeById

(string id)

Attribute

属性のIDを指定して、Attributeオブジェクトを取得します。

 

引数:

  • Id: string - 指定されたIDの属性を返します。

GetConnectorByGuid

(string Guid)

Connector

接続のGUIDを指定して、Connectorオブジェクトを取得します。

 

引数:

  • Guid: string - 指定されたGUIDの要素を取得します。コレクションのGetAtメソッドを使わずに、直接要素を取得できます。

GetConnectorByID

(int ConnectorID)

Connector

接続のIDを指定して、Connectorオブジェクトを取得します。

 

引数:

  • ConnectorID: int - IDを指定してConnectorを取得します。

GetContextItem

(object Item)

ObjectType

GetContextItemTypeメソッドと同様の条件における、現在選択されている要素を取得します。GetContextItemTypeメソッドの説明もご覧ください。

 

引数:

  • Item: object - 選択されている要素が戻ります。

GetContextItemType()

ObjectType

現在選択されている項目の情報を返します。ここで「選択されている」とは、次の状況のいずれかで、そのときの操作対象になっている項目になります。

  • モデルブラウザ内で選択されている
  • ダイアグラム内で選択されている
  • 属性や操作などのプロパティダイアログ内で選択されている

 

特定のダイアログ(要素の属性ダイアログなど)で選択されている対象の要素の種類は以下のいずれかになります。

  • otElement
  • otPackage
  • otDiagram
  • otAttribute
  • otMethod
  • otConnector

GetContextObject()

object

現在選択されている項目を返します。戻り値の型は、選択されている項目の種類に依存します。

GetCounts()

string

プロジェクト内の全ての要素の個数を取得します。この個数をチェックすることで、プロジェクト内の要素が追加あるいは削除されたかどうかわかります。

返される内容は、Enterprise Architectの内部のテーブル名と、そのテーブルに含まれる列の数になります。

GetCurrentDiagram()

Diagram

現在表示されているダイアグラムを返します。

GetCurrentLoginUser

(bool GetGuid)

string

ログインユーザーの情報を返します。

セキュリティ機能が有効でない場合、エラーが発生します。

GetGuidがTrueの場合には対象のユーザーを示すGUIDを返します。それ以外の場合、ユーザーの名前を返します。

GetDiagramByGuid

(string Guid)

Diagram

ダイアグラムのGUIDを指定して、Diagramオブジェクトを取得します。コレクションのGetAtメソッドを使わずに、直接ダイアグラムを取得できます。

 

引数:

  • Guid: string - 指定されたGUIDのダイアグラムを取得します。

GetDiagramByID

(int DiagramID)

Diagram

ダイアグラムの(プロジェクト内の)IDを指定してダイアグラムへのポインタを取得します。

このIDは、DiagramのDiagramIDプロパティから取得できます。このIDを保持しておくと、GetAt()メソッドを利用せずにダイアグラムを取得・利用することができます。

 

引数:

  • DiagramID: int - ダイアグラムの(プロジェクト内の)IDを指定してダイアグラムへのポインタを取得します。

GetDiagramImageAndMap

(string DiagramGUID,

string Directory)

bool

指定されたのダイアグラムについて、画像マップを指定したディレクトリに生成します。ダイアグラムの画像はPNG形式で出力され、ダイアグラムのGUIDがファイル名になります。画像マップはテキスト形式で出力されます。

プロジェクトのオプションの「ダイアグラムの保存時に画像マップを自動的に生成」のオプションが有効である必要があります。

(ビルド1400以降で利用可能)

 

引数:

  • DiagramGUID: string - 対象のダイアグラムのGUIDを指定します。
  • Directory:string - 出力先のディレクトリのパスを指定します。

(参考:クラウド

GetElementByGuid

(string Guid)

Element

要素のGUIDを指定して、Elementオブジェクトを取得します。コレクションのGetAtメソッドを使わずに、直接要素を取得できます。

 

引数:

  • Guid: string - 指定されたGUIDの要素を取得します。

GetElementByID

(int ElementID)

Element

要素の(プロジェクト内の)IDを指定して要素へのポインタを取得します。このIDは、ElementのElementIDプロパティから取得できます。このIDを保持しておくと、コレクションのGetAt()メソッドを利用せずに要素を取得・利用することができます。

 

引数:

  • ElementID: int - 要素の(プロジェクト内の)IDを指定して要素へのポインタを取得します。このIDは、ElementのElementIDプロパティから取得できます。

GetElementsByQuery

(string QueryName,

string SearchTerm)

Collection

(Element)

Enterprise Architectで定義されている検索ルールを実行し、結果をコレクションで得ることができます。

例えば、GetElementsByQuery("Simple","Class1")を実行すると、「要素の名前とノート」の検索ルールで、検索単語がClass1の場合の検索結果を返します。

 

引数:

  • QueryName: string - QueryNameは検索ルールの名前です。既定のルールについては、内部で管理されている英語名で指定する必要があります。例:「要素の名前とノート | Simple」
  • SearchTerm: string - 検索する単語を指定します。

GetElementSet

(string IDList,

int Options)

Collection

(Element)

引数の"IDList"に基づいた要素のコレクションを返します。引数に" "を指定するとモデル内の全ての要素を取得します。

 

引数:

  • IDList: string - 要素のIDをカンマで区切って指定します。
    例. GetElementSet("34,56,21,5")
  • Options: int - Optionsに値を設定すると、このメソッドの挙動を変更することができます。
  • 1 - 1を指定すると、空のIDListが渡されたときに長さ0のコレクションを返します。
  • 2 - 2を指定した場合には、IDListの引数に指定されたSQL関数の結果をコレクションとして返します。

GetFieldFromFormat

(string Format,

string Text)

string

指定した文字列を、Enterprise Architect内部用の文字列に変換します。要素のノート欄の情報など、文字列に対して書式設定が可能な属性に文字列を格納する場合に利用します。

 

引数:

  • Format: string - 指定可能な値は次の通りです。
  • HTML
  • RTF
  • TXT
  • Text: string - Formatの引数で指定した形式の文字列を格納します。

GetFormatFromField

(string Format,

string Text)

string

指定したEnterprise Architect内部用の文字列を、指定した書式に変換します。要素のノート欄の情報など、文字列に対して書式設定が可能な属性から文字列を取り出す場合に利用します。

 

引数:

  • Format: string - Formatとして指定可能な値は次の通りです。戻り値として戻される、文字列の形式(取得したい形式)を指定します。
  • HTML
  • RTF
  • TXT
  • Text: string - 例えば、Element.Notesの値など、文字列に対して書式設定が可能な属性の文字列を渡します。

GetFormattedName

(string Guid,

long FlagInclude,

string Separator,

long FlagFormat)

string

GUIDで指定した要素について、指定した内容の情報を付加し整形した文字列を返します。例えば、名前空間の情報を含む名前を取得したいような場合に利用します。

 

引数:

  • Guid: string - 対象の要素です。
  • FlagInclude: long - 含める内容を指定します。
  • fiFeature = 1
  • fiClass = 2
  • fiParents = 4
  • fiPackage = 8
  • fiRootNS = 16
  • fiHiddenNS = 32
  • fiDiagram = 64
  • fiElemAlias = 128

 

  • Separator: string - 情報を区切る文字列を指定します。
  • FlagFormat: long - 必要に応じて、オプションを指定します。指定しない場合には0を渡します。
  • ffReplaceSpaces = 1
  • ffLowercase = 2
  • ffURLEncode = 4

 

例:

formattedName = Repository.GetFormattedName (element.ElementGUID, fiFeature | fiClass | fiParents | fiPackage | fiDiagram, "::", 0);

 

(ビルド1400以降で利用可能)

GetGapAnalysisMatrix()

string

ギャップ分析マトリックスの内容を文字列として取得します。

GetLastError()

string

最後に発生したエラーの詳細情報です。エラーが発生したときには例外が発生しますので、この操作を利用することはほとんどありません。

GetLocalPath

(string Type,

string Path)

string

要素のソースファイルのパスにローカルパスが利用されている場合に、そのローカルパスを展開したパスを返します。

 

引数:

  • Type: string - JavaやC++など、対象の言語名を渡します。
  • Path: string - ローカルパスを含むパスを渡します。
    例: %Desktop%\src\sample.java

 

例:

Repository.GetLocalPath (Java, %Desk%\Javacode\Motor.java)

を実行した場合の戻り値の例:

C:\Users\fbloggs\Desktop\Javacode\Motor.java.

GetMailInterface()

MailInterface

EA.MailIinterface のオブジェクトを返します。ツール内のメッセージ送信機能を利用する場合に取得します。

GetMethodByGuid

(string Guid)

Method

指定されたIDの操作を返します。

 

引数:

  • Guid: string - 指定されたGUIDの操作を返します。

GetMethodById

(string id)

Method

指定されたIDの操作を返します。

 

引数:

  • Id: string - 指定されたIDの操作を返します。

GetPackageByGUID

(string Guid)

Package

パッケージのGUIDを指定してパッケージへのポインタを取得します。

それぞれのパッケージには、同じGUIDを持つElement要素が存在し、パッケージのプロパティはPackageとElementに分けて保持されます。

要素のGUIDが判明し、要素のTypeがPackageの場合には、GetPackageByGuid(Element.ElementGUID)でパッケージ要素を取得することができます。

 

引数:

  • Guid: String - パッケージのGUIDを指定します。

GetPackageByID

(int PackageID)

Package

パッケージの(プロジェクト内の)IDを指定してパッケージへのポインタを取得します。このIDは、PackageのPackageIDプロパティから取得できます。このIDを保持しておくと、GetAt()メソッドを利用せずにパッケージを取得・利用することができます。

 

引数:

  • PackageID: int - パッケージの(プロジェクト内の)IDを指定してパッケージへのポインタを取得します。

GetProjectInterface()

Project

Projectオブジェクトへのポインタを返します。このインターフェースを利用すると、プロジェクト内のさまざまな情報をXML形式で取得することができます。

GetPropertiesTab

(string TabName)

PropertiesTab

指定した名前のタブを返します。

(ビルド1500以降で利用可能)

 

引数:

  • TabName: string - タブ名を指定します。

GetReferenceList

(string Type)

Reference

Enterprise Architect内部の定義情報やリファレンス情報の一覧を取得することができます。引数には、取得する一覧を指定します。

  • Type: string - 有効な値は次の通りです。:詳細は、Referenceのページをご覧下さい。
  • Diagram
  • Element
  • Constraint
  • Requirement
  • Connector
  • Cardinality
  • Effort
  • Metric
  • Scenario
  • Status
  • Test

GetRelationshipMatrix ()

string

XML形式で、プロジェクトに定義されている全ての関係マトリックスプロファイルの定義内容を返します。

(参考:要素の関係マトリックス

GetSimulation()

Simulation

この操作は現在は利用できません。バージョン11.1以前で利用可能です。

Repository.Simulation を利用して下さい。

GetTechnologyVersion

(string ID)

string

指定したIDのMDGテクノロジーのバージョンを返します。

 

引数:

  • ID: String - MDGテクノロジーのIDを指定します。

GetTreeSelectedElements()

Collection

モデルブラウザで選択されている項目を返します。複数項目に対応します。

GetTreeSelectedItem

(object SelectedItem)

ObjectType

モデルブラウザで選択されている項目を返します。

 

この機能を利用するためには、汎用的なオブジェクト変数を作成してパラメータとして渡してください。返却されるオブジェクトの種類に応じて、より適切な型にキャストしてください。

オブジェクトは次のうちのどれかになります。:

package, element, diagram, attribute, operation

 

引数:

  • SelectedItem: object - モデルブラウザで選択されている要素を返します。

GetTreeSelectedItemType()

ObjectType

モデルブラウザで選択されている項目の種類を返します。以下はその例です。:

  • otDiagram
  • otElement
  • otPackage
  • otAttribute
  • otMethod

GetTreeSelectedObject()

object

モデルブラウザで選択されている要素を返します。

利用している言語によりGetTreeSelectedItemが利用できない場合には、この操作を利用して下さい。

GetTreeSelectedPackage()

Package

現在モデルブラウザで選択されている要素が含まれるパッケージを返します。

HasPerspective

(string Perspective)

string

この操作は現在は利用できません。バージョン7以前で利用可能です。

HideAddinWindow()

なし

アドインサブウィンドウを非表示にします。

(参考:カスタムサブウィンドウ)

ImportPackageBuildScripts

(string PacakgeGuid,

string BuildScriptXML)

なし

XML形式の動作解析の設定を指定されたパッケージに読み込みます。

 

引数:

  • PackageGuid: string - 動作解析の設定を読み込むパッケージをGUIDで指定します。
  • BuildScriptXML: string - 読み込む設定内容です。設定はXML形式で渡します。

ImportRASAsset

(string pkgGUID,
string protocol,
string servername,
string model,
string storage,
string rasGUID,
string version,
string passwords)

bool

パッケージリポジトリに登録されているパッケージを読み込みます。

(ビルド1308以降で利用可能)

 

引数:

  • packageGUID: string  - 読み込み先のパッケージをGUIDで指定します。
  • protocol: string  - サーバと通信するプロトコルを指定します。
  • servername: string  - サーバの名前を指定します。
  • model: string - 対象のモデル名を指定します。
  • storage: string - 対象のストレージ名を指定します。
  • rasGUID: string - 登録されているパッケージのGUIDを指定します。
  • password: string - 取得時に利用するパスワードを指定します。
  • version: string - 取得するパッケージのバージョンを指定します。

ImportTechnology

(string Technology)

bool

MDGテクノロジーをプロジェクトに読み込み、モデルブラウザ内のリソースタブに表示します。

成功した場合にはTrueを返します。それ以外の場合にはFalseを返します。

このメソッドは、プロジェクトに直接読み込む方式に対応しています。

注意:

このメソッドは、プロジェクトにMDGテクノロジーファイルを読み込みます。MDGテクノロジーの配置もご覧ください。

 

引数:

  • Technology: string - MDGテクノロジーの内容です。XML形式の文字列です。

InsertSBPIParameter

(string packedParameters,

string name,

string value)

string

外部ツールとの連携機能を呼び出し、JSON文字列を受け取ります。

(ビルド1500以降で利用可能)

 

引数:

  • packedParameters: string - 名前と値を結合したJSON文字列です。空にはできません。
  • name: string - パラメータの名前を指定します。
  • Flags: string - パラメータの値を指定します。

InvokeConstructPicker

(string ElementFilter)

int

Enterprise Architectで操作する場合に、要素やなどを選択する場合に表示される要素の選択ダイアログをAPIから利用するための機能です。要素が選択された場合にはその要素のElementIDを、選択されなかった場合には0を返します。

 

例:

elementid=Repository.InvokeConstructPicker

("IncludedTypes=Class,Component;StereoType=foo,bar")

 

この例では、クラス要素かコンポーネント要素で、さらにステレオタイプfooあるいはbarを持つ要素のみが選択可能になります。

 

引数:

  • ElementFilter: string - 選択可能になる要素やパッケージの条件を指定します。条件として、以下の項目が設定可能です。各項目はセミコロンで区切ります。
  • IncludedTypes=<type> - (必須) カンマ区切りで要素の種類名を英単語で指定します。

例: Package, Class, Component

  • MultiSelect=True - (オプション) 項目の複数選択を可能にします。この場合、戻り値は選択された項目のうちの1つのElementIDになります。
  • Selection=<guid> - (オプション) GUIDで指定した項目を選択状態で開きます。
  • GenNext=True - (オプション) 複数選択にした場合に、残りの選択項目のElementIDを返します。0が戻った場合には、全ての選択項目を返したことを示します。
  • StereoType=<stereotype> - (オプション) カンマ区切りでステレオタイプを指定します。

 

いずれの項目も、不要な空白文字を含めないで下さい。空白文字も、要素の種類やステレオタイプの名前の1つとして認識されます。大文字小文字が区別されます。大文字小文字が一致しない場合には、期待する結果が得られません。

 

MultiSelect=Trueの場合の例:.

val = Repository.InvokeConstructPicker 

("IncludedTypes=Class; MultiSelect=True;");

 

while(val != 0)

{

    val = Repository.InvokeConstructPicker("GetNext=True;");

 

}

InvokeFileDialog

(string FilterString,

int Filterindex,

int Flags)

string

Windows標準のファイルを開くためのダイアログを表示します。ファイルパスの取得に成功した場合には、そのパスを戻します。

 

引数:

  • FilterString: string - ファイルのフィルタを指定します。フィルタの指定方法は、Win32APIのGetOpenFileName関数と同じです。詳細はMSDN等をご覧下さい。
  • Filterindex: int - FilterStringで指定したフィルタについて、既定のフィルタを指定します。最初の項目が1になります。
  • Flags: int - ダイアログの設定を示すフラグです。指定可能な値はWin32のOPENFILENAME構造体内のFlagsと同じになります。OPENFILENAME構造体の詳細はMSDN等をご覧下さい。

(参考:Project.GetFileNameDialog())

IsTabOpen

(string TabName)

int

指定したタブが開かれているかどうかを確認します。ダイアグラムの他、Repository.AddTab()で追加したタブを対象にすることもできます。

  • 2はタブが存在し現在アクティブ(表示されている)場合
  • 1はタブが存在するがアクティブではない場合
  • 0は存在しない場合を示します。

 

引数:

  • TabName: string - 対象のタブの名前を指定します。

IsTechnologyEnabled

(string ID)

bool

指定されたMDGテクノロジーが有効になっているかどうかを確認します。

戻り値がTrueのときは、指定したMDGテクノロジーが有効になっています。それ以外の場合にはFalseになります。

 

引数:

  • ID: string - 対象のMDGテクノロジーのIDです。以下は、Enterprise Architectの既定のMDGテクノロジーのIDの一例です。

 

id="UML2" name="Basic UML 2 Technology"

id="EAExtended" name="Core Extensions"

id="262139" name="MDG Technology Builder"

 

このメソッドは、Enterprise Architectの既定のMDGテクノロジーの他、ユーザーが独自に追加したMDGテクノロジーについても確認可能です。

IsTechnologyLoaded

(string ID)

bool

MDGテクノロジーが既に正しく読み込まれているかどうかを確認します。

正しく読み込まれている場合にはTrueを返します。それ以外の場合にはFalseになります。

 

引数:

  • ID: string - 対象のMDGテクノロジーのIDです。

LoadAddins()

void

全てのアドインを読み込みます。OpenFile, OpenFile2, CreateModelを実行する前に呼び出す必要があります。

MarkupNotes

(string Notes,

string GlossaryType,

string replacement)

string

指定した文字列に含まれる用語を、指定した文字列で置換します。
(ビルド1520以降で利用可能)

 

引数:

  • Notes: String - 対象の文字列を指定します。
  • GlossaryType: String - 対象とする用語の種類を指定します。
  • replacement: String - 用語が見つかった場合の置換文字列を指定します。用語自体は#TERM#で示します。
    例: '<span class="notranslate">#TERM#</span>'

OpenDiagram  

(int DiagramID)

void

特定のダイアグラムを表示するための機能です。ダイアグラムが開かれていない場合にはタブとして追加され、ダイアグラムビューに表示されます。

 

引数:

  • DiagramID: int - 対象のダイアグラムを指定します。

OpenFile

(string Filename)

bool

EAのプロジェクトを開きます。引数に有効なプロジェクトファイルを指定する必要があります。戻り値は処理の結果を示します。trueで正常に処理されたことを示します。

DBMSリポジトリに接続する場合には、接続文字列を引数として渡します。なお、DBMSのショートカットファイルを引数に指定してDBMSリポジトリを開くこともできます。

 

引数:

  • Filename: string - 開くプロジェクトファイルあるいは接続文字列を指定します。

OpenFile2

(string FilePath,

string Username,

string Password)

bool

パスワードを指定してOpenFileを実行します。戻り値は処理の結果を示します。trueで正常に処理されたことを示します。

 

引数:

  • Filepath: string - 対象のプロジェクトのパスです。
  • Username: string - ログインするユーザのIDです。
  • Password: string - ログインするユーザのパスワードです。

RefreshModelView

(int PackageID)

なし

指定したパッケージの内容か、プロジェクト全体の内容を読み込み直します。

 

引数:

  • PackageID: int - 指定されたパッケージIDのパッケージ以下の内容を全て更新します。0を指定すると、モデル全体を更新します。

RefreshOpenDiagrams

(bool FullReload)

なし

現在開かれている全てのダイアグラムの内容を更新します。

 

引数:

  • FullReload: bool - FullReloadがfalseの場合には、要素の区画の情報のみを更新します。trueの場合には、ダイアグラムの内容の全てを更新します。

ReloadDiagram

(int DiagramID)

bool

指定されたIDのダイアグラムを再読み込みします。コードの生成や読み込み・その他のバッチ処理の実行後にリフレッシュするために利用します。戻り値は処理の結果を示します。trueで正常に処理されたことを示します。

 

引数:

  • DiagramID: int - 対象のダイアグラムを指定します。

ReloadPackage

(int PackageID)

なし

指定されたパッケージと、そのパッケージに含まれるダイアグラムの内容を最新の内容に更新します。

(ビルド1300以降で利用可能)

 

引数:

  • PackageID: long - 対象のパッケージのPackageID

RemoveOutputTab

(string Name)

なし

指定された名前の出力サブウィンドウタブを削除します。

 

引数:

  • Name: string - 削除するタブの名前を指定します。

RemoveTab

(string Name)

なし

指定された名前のタブを削除します。

 

引数:

  • Name: string - 削除するタブの名前です。

RemoveWindow

(string WindowName)

bool

指定された名前のアドインサブウィンドウを削除します。

 

引数:

  • WindowName: string - 削除するウィンドウの名前です。

RepositoryType()

string

データベースリポジトリの種類を返します。以下の値のいずれかになります。

  • JET   - EAPX/EAPファイル
  • FIREBIRD - FEAPファイル
  • ACCESS2007 - .accdbファイル
  • ASA  - Sybase SQL Anywhere
  • SQLSVR  - Microsoft SQL Server
  • MYSQL  - MySQL
  • ORACLE  - Oracle
  • POSTGRES - PostgreSQL

RunModelSearch

(string sQueryName,

string sSearchTerm,

string sSearchOptions,

string sSearchData)

なし

検索を実行し、その結果を検索ビューとして表示します。

 

引数:

  • sQueryName: string - QueryNameは実行する検索ルールです。
  • sSearchTerm: string - SearchTermには検索する単語を指定します。
  • sSearchOptions: string - SearchOptionsは現在未使用です。
  • sSearchData: string - SearchDataに渡すことのできる内容のフォーマットはXML フォーマットをご覧ください。このSearchData引数は通常の検索時は不要です。

 

(Project.RunModelSearchの利用を推奨します。)

SaveAllDiagrams()

なし

現在開かれていて、編集中のダイアグラムを全て保存します。アドインの実行時に呼ぶことで、ダイアグラム内の編集内容を確実に参照可能になります。

SaveAuditLogs

(string FilePath,

object StartDateTime,

object EndDateTime)

bool

監査のログを指定したファイルに保存します。StartDateTimeとEndDateTimeがNULLでない場合には、指定した範囲内の情報を保存します。

処理が成功するとtrueが戻され、失敗した場合には falseが戻されます。

  • 適切なアクセス権がない場合にはfalseが戻ります。

 

引数:

  • FilePath: string - 監査ログを保存するファイルパスを指定します。
  • StartDateTime: DateTime  - 保存する範囲の開始日を指定します。
  • EndDateTime; DateTime  - 保存する範囲の終了日を指定します。

SaveDiagram

(int DiagramID)

なし

指定されたIDのダイアグラムを保存します。

 

引数:

  • DiagramID: int - 対象のダイアグラムを指定します。

SaveDiagramAsUMLProfile

(string DiagramGUID,

string FileName)

bool

指定されたダイアグラムの内容をUMLプロファイルとして出力します。最後にEnterprise Architectの画面でUMLプロファイルが出力された際の設定を利用します。

処理が成功するとtrueが戻されます。

(ビルド1400以降で利用可能)

 

引数:

  • DiagramGUID: string - 対象のダイアグラムのGUIDを指定します。
  • FileName: string  - 出力先となるファイルパスを指定します。空文字列を設定すると、最後に出力した出力先に出力します。

SavePackageAsUMLProfile

(string PackageGUID,

string FileName)

bool

指定されたパッケージの内容をUMLプロファイルとして出力します。最後にEnterprise Architectの画面でUMLプロファイルが出力された際の設定を利用します。

処理が成功するとtrueが戻されます。

(ビルド1400以降で利用可能)

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDを指定します。
  • FileName: string  - sy津力先となるファイルパスを指定します。空文字列を設定すると、最後に出力した出力先に出力します。

ScanXMIAndReconcile()

なし

「モデルの内容の再調整」機能を実行します。バージョン管理機能を利用している場合に、ダイアグラムの内容が正しく表示されない場合に利用します。

 

この機能を実行することで、バージョン管理されているパッケージ間にまたがる接続や要素がダイアグラム内で表示されない状況を修正し、正しく表示されるようになります。

 

設計者のそれぞれがローカルにプロジェクトを保持してバージョン管理されているパッケージを編集する状況では意味がありますが、モデルの内容の全てが1つのプロジェクトに含まれ、全員がそのプロジェクトを参照する状況では実行する意味はありません。

 

実行すると、それぞれのバージョン管理されているパッケージに関連づけられたXMIファイルの内容を参照し、そのパッケージに含まれていない要素や接続があるかどうかを調べます。存在する場合には、そのパッケージの内容を更新します。

 

なお、この調整処理は、「最新バージョンを全て取得」を実行した場合にも行われます。

 

パッケージ間の要素の利用が複雑な場合には、この機能を定期的に実行することをお勧めします。なお、以下の点に注意が必要です。

 

  • 一般論として、コミットしていない状態(編集中の内容がある場合)にはこの機能は実行しないでください。
  • 一般的な手順としては以下のようになります。
  • パッケージを(複数)チェックアウトする
  • ScanXMIAndReconcileを実行する
  • モデルの変更を行う
  • コミットする(さらにチェックアウトする必要がある場合でも、一度コミットして変更を反映する)

ShowAddinWindow

(string TabName)

bool

指定した名前のタブを、アドインサブウィンドウで開きます。タブを開くことができたらtrueを返します。

 

引数:

  • TabName: string - タブの名前を指定します。

(参考:カスタムサブウィンドウ

ShowDynamicHelp

(string Topic)

なし

指定したページに対応したヘルプのページを表示します。

 

引数:

  • Topic: string - ページの指定は、Enterprise Architectのヘルプの内部的なhtmファイル名で指定します。

ShowInProjectView

(object Item)

なし

指定された要素をモデルブラウザ内で選択状態にします。

引数に指定可能な種類は、パッケージ・要素・ダイアグラム・属性・操作です。それ以外の要素を指定すると例外をスローします。

 

引数:

  • Item: object - 要素をモデルブラウザ内で選択状態にします

ShowWindow

(int Show)

なし

EAのメインウィンドウの表示の有無を指定します。プロジェクトを開いた後に利用できます。

引数:

  • Show: int - 1で表示・0で非表示

SQLQuery

(string SQL)

string

指定したSQL文(SELECT文)を実行します。結果はXML形式で返却されます。

SELECT文以外や、複雑なSELECT文は実行できません。このメソッドの使い方については、製品サポートの対象外となります。

 

引数:

  • SQL: string - 実行するSELECT文を指定します。

SynchProfile

(string Profile,

string Stereotype)

bool

UMLプロファイルで定義されているステレオタイプが適用されている要素に対して、タグ付き値と制約の情報を同期します。

 

引数:

  • Profile: string - 対象のUMLプロファイルの名前です。
  • Stereotype: string - 対象のUMLプロファイルに含まれるステレオタイプを指定します。指定したステレオタイプが設定されている要素が同期対象になります。

VersionControlResynchPkgStatuses

(bool ClearSettings)

なし

全てのパッケージに対してバージョン管理の状態をバージョン管理ツールから取得し、最新の状態に更新します。

 

引数:

  • ClearSettings: bool - バージョン管理ツールから、パッケージに対応するファイルが管理されていないという回答があった場合の処理を指定します。
  • trueを指定すると、バージョン管理の設定を削除します。
  • falseを指定すると、バージョン管理の設定情報はそのまま残します。

WriteOutput

(string Name,

string Output, int ID)

なし

指定された名前の出力サブウィンドウタブに文字列を出力します。出力する文字列には内部処理のためのIDを関連付けることができます。

 

引数:

  • Name: string - 対象のタブの名前を指定します。
  • Output: string - 表示する内容を指定します。
  • ID: int - その内容に関連するIDを指定します。

(参照:EA_OnOutputItemClicked , EA_OnOutputItemDoubleClicked)