// $HeadURL$
// $Id$
//
// Copyright © 2006, 2010, 2011, 2012 by the President and Fellows of Harvard College.
//
// Screensaver is an open-source project developed by the ICCB-L and NSRB labs
// at Harvard Medical School. This software is distributed under the terms of
// the GNU General Public License.

package edu.harvard.med.screensaver.ui.arch.datatable.column;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import javax.faces.convert.Converter;
import javax.faces.model.SelectItem;

public abstract class VocabularyColumn<R,V> extends TableColumn<R,V> implements HasVocabulary<V>
{
  private Set<V> _items;
  private ArrayList<SelectItem> _selectItems;

  /**
   * 
   * Constructs a VocabularyColumn object.
   * @param name
   * @param description
   * @param group
   * @param converter
   * @param items will be used for getVocabularySelections; which populates the displayed values ( <option> )in the <selectItems> element,
   *        this will be converted by the Converter.getAsString() method to a "model" value, which is then used for the 
   *        "value" portion of the <option> element of the <selectItems>.  see criterion.xhtml
   */
  public VocabularyColumn(String name,
                          String description,
                          String group,
                          Converter converter, 
                          Set<V> items)
  {
    super(name, description, ColumnType.VOCABULARY, group);
    setConverter(converter);
    _items = new LinkedHashSet<V>(items);
  }

  public VocabularyColumn(String name,
                          String description,
                          String group,
                          Converter converter, V[] items)
  {
    this(name, description, group, converter, new LinkedHashSet<V>(Arrays.asList(items)));
  }

  public Set<V> getVocabulary()
  {
    return _items;
  }

  public List<SelectItem> getVocabularySelections()
  {
    if (_selectItems == null) {
      _selectItems = new ArrayList<SelectItem>();
      _selectItems.add(new SelectItem("", ""));
      for (V v : getVocabulary()) {
        _selectItems.add(new SelectItem(v));
      }
    }
    return _selectItems;
  }
}