クラス com.telelogic.cm.migrate.MigrateObject は、移行時にソース移行パスで見つかった各オブジェクト、ワークエリア・コンフリクトの検出時にワークエリア・パスで見つかった各オブジェクト、あるいは作成されるオブジェクトのプロジェクトにおける相対パスで見つかった各オブジェクトを表します。
以下では、使用可能なメソッドについて説明します。
setName
- void setName(String name)
- オブジェクトの名前を設定します。
パラメーター: name - オブジェクトの名前。
getType
- String getType()
- オブジェクトのタイプを返します。
戻り値: このオブジェクトの Rational® Synergy タイプの名前 (タイプの 4 部構成のフルネームではなく、そのコンポーネント名のみ)。
このメソッドが NULL または空ストリングを返すことはありません。
setType(String) も参照してください。
setType
- void setType(String type)
- throws MigrateException
- オブジェクトのタイプを設定します。
パラメーター: type - オブジェクトのタイプ。
スローする例外: MigrateException - 発生した場合。
getType() も参照してください。
setVersion
- void setVersion(String version)
- オブジェクトのバージョンを設定します。
パラメーター: version - オブジェクトのバージョン。
version() も参照してください。
setDirectory
- void setDirectory(boolean isDirectory)
- オブジェクトがディレクトリーかどうかを設定します。
パラメーター: isDirectory - オブジェクトがディレクトリーかどうかを示すブール値。
setProject
- void setProject(boolean isProject)
- オブジェクトがプロジェクトかどうかを設定します。
パラメーター: isProject - オブジェクトがプロジェクトかどうかを示すブール値。
getAllMembers
- Collection<Member<MigrateObject>> getAllMembers()
- プロジェクト・オブジェクトのメンバーを返します。
プロジェクトのメンバーとは、そのプロジェクトの子であるオブジェクト、またはそのプロジェクトの非プロジェクト・メンバーの子であるオブジェクトです。この定義から、プロジェクトが別のプロジェクトのメンバーである可能性はありますが、プロジェクトのメンバーが必ずしも親プロジェクトのメンバーであるとは限りません。
戻り値: このプロジェクトのメンバーの順不同のコレクション (重複なし)。プロジェクトにメンバーが存在しない場合、またはこのオブジェクトがプロジェクトでない場合は、コレクションが空になります。つまり、RelatedObject.isProject() で FALSE が返される場合が該当します。
getMembers
- Collection<Member<MigrateObject>> getMembers(MigrateObject
directory)
- このプロジェクト内の、親ディレクトリーのメンバー (バインディング) を返します。現行オブジェクトがプロジェクトでない場合、リストは空です。
パラメーター: directory - 保持されているバインディングを判別する必要がある親ディレクトリー。
戻り値: ディレクトリー内にあるこのプロジェクトのメンバーのコレクション (重複なし)。子オブジェクトの名前の順に並べられます。
プロジェクトにメンバーが存在しない場合またはこのソース・オブジェクトがプロジェクトでない場合 (つまり、RelatedObject.isProject() で FALSE が返される場合)、あるいは指定されたディレクトリーにメンバーが存在しない場合または指定されたオブジェクトがディレクトリーでない場合は、コレクションが空になります。
つまり、後の 2 つのケースでは、RelatedObject.isDirectory() で FALSE が返される場合が該当します。
getSubprojects
- Collection<MigrateObject> getSubprojects()
- この移行プロジェクトのサブプロジェクトを返します。サブプロジェクトは、プロジェクトであるメンバーです。
戻り値: プロジェクト・オブジェクトの順不同のコレクション (重複なし)。プロジェクトであるメンバーがこのプロジェクトに存在しない場合、またはこのオブジェクトがプロジェクトでない場合、コレクションが空になります。つまり、RelatedObject.isProject() で FALSE が返される場合が該当します。
getAttributes
- Map<String,Attribute> getAttributes()
- throws MigrateException
- このオブジェクトの属性を取得します。
戻り値: 属性名をキーとし、属性自体を値とする変更不可能なマップ。
スローする例外: MigrateException - 発生した場合。
getAttribute
- Attribute getAttribute(String name)
- throws MigrateException
- このオブジェクトの属性を取得します。
パラメーター: name - 属性の名前。
戻り値: 指定された名前に対応する属性。
スローする例外: MigrateException - 発生した場合。
getAttributeValue
- Object getAttributeValue(String name)
- throws MigrateException
- 指定された名前の属性値を取得します。
パラメーター: name - 属性の名前。
戻り値: 属性の値。
スローする例外: MigrateException - 発生した場合。
setAttributes
- void setAttributes(Collection<Attribute> attributes)
- このオブジェクトに属性を設定します。
パラメーター: attributes - このオブジェクトの属性。
setAttribute
- void setAttribute(Attribute attribute)
- throws MigrateException
- このオブジェクトに属性を設定します。
パラメーター: attribute - このオブジェクトの属性。
スローする例外: MigrateException - 発生した場合。
setAttribute
- void setAttribute(String name, String value)
- throws MigrateException
- このオブジェクトに String タイプの指定された属性を設定します。
パラメーター:
- name - 属性の名前。
- value - 属性の値。
スローする例外: MigrateException - 発生した場合。
setAttribute
- void setAttribute(String name, Date value)
- throws MigrateException
- このオブジェクトに Date タイプの指定された属性を設定します。
パラメーター:
- name - 属性の名前。
- value - 属性の値。
スローする例外: MigrateException - 発生した場合。
setAttribute
- void setAttribute(String name, boolean value)
- throws MigrateException
- このオブジェクトに Boolean タイプの指定された属性を設定します。
パラメーター:
- name - 属性の名前。
- value - 属性の値。
スローする例外: MigrateException - 発生した場合。
setAttribute
- void setAttribute(String name, int value)
- throws MigrateException
- このオブジェクトに Integer タイプの指定された属性を設定します。
パラメーター:
- name - 属性の名前。
- value - 属性の値。
スローする例外: MigrateException - 発生した場合。
isBinary
- boolean isBinary()
- throws MigrateException
- このオブジェクトのソースがテキストとバイナリーのどちらとして扱われるかを示します。テキスト・オブジェクトでは、キーワードの置換、改行の変換、エンコードの変換が行われる場合があります。バイナリー・オブジェクトはビット単位でコピーされ、クライアントからサーバーにコピーされるとき、およびワークエリアとの間でコピーされるときに変更されることはありません。
このメソッドで FALSE が返されるオブジェクトは、特定の制限された文字を含んでいる場合、制御文字を大量に含んでいる場合、または移行ルールによってバイナリー・タイプにマップされている場合は、Rational Synergy でバイナリーとして扱われることがあります。
戻り値: オブジェクトがバイナリーとして扱われる場合は TRUE、オブジェクトがテキストとして扱われる場合は FALSE。このメソッドで TRUE が返されても、このオブジェクトに使用されている Rational Synergy タイプが ascii であるか ascii のサブタイプである場合は、handle_as 属性が binary に設定されます。
スローする例外: MigrateException - 発生した場合。
setBinary(boolean) も参照してください。
setBinary
- void setBinary(boolean isBinary)
- このオブジェクトのバイナリー・プロパティーを設定します。
パラメーター: isBinary - オブジェクトにバイナリーの内容が含まれているかどうかを示すブール値。
isBinary() も参照してください。
getTextSource
- Reader getTextSource()
- throws MigrateException
- テキスト・オブジェクトのソースにアクセスします。移行フレームワークでは、isBinary() で FALSE が返される場合に、このメソッドを使用してソースを取得します。
移行ソースでの基礎となる表現がどのようなものであっても、正しいエンコードを使用する責任は、基礎となる SourceObject# 操作にあります。
戻り値: オブジェクト・ソースへの文字ストリーム。
スローする例外: MigrateException - 発生した場合。
setTextSource
- void setTextSource(Reader textSource)
- throws MigrateException
- このオブジェクトのテキスト・ソースを設定します。
パラメーター: textSource - このオブジェクトのテキスト・ソース。
スローする例外: MigrateException - 発生した場合。
binarySource
- InputStream binarySource()
- throws MigrateException
- オブジェクトのソースにアクセスします。移行フレームワークでは、isBinary() で TRUE が返される場合に、このメソッドを使用してソースを取得します。
戻り値: オブジェクト・ソースへのバイト・ストリーム。
スローする例外: MigrateException - 発生した場合。
setBinarySource
- void setBinarySource(InputStream binarySource)
- このオブジェクトのバイナリー・ソースを設定します。
パラメーター: binarySource - このオブジェクトのバイナリー・ソース。
binarySource() および setTextSource(Reader) も参照してください。
isExecutable
- boolean isExecutable()
- ファイル・オブジェクトの実行可能プロパティーを取得します。
戻り値: ファイルが実行可能かどうか。
setExecutable
- void setExecutable(boolean isExecutable)
- ファイル・オブジェクトに実行可能プロパティーを設定します。
パラメーター: isExecutable - ファイルが実行可能かどうかを決定するプロパティー。
isLink
- boolean isLink()
- ファイル・オブジェクトのリンク・プロパティーを取得します。
戻り値: ファイルがリンクかどうか。
setLink
- void setLink(boolean isLink)
- ファイル・オブジェクトにリンク・プロパティーを設定します。
パラメーター: isLink - ファイルがリンクかどうかを決定するプロパティー。
isIgnore
- boolean isIgnore()
- オブジェクトの無視プロパティーを取得します。
戻り値: オブジェクトが無視されるかどうか。
setIgnore
- void setIgnore(boolean ignore)
- オブジェクトに無視プロパティーを設定します。
パラメーター: ignore - オブジェクトが無視されるかどうかを決定するプロパティー。
status
- String status()
- 状況プロパティーを取得します。
戻り値: 状況プロパティー。
setStatus
- void setStatus(String status)
- 状況プロパティーを設定します。
パラメーター: status - プロパティー。
getPath
- String getPath()
- オブジェクトのパスを取得します。
戻り値: オブジェクトのパス。
isManualIgnore
- boolean isManualIgnore()
- 無視プロパティーを取得します。
戻り値: 無視プロパティー。
setManualIgnore
- void setManualIgnore(boolean ignore)
- 無視プロパティーを設定します。
パラメーター: ignore - 移行オブジェクトが無視されるかどうか。
getTaskSpec
- String getTaskSpec()
- この移行オブジェクトに関連付けられたタスク仕様を取得します。
戻り値: この移行オブジェクトに関連付けられたタスク仕様。
setTaskRelease
- void setTaskRelease(String taskRelease)
- この移行オブジェクトに関連付けられるタスク・リリースを設定します。
パラメーター: taskRelease - この移行オブジェクトに関連付けられるタスク・リリース。
getTaskRelease
- String getTaskRelease()
- この移行オブジェクトに関連付けられたタスク・リリースを取得します。
戻り値: この移行オブジェクトに関連付けられたタスク・リリース。
isOptionalVersion
- boolean isOptionalVersion()
- オプションのバージョンが設定されているかどうかを取得します。
戻り値: オプションのバージョンが設定されているかどうかに応じて TRUE/FALSE。
setOptionalVersion
- void setOptionalVersion(boolean isOptionalVersion)
- オプションのバージョンが設定されているかどうかを設定します。
パラメーター: isOptionalVersion - オプションのバージョンが設定されているかどうか。
getTargetPathRelativeToTopProject
- String getTargetPathRelativeToTopProject()
- 最上位プロジェクトへの相対ターゲット・パスを取得します。
戻り値: Rational Synergy リポジトリーの最上位プロジェクトへの相対ターゲット・パス。