/*
 * Header 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.io.Serializable;
import java.util.Enumeration;
import java.util.Map;

/**
 * テーブルのカラム・キーを格納するヘッダ・オブジェクトのインターフェイス。
 * <br>
 * カラム数やカラム・キーを取得するためのメソッド、レコードを作成するメソッド
 * の宣言を提供する。
 * <br>
 * <br>
 * ヘッダからカラム・キーを削除するためのメソッドは用意されていない。
 *
 * @param <C> カラム・キーのタイプ。
 *
 * @author  佐藤隆之.
 * @version $Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:51 $
 */
public interface Header<C> extends Cloneable, Serializable
{
  /**
   * このヘッダに格納されているカラム・キーの数を取得する。
   *
   * @return カラム・キーの数。
   */
  int columnCount();

  /**
   * このヘッダに格納されているカラム・キーを順に取得するためのイテレータを
   * 取得する。
   *
   * @return  カラム・キーのイテレータ。
   */
  Enumeration<C> columns();

  /**
   * 指定されたオブジェクトと同じカラム・キーがこのヘッダに格納されているか
   * どうかを確認する。
   *
   * @param  column カラム・キー。
   * @return 指定されたカラム・キーがこのオブジェクトに格納されている場合は
   *         <tt>true</tt>を返す。
   */
  boolean hasColumn(Object column);

  /**
   * カラム・キーを追加する。
   *
   * @param  column カラム・キー。
   */
  void addColumn(C column);
}

