jp.co.intra_mart.foundation.datastore.common.model

クラス IntramartDBMapper

java.lang.Object

jp.co.intra_mart.foundation.datastore.common.model.IntramartDBMapper

すべての実装されたインタフェース:

Mapper

直系の既知のサブクラス:

CategoryDetailIntramartDBMapper, CateogryClassIntramartDBMapper, CompanyCategoryIntramartDBMapper, CompanyIntramartDBMapper, CompanyPostIntramartDBMapper, CompanyVersionIntramartDBMapper, DealDetailIntramartDBMapper, DealerDepartmentIntramartDBMapper, DealerPublicGroupIntramartDBMapper, DealerRoleIntramartDBMapper, DealIntramartDBMapper, DepartmentAttachIntramartDBMapper, DepartmentInclusionIntramartDBMapper, DepartmentIntramartDBMapper, DepartmentMainIntramartDBMapper, ItemAttachIntramartDBMapper, ItemAttributeIntramartDBMapper, ItemCatalogueIntramartDBMapper, ItemCategoryIntramartDBMapper, ItemCategoryTypeIntramartDBMapper, ItemIntramartDBMapper, ItemTemplateDetailIntramartDBMapper, ItemTemplateIntramartDBMapper, PrivateGroupAttachIntramartDBMapper, PrivateGroupIntramartDBMapper, PublicGroupAttachIntramartDBMapper, PublicGroupCategoryIntramartDBMapper, PublicGroupInclusionIntramartDBMapper, PublicGroupIntramartDBMapper, PublicGroupSetIntramartDBMapper, PublicGroupVersionIntramartDBMapper, UnitIntramartDBMapper, UserIntramartDBMapper

非推奨です。

代替クラスはありません。

public abstract class IntramartDBMapper
extends Object
implements Mapper

intra-martで管理されるデータベースにアクセスするマッパーの汎用的な抽象クラスです。

導入されたバージョン:

5.0

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
IntramartDBMapper() 非推奨です。 代替メソッドはありません。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	checkByBaseProperty(Relationship[] relationships, BaseModel target, BaseModel base) 非推奨です。 代替メソッドはありません。
void	close() 非推奨です。 代替メソッドはありません。
protected BaseAccessor	createBaseAccessor(Map primary) 非推奨です。 代替メソッドはありません。
BaseModel	createBaseModel(Map keys) 非推奨です。 代替メソッドはありません。
protected void	delete(BaseModel model) 非推奨です。 代替メソッドはありません。
protected void	delete(Collection models) 非推奨です。 代替メソッドはありません。
protected abstract String	getApplicationName() 非推奨です。 代替メソッドはありません。
protected abstract String	getEntityName() 非推奨です。 代替メソッドはありません。
void	init(String user, String group) 非推奨です。 代替メソッドはありません。
protected void	insert(BaseModel model) 非推奨です。 代替メソッドはありません。
protected void	insert(Collection models) 非推奨です。 代替メソッドはありません。
boolean	isClosed() 非推奨です。 代替メソッドはありません。
void	notifyDelete(Relationship relationship, BaseModel model) 非推奨です。 代替メソッドはありません。
void	notifyUpdate(Relationship relationship, BaseModel model) 非推奨です。 代替メソッドはありません。
BaseModel	select(Map keys) 非推奨です。 代替メソッドはありません。
protected Collection	select(Relationship relationship, Map keys) 非推奨です。 代替メソッドはありません。
protected void	update(BaseModel model) 非推奨です。 代替メソッドはありません。
protected void	update(Collection models) 非推奨です。 代替メソッドはありません。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

IntramartDBMapper

public IntramartDBMapper()

非推奨です。 代替メソッドはありません。

コンストラクタ

メソッドの詳細

init

public void init(String user,
                 String group)
          throws MapperException

非推奨です。 代替メソッドはありません。

マッパーを初期化します。 マッパーを生成する場合は、このメソッドを必ず呼び出して下さい。

定義:

init インタフェース内 Mapper

パラメータ:

user - ログインユーザID

group - ログイングループID

例外:

MapperException - マッパーの初期化に失敗した場合

createBaseAccessor

protected BaseAccessor createBaseAccessor(Map primary)
                                   throws MapperException

非推奨です。 代替メソッドはありません。

このマッパーに該当する基本アクセサを新規に生成します。 アクセサはコンストラクタではなくこの新規生成系メソッドでのみ生成します。このメソッドで生成されたアクセサは次の状態です。

• 指定された（または自動的に割り当てられた）プライマリキーが設定済
• 国際化モデルが1つだけ存在
  • ロケールはデフォルトロケール
