org.iplass.mtp.entity.definition

インタフェース EntityDefinitionManager

すべてのスーパーインタフェース:

Manager, TypedDefinitionManager<EntityDefinition>

既知の実装クラスのリスト:

EntityDefinitionManagerImpl

public interface EntityDefinitionManager
extends TypedDefinitionManager<EntityDefinition>

Entity定義を管理するクラスのインタフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
EntityDefinitionModifyResult	create(EntityDefinition definition) 新規にEntity定義を作成する。
java.util.List<java.lang.String>	definitionList() 現在登録されているEntity定義名のリストを返す。
java.util.List<DefinitionSummary>	definitionNameList() 現在登録されているEntity定義名のリストを返す。
java.util.List<DefinitionSummary>	definitionNameList(java.lang.String filterPath) 現在登録されているEntity定義名のリストを返す。
EntityDefinition	get(java.lang.String definitionName) 指定の定義名のEntity定義を取得する。
long	getAutoNumberCurrentValue(java.lang.String definitionName, java.lang.String propertyName) AutoNumberPropertyの現在のカウンター値を返す。
long	getAutoNumberCurrentValue(java.lang.String definitionName, java.lang.String propertyName, java.lang.String subUnitKey) AutoNumberPropertyの現在のカウンター値を返す。
java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Long>>	getAutoNumberCurrentValueList(java.lang.String definitionName, java.lang.String propertyName) AutoNumberPropertyの現在のカウンター値のリストを返す。
java.util.List<java.lang.String>	getStorageSpaceList() 現在登録されているEntity Storage Spaceのリストを返す。
boolean	isLockedSchema(java.lang.String definitionName) スキーマがロックされているかを返す。
EntityDefinitionModifyResult	remove(java.lang.String definitionName) 指定の定義名のEntityを削除する。
void	renameEntityDefinition(java.lang.String from, java.lang.String to) Entity定義名を変更する。
void	renamePropertyDefinition(java.lang.String definitionName, java.lang.String from, java.lang.String to) Entity定義のプロパティ名を変更する。
void	resetAutoNumberCounter(java.lang.String definitionName, java.lang.String propertyName, long startsWith) AutoNumberPropertyのカウンター値を指定の値にリセットする。
void	resetAutoNumberCounter(java.lang.String definitionName, java.lang.String propertyName, java.lang.String subUnitKey, long startsWith) AutoNumberPropertyのカウンター値を指定の値にリセットする。
EntityDefinitionModifyResult	update(EntityDefinition definition) 指定のEntity定義で既存の定義を更新する。
EntityDefinitionModifyResult	update(EntityDefinition definition, java.util.Map<java.lang.String,java.lang.String> renamePropertyMap) 指定のEntity定義で既存の定義を更新する。

インタフェースから継承されたメソッド org.iplass.mtp.definition.TypedDefinitionManager

definitionSummaryList, definitionSummaryList, definitionSummaryList, getDefinitionType, rename

メソッドの詳細

create

EntityDefinitionModifyResult create(EntityDefinition definition)

新規にEntity定義を作成する。

定義:

create インタフェース内 TypedDefinitionManager<EntityDefinition>

パラメータ:

definition - 新規に作成するEntityの定義

戻り値:

作成結果

get

EntityDefinition get(java.lang.String definitionName)

指定の定義名のEntity定義を取得する。

定義:

get インタフェース内 TypedDefinitionManager<EntityDefinition>

パラメータ:

definitionName - 定義名

戻り値:

指定の定義名で一意に特定されるEntity定義

definitionList

java.util.List<java.lang.String> definitionList()

現在登録されているEntity定義名のリストを返す。

定義:

definitionList インタフェース内 TypedDefinitionManager<EntityDefinition>

戻り値:

Entity定義名のリスト

definitionNameList

java.util.List<DefinitionSummary> definitionNameList()

現在登録されているEntity定義名のリストを返す。

戻り値:

Entity定義名(Name, DisplayName, Description)のリスト

definitionNameList

java.util.List<DefinitionSummary> definitionNameList(java.lang.String filterPath)

現在登録されているEntity定義名のリストを返す。

パラメータ:

filterPath - "/"区切りのdefinitionNameのプレフィックス（Entity関連の定義は.区切りでも可）

