Mapper (javadoc-im_master

既知のサブインタフェースのリスト:

CategoryDetailMapper, CateogryClassMapper, CompanyCategoryMapper, CompanyMapper, CompanyPostMapper, CompanyVersionMapper, DealDetailMapper, DealerDepartmentMapper, DealerPublicGroupMapper, DealerRoleMapper, DealMapper, DepartmentAttachMapper, DepartmentInclusionMapper, DepartmentMainMapper, DepartmentMapper, ItemAttachMapper, ItemAttributeMapper, ItemCatalogueMapper, ItemCategoryMapper, ItemCategoryTypeMapper, ItemMapper, ItemTemplateDetailMapper, ItemTemplateMapper, PrivateGroupAttachMapper, PrivateGroupMapper, PublicGroupAttachMapper, PublicGroupCategoryMapper, PublicGroupInclusionMapper, PublicGroupMapper, PublicGroupSetMapper, PublicGroupVersionMapper, UnitMapper, UserMapper

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

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

非推奨です。
代替クラスはありません。
```
public interface Mapper
```
エンティティの情報のマッパーです。実際に永続化されるデータとJavaのクラスを対応付けます。一度close()メソッドが呼ばれると、isClosed()以外のメソッドはすべて例外をthrowします。

導入されたバージョン:

5.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`checkByBaseProperty(Relationship[] relationships, BaseModel target, BaseModel base)` 非推奨です。代替メソッドはありません。
`void`	`close()` 非推奨です。代替メソッドはありません。
`BaseModel`	`createBaseModel(Map keys)` 非推奨です。代替メソッドはありません。
`void`	`init(String user, String group)` 非推奨です。代替メソッドはありません。
`boolean`	`isClosed()` 非推奨です。代替メソッドはありません。
`void`	`notifyDelete(Relationship relationship, BaseModel model)` 非推奨です。代替メソッドはありません。
`void`	`notifyUpdate(Relationship relationship, BaseModel model)` 非推奨です。代替メソッドはありません。
`BaseModel`	`select(Map keys)` 非推奨です。代替メソッドはありません。

- メソッドの詳細
  - init
```
void init(String user,
          String group)
   throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    マッパーを初期化します。マッパーを生成する場合は、このメソッドを必ず呼び出して下さい。
    
    パラメータ:
    
    user - ログインユーザ
    
    group - ログイングループ名
    
    例外:
    
    MapperException - マッパーの初期化に失敗した場合
  - createBaseModel
```
BaseModel createBaseModel(Map keys)
                   throws MapperException
```
    非推奨です。代替メソッドはありません。
    このマッパーに該当する基本モデルを新規に生成します。モデルを新規に生成することができるのはこのメソッドだけです。このメソッドで生成されたモデルは次の状態になります。
    - 指定されたプライマリキーが設定済
    - 該当するエンティティが国際化されている場合は、国際化モデルが1つだけ存在
      
      ロケールはデフォルトロケール
    - 該当するエンティティが期間化されている場合は、期間化モデルが1つだけ存在
      
      有効開始日は期間の最小日時 (1582/10/15)
      有効終了日は期間の最大日時 (9999/12/31)
    - 該当するエンティティが期間国際化されている場合は、期間国際化モデルが1つだけ存在
      
      ロケールはデフォルトロケール
      有効開始日は期間の最小日時 (1582/10/15)
      有効終了日は期間の最大日時 (9999/12/31)
    パラメータ:
    
    keys - 項目名とその値を持つプライマリキーのマップ
    
    戻り値:
    
    プライマリキーが設定された基本モデル
    
    例外:
    
    MapperException - モデルの生成に失敗した場合
  - select
```
BaseModel select(Map keys)
          throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    プライマリーキーで特定される基本モデルを取得します。取得される基本モデルには、国際化されている場合にはすべての言語情報、期間化されている場合にはすべての期間情報が設定されます。また、基本モデル BaseModel、国際化モデル InternationalModel、期間化モデル TerminableModel、期間国際化モデル TerminableInternationalModel にはすべてのプロパティが設定されます。
    
    パラメータ:
    
    keys - 項目名とその値を持つプライマリキーのマップ
    
    戻り値:
    
    基本モデル
    
    例外:
    
    MapperException - 検索で例外が発生した場合
  - notifyUpdate
```
void notifyUpdate(Relationship relationship,
                  BaseModel model)
           throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    リレーションシップで定義された参照先基本モデルが更新されたことを通知します。引数で指定されたリレーションシップ Relationship の参照先基本モデル BaseModel が更新された場合に、このメソッドを呼び出してその内容を通知します。マッパー Mapper は参照先モデルの更新内容と整合性をとるために、それを参照する基本モデルの内容を更新します。
    
    パラメータ:
    
    relationship - リレーションシップ
    
    model - 参照先基本モデル
    
    例外:
    
    MapperException - 更新通知先で何らかの例外が発生した場合
  - notifyDelete
```
void notifyDelete(Relationship relationship,
                  BaseModel model)
           throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    リレーションシップで定義された参照先基本モデルが削除されたことを通知します。引数で指定されたリレーションシップ Relationship の参照先基本モデル BaseModel が削除された場合にその内容を通知します。マッパー Mapper は削除されたモデルを参照する基本モデルに対して、整合性を守るための更新を行います。
    
    パラメータ:
    
    relationship - リレーションシップ
    
    model - 参照先基本モデル
    
    例外:
    
    MapperException - 更新通知先で何らかの例外が発生した場合
  - checkByBaseProperty
```
void checkByBaseProperty(Relationship[] relationships,
                         BaseModel target,
                         BaseModel base)
                  throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    基準項目によるリレーションシップの整合性制約をチェックします。リレーションシップ Relationship には、基準項目を参照するリレーションシップを参照元とするエンティティ Entity までたどるためのリレーションシップの集合を設定します。基本モデル BaseModel は、基準項目をプロパティにもつ基本モデルを設定します。
    
    パラメータ:
    
    relationships - リレーションシップの集合
    
    target - 参照先基本モデル
    
    base - 基準項目をもつ基本モデル
    
    例外:
    
    MapperException - 基準項目によるチェックで何らかの例外が発生した場合
  - close
```
void close()
    throws MapperException
```
    非推奨です。代替メソッドはありません。
    
    マッパーをクローズします。このメソッドはトランザクションが終了される前に必ず呼び出される必要があります。このメソッドが呼ばれると、マッパーは再利用できなくなります。また、このマッパーから取得されたモデルの更新もできなくなります。
    
    例外:
    
    MapperException - マッパーがすでにクローズされている場合
  - isClosed
```
boolean isClosed()
```
    非推奨です。代替メソッドはありません。
    
    マッパーがクローズされているかどうか確認します。
    
    戻り値:
    
    クローズされている場合 true 、そうでなければ false

インタフェース Mapper

メソッドのサマリー

メソッドの詳細

init

createBaseModel

select

notifyUpdate

notifyDelete

checkByBaseProperty

close

isClosed