• 期間化アクセサが1つだけ存在
  • 有効開始日は期間の最小日時 (1582/10/15|00:00:00)
  • 有効終了日は期間の最大日時 (9999/12/31|23:59:59)
• 期間国際化アクセサが1つだけ存在
  • ロケールはデフォルトロケール
  • 有効開始日は期間の最小日時 (1582/10/15|00:00:00)
  • 有効終了日は期間の最大日時 (9999/12/31|23:59:59)

パラメータ:

primary - 基本アクセサのプライマリキー

戻り値:

基本アクセサ

例外:

MapperException

createBaseModel

public BaseModel createBaseModel(Map keys)
                          throws MapperException

非推奨です。 代替メソッドはありません。

このマッパーに該当する基本モデルを新規に生成します。 モデルを新規に生成することができるのはこのメソッドだけです。このメソッドで生成されたモデルは次の状態になります。

• 指定されたプライマリキーが設定済
• 該当するエンティティが国際化されている場合は、国際化モデルが1つだけ存在
  • ロケールはデフォルトロケール
• 該当するエンティティが期間化されている場合は、期間化モデルが1つだけ存在
  • 有効開始日は期間の最小日時 (1582/10/15|00:00:00)
  • 有効終了日は期間の最大日時 (9999/12/31|23:59:59)
• 該当するエンティティが期間国際化されている場合は、期間国際化モデルが1つだけ存在
  • ロケールはデフォルトロケール
  • 有効開始日は期間の最小日時 (1582/10/15|00:00:00)
  • 有効終了日は期間の最大日時 (9999/12/31|23:59:59)
  このメソッドで生成されたモデルはまだデータベースには反映されていません。データベースに反映するためには以下のデータ更新系のAPIを使用します。
  • insert(BaseModel)
  • insert(Collection)
  • update(BaseModel)
  • update(Collection)
  • delete(BaseModel)
  • delete(Collection)

定義:

createBaseModel インタフェース内 Mapper

パラメータ:

keys - 項目名とその値を持つプライマリキーのマップ

戻り値:

プライマリキーが設定された基本モデル

例外:

MapperException - モデルの生成に失敗した場合

select

public BaseModel select(Map keys)
                 throws MapperException

非推奨です。 代替メソッドはありません。

プライマリーキーで特定される基本モデルを取得します。 取得される基本モデルには、国際化されている場合にはすべての言語情報、期間化されている場合にはすべての期間情報が設定されます。 また、基本モデル BaseModel、国際化モデル InternationalModel、期間化モデル TerminableModel、 期間国際化モデル TerminableInternationalModel にはすべてのプロパティが設定されます。
プライマリーキーに一致するデータが存在しない場合は、null を返します。

定義:

select インタフェース内 Mapper

パラメータ:

keys - 項目名とその値を持つプライマリキーのマップ

戻り値:

基本モデル

例外:

MapperException - モデルの取得に失敗した場合

select

protected Collection select(Relationship relationship,
                            Map keys)
                     throws MapperException

非推奨です。 代替メソッドはありません。

外部キーで特定される基本モデルをすべて取得します。 外部キーによる検索条件に一致する基本モデル BaseModel のコレクション Collection が取得されます。
検索条件に一致するデータが存在しない場合は、空のコレクションを返します。

パラメータ:

relationship - 検索する基本モデルの外部キー項目を定義したリレーションシップ

keys - 検索条件

戻り値:

基本モデルのコレクション

例外:

MapperException - 基本モデルの取得に失敗した場合

insert

protected void insert(BaseModel model)
               throws MapperException

非推奨です。 代替メソッドはありません。

基本モデルを1つだけ挿入します。 引数に指定する基本モデルは同一の Mapperの createBaseAccessor(Map) で生成されたものである必要があります。

パラメータ:

model - 挿入するモデル

例外:

MapperException - 基本モデルの挿入に失敗した場合

insert

protected void insert(Collection models)
               throws MapperException

非推奨です。 代替メソッドはありません。

基本モデルを複数挿入します。 引数に指定するものは同一の Mapperの createBaseAccessor(Map) で生成されたアクセサの集合である必要があります。

パラメータ:

models - 挿入する基本モデルの集合

例外:

MapperException - 基本モデルの挿入に失敗した場合

update

protected void update(BaseModel model)
               throws MapperException

非推奨です。 代替メソッドはありません。

基本モデルを1つだけ更新します。 引数に指定するアクセサは同一の Mapperの select 系メソッドから取得されたものか createBaseAccessor(Map) で生成されたものである必要があります。期間が重複するデータが存在する場合、指定したアクセサが最優先されるように期間が調節された上で上書きします。

