com.change_vision.jude.api.inf.model
インタフェース IERIndex

com.change_vision.jude.api.inf.model.IERIndex
すべてのスーパーインタフェース:
IElement, IEntity, IHyperlinkOwner, INamedElement
すべての実装されたインタフェース:
IElement, IEntity, IHyperlinkOwner, INamedElement

public IERIndex
extends INamedElement

ERインデックスに対するインタフェース。


フィールドの概要
 
クラス com.change_vision.jude.api.inf.model.INamedElement から継承されたフィールド
PACKAGE_VISIBILITY, PRIVATE_VISIBILITY, PROTECTED_VISIBILITY, PUBLIC_VISIBILITY
 
メソッドの概要
abstract  void addERAttribute(IERAttribute attribute)
          インデックスの属性を追加します。
abstract  IERAttribute[] getERAttributes()
          属性を取得します。
abstract  IERRelationship[] getERRelationships()
          インデックスを参照しているリレーションシップを取得します。
abstract  String getKind()
          インデックスの種類を取得します。
abstract  IEREntity getParentEREntity()
          親のERエンティティを取得します。
abstract  boolean isKey()
          キー(AK,IE)として表示するかどうか確認します。
abstract  boolean isUnique()
          ユニークであるか確認します。
abstract  void removeERAttribute(IERAttribute attribute)
          インデックスの属性を削除します。
abstract  void setKey(boolean isKey)
          キー(AK,IE)として表示するかを設定します。
abstract  void setUnique(boolean isUnique)
          ERインデックスにユニークの設定をします。
 
クラス com.change_vision.jude.api.inf.model.INamedElement から継承されたメソッド
getAlias1, getAlias2, getClientDependencies, getClientRealizations, getClientUsages, getConstraints, getDefinition, getDiagrams, getFullName, getFullNamespace, getName, getSupplierDependencies, getSupplierRealizations, getSupplierUsages, isPackageVisibility, isPrivateVisibility, isProtectedVisibility, isPublicVisibility, setAlias1, setAlias2, setDefinition, setName, setVisibility
 
クラス com.change_vision.jude.api.inf.model.IElement から継承されたメソッド
addStereotype, getComments, getContainer, getContainers, getId, getOwner, getPresentations, getStereotypes, getTaggedValues, getTypeModifier, hasStereotype, hasStereotype, isReadOnly, removeStereotype, setTypeModifier
 
クラス com.change_vision.jude.api.inf.model.IHyperlinkOwner から継承されたメソッド
createElementHyperlink, createFileHyperlink, createURLHyperlink, deleteHyperlink, getHyperlinks
 

メソッドの詳細

isUnique

abstract boolean isUnique()
ユニークであるか確認します。

戻り値:
true 代替キー(AK) / false: 逆方向エントリ(IE)

isKey

abstract boolean isKey()
キー(AK,IE)として表示するかどうか確認します。

戻り値:
true: キー(AK,IE)として表示する / false: キー(AK,IE)として表示しない

getParentEREntity

abstract IEREntity getParentEREntity()
親のERエンティティを取得します。

戻り値:
親のERエンティティ。

getERAttributes

abstract IERAttribute[] getERAttributes()
属性を取得します。

戻り値:
属性の配列。ない場合、長さ0の配列を返します。

getERRelationships

abstract IERRelationship[] getERRelationships()
インデックスを参照しているリレーションシップを取得します。

戻り値:
リレーションシップの配列。ない場合、長さ0の配列を返します。

getKind

abstract String getKind()
インデックスの種類を取得します。

戻り値:
kind: AK1...,IE1...

addERAttribute

abstract void addERAttribute(IERAttribute attribute)
インデックスの属性を追加します。

パラメータ:
attribute - 属性
例外:
InvalidEditingException - 例外が発生した場合
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合 
      ILLEGALMODELTYPE_ERROR_KEY - モデルのタイプが不正な場合 
      BAD_TRANSACTION_KEY - トランザクションエラー 
      HAS_EXCEPTION_KEY - 例外が発生した場合
      READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合
Values: 
      例外のエラーメッセージ

removeERAttribute

abstract void removeERAttribute(IERAttribute attribute)
インデックスの属性を削除します。

パラメータ:
attribute - 属性
例外:
InvalidEditingException - 例外が発生した場合
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合 
      ILLEGALMODELTYPE_ERROR_KEY - モデルのタイプが不正な場合 
      BAD_TRANSACTION_KEY - トランザクションエラー 
      HAS_EXCEPTION_KEY - 例外が発生した場合
      READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合
Values: 
      例外のエラーメッセージ

setUnique

abstract void setUnique(boolean isUnique)
ERインデックスにユニークの設定をします。

パラメータ:
isUnique - true - 代替キー false - 逆方向エントリ
例外:
InvalidEditingException - 例外が発生した場合
Keys: 
      ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合 
      ILLEGALMODELTYPE_ERROR_KEY - モデルのタイプが不正な場合 
      BAD_TRANSACTION_KEY - トランザクションエラー 
      HAS_EXCEPTION_KEY - 例外が発生した場合
      READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合
Values: 
      例外のエラーメッセージ

setKey

abstract void setKey(boolean isKey)
キー(AK,IE)として表示するかを設定します。

パラメータ:
isKey - true - キー(AK,IE)として表示する false - キー(AK,IE)として表示しない
例外:
InvalidEditingException - 例外が発生した場合
Keys:
      ILLEGAL_VERSION_ERROR_KEY - astah* communityで編集APIを使用しようとした場合
      ILLEGALMODELTYPE_ERROR_KEY - モデルのタイプが不正な場合
      BAD_TRANSACTION_KEY - トランザクションエラー
      HAS_EXCEPTION_KEY - 例外が発生した場合
     READ_ONLY_KEY -  リードオンリーな要素を編集しようとした場合
Values:
      例外のエラーメッセージ