/*
 * Constraint class.
 *
 * Copyright (C) 2007 SATOH Takayuki All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package ts.util.table;

import java.util.Map;
import java.io.Serializable;

/**
 * テーブルの制約条件のチェックを実行する。
 * <br>
 * チェック処理は、このクラスを継承したクラスで{@link
 * #check(Trigger.Action, Table, java.util.Map) check}メソッドをオーバーライド
 * して実装する。
 * <br>
 * {@link #check(Trigger.Action, Table, java.util.Map) check}メソッドは、{@link 
 * ts.util.table.ConstraintTrigger ConstraintTrigger}オブジェクトに登録し、その
 * {@link ts.util.table.ConstraintTrigger#preAppend(Table, java.util.Map)
 * preAppend}、{@link ts.util.table.ConstraintTrigger#preUpdate(Table,
 * java.util.Map, java.util.Map) preUpdate}、{@link
 * ts.util.table.ConstraintTrigger#preDelete(Table, java.util.Map) preDelete}
 * メソッドのいずれかから呼ばれる。
 *
 * @param  <C>  テーブルのカラム・キーのタイプ。
 * @param  <V>  テーブルのカラム値のタイプ。
 *
 * @author  佐藤隆之.
 * @version $Revision: 1.3 $, $Date: 2011-08-01 15:29:33 $
 */
public abstract class Constraint<C,V> implements Serializable
{
  /**
   * デフォルトコンストラクタ。
   */
  public Constraint()
  {}

  /**
   * 制約条件のチェックを実行する。
   * <br>
   * チェックの結果が制約違反の場合は、例外をスローする。
   *
   * @param  action 変更の種類。
   * @param  table  テーブル・オブジェクト。
   * @param  record 変更されるレコード・オブジェクト。
   * @throws ConstraintViolationException チェックの結果が制約
   *         違反だった場合。
   */
  protected abstract void check(Trigger.Action action, Table<C,V> table,
    Map<C,V> record) throws ConstraintViolationException;
}