パラメータ:

model - 更新する基本モデル

例外:

MapperException - 基本モデルの更新に失敗した場合

update

protected void update(Collection models)
               throws MapperException

非推奨です。 代替メソッドはありません。

基本モデルを複数更新します。 引数に指定するものは同一の Mapperの select 系メソッドから取得されたものか createBaseAccessor(Map) で生成された基本モデルの集合である必要があります。

パラメータ:

models - 更新する基本モデルの集合

例外:

MapperException - 基本モデルの更新に失敗した場合

delete

protected void delete(BaseModel model)
               throws MapperException

非推奨です。 代替メソッドはありません。

基本モデルを1つだけ削除します。 引数で指定された基本モデルに該当するデータのすべての期間の情報を削除します。引数に指定する基本モデルは同一の Mapperの select 系メソッド から取得されたものである必要があります。

パラメータ:

model - 削除するアクセサ

例外:

MapperException - 基本モデルの削除に失敗した場合

delete

protected void delete(Collection models)
               throws MapperException

非推奨です。 代替メソッドはありません。

アクセサを複数削除します。 引数で指定されたものに該当するデータのすべての期間の情報を削除します。引数に指定するアクセサは同一の Mapperの select 系メソッド から取得されたアクセサの集合である必要があります。

パラメータ:

models - 削除するアクセサ

例外:

MapperException - 基本モデルの削除に失敗した場合

notifyUpdate

public void notifyUpdate(Relationship relationship,
                         BaseModel model)
                  throws MapperException

非推奨です。 代替メソッドはありません。

リレーションシップで定義された参照先基本モデルが更新されたことを通知します。 引数で指定されたリレーションシップ Relationship の参照先基本モデル BaseModel が更新された場合に、このメソッドを呼び出してその内容を通知します。 マッパー Mapper は参照先モデルの更新内容と整合性をとるために、それを参照する基本モデルの内容を更新します。

定義:

notifyUpdate インタフェース内 Mapper

パラメータ:

relationship - リレーションシップ

model - 参照先基本モデル

例外:

MapperException - 更新通知先で何らかの例外が発生した場合

notifyDelete

public void notifyDelete(Relationship relationship,
                         BaseModel model)
                  throws MapperException

非推奨です。 代替メソッドはありません。

リレーションシップで定義された参照先基本モデルが削除されたことを通知します。 引数で指定されたリレーションシップ Relationship の参照先基本モデル BaseModel が削除された場合にその内容を通知します。 マッパー Mapper は削除されたモデルを参照する基本モデルに対して、整合性を守るための更新を行います。

定義:

notifyDelete インタフェース内 Mapper

パラメータ:

relationship - リレーションシップ

model - 参照先基本モデル

例外:

MapperException - 更新通知先で何らかの例外が発生した場合

checkByBaseProperty

public void checkByBaseProperty(Relationship[] relationships,
                                BaseModel target,
                                BaseModel base)
                         throws MapperException

非推奨です。 代替メソッドはありません。

基準項目によるリレーションシップの整合性制約をチェックします。 整合性制約違反が存在する場合は、MapperException をスローします。 リレーションシップ Relationship には、基準項目を参照するリレーションシップを参照元とするエンティティ Entity まで たどるためのリレーションシップの集合を設定します。

定義:

checkByBaseProperty インタフェース内 Mapper

パラメータ:

relationships - リレーションシップの集合

target - 参照先基本モデル

base - 基準項目をもつ基本モデル

例外:

MapperException - 基準項目によるチェックで制約違反があった場合

close

public void close()
           throws MapperException

非推奨です。 代替メソッドはありません。

マッパーをクローズします。 このメソッドはトランザクションが終了される前に必ず呼び出される必要があります。 このメソッドが呼ばれると、マッパーは再利用できなくなります。 また、このマッパーから取得されたモデルの更新もできなくなります。

定義:

close インタフェース内 Mapper

例外:

MapperException - マッパーがすでにクローズされている場合

getApplicationName

protected abstract String getApplicationName()

非推奨です。 代替メソッドはありません。

マッパーが定義されているアプリケーション名を取得します。

戻り値:

アプリケーション名

getEntityName

protected abstract String getEntityName()

非推奨です。 代替メソッドはありません。

マッパーがアクセスするエンティティ名を取得します。

戻り値:

エンティティ名

isClosed

public boolean isClosed()

非推奨です。 代替メソッドはありません。

マッパーがクローズされているかどうか確認します。

定義:

isClosed インタフェース内 Mapper

戻り値:

クローズされている場合 true 、そうでなければ false