戻り値:

Entity定義名(Name, DisplayName, Description)のリスト

remove

EntityDefinitionModifyResult remove(java.lang.String definitionName)

指定の定義名のEntityを削除する。

定義:

remove インタフェース内 TypedDefinitionManager<EntityDefinition>

パラメータ:

definitionName - 定義名

戻り値:

削除結果

update

EntityDefinitionModifyResult update(EntityDefinition definition)

指定のEntity定義で既存の定義を更新する。 （定義名の一致する定義を更新する。）

定義:

update インタフェース内 TypedDefinitionManager<EntityDefinition>

パラメータ:

definition - 更新するEntity定義

戻り値:

更新結果

update

EntityDefinitionModifyResult update(EntityDefinition definition,
                                    java.util.Map<java.lang.String,java.lang.String> renamePropertyMap)

指定のEntity定義で既存の定義を更新する。 （定義名の一致する定義を更新する。）

パラメータ:

definition - 更新するEntity定義

renamePropertyMap - 名前を変更するプロパティのMap(from, to)

戻り値:

更新結果

getAutoNumberCurrentValue

long getAutoNumberCurrentValue(java.lang.String definitionName,
                               java.lang.String propertyName)

AutoNumberPropertyの現在のカウンター値を返す。

パラメータ:

definitionName - Entity定義名

propertyName - AutoNumberProperty型プロパティのプロパティ名

戻り値:

現在のカウンター値

getAutoNumberCurrentValueList

java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Long>> getAutoNumberCurrentValueList(java.lang.String definitionName,
                                                                                                                   java.lang.String propertyName)

AutoNumberPropertyの現在のカウンター値のリストを返す。

パラメータ:

definitionName - Entity定義名

propertyName - AutoNumberProperty型プロパティのプロパティ名

戻り値:

現在のカウンター値のリスト

getAutoNumberCurrentValue

long getAutoNumberCurrentValue(java.lang.String definitionName,
                               java.lang.String propertyName,
                               java.lang.String subUnitKey)

AutoNumberPropertyの現在のカウンター値を返す。

パラメータ:

definitionName - Entity定義名

propertyName - AutoNumberProperty型プロパティのプロパティ名

subUnitKey - 採番単位のKEY値

戻り値:

現在のカウンター値

resetAutoNumberCounter

void resetAutoNumberCounter(java.lang.String definitionName,
                            java.lang.String propertyName,
                            long startsWith)

AutoNumberPropertyのカウンター値を指定の値にリセットする。

パラメータ:

definitionName - Entity定義名

propertyName - AutoNumberProperty型プロパティのプロパティ名

subUnitKey - 採番単位のKEY値

startsWith - リセットするカウンター値

resetAutoNumberCounter

void resetAutoNumberCounter(java.lang.String definitionName,
                            java.lang.String propertyName,
                            java.lang.String subUnitKey,
                            long startsWith)

AutoNumberPropertyのカウンター値を指定の値にリセットする。

パラメータ:

definitionName - Entity定義名

propertyName - AutoNumberProperty型プロパティのプロパティ名

subUnitKey - 採番単位のKEY値

startsWith - リセットするカウンター値

renameEntityDefinition

void renameEntityDefinition(java.lang.String from,
                            java.lang.String to)

Entity定義名を変更する。 データ自体はそのまま保持される。

パラメータ:

from - 変更前の定義名

to - 変更後の定義名

renamePropertyDefinition

void renamePropertyDefinition(java.lang.String definitionName,
                              java.lang.String from,
                              java.lang.String to)

Entity定義のプロパティ名を変更する。 データ自体はそのまま保持される。

パラメータ:

definitionName - 対象のEntity定義名

from - 変更前のプロパティ名

to - 変更後のプロパティ名

getStorageSpaceList

java.util.List<java.lang.String> getStorageSpaceList()

現在登録されているEntity Storage Spaceのリストを返す。

戻り値:

Entity Entity Storage Spaceのリスト

isLockedSchema

boolean isLockedSchema(java.lang.String definitionName)

スキーマがロックされているかを返す。

パラメータ:

definitionName - 対象のEntity定義名

戻り値:

true：ロック