content: /*
   *    This program is free software; you can redistribute it and/or modify
   *    it under the terms of the GNU General Public License as published by
   *    the Free Software Foundation; either version 2 of the License, or
   *    (at your option) any later version.
   *
   *    This program 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 General Public License for more details.
   *
   *    You should have received a copy of the GNU General Public License
   *    along with this program; if not, write to the Free Software
   *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   */
  
  /*
   *    Add.java
   *    Copyright (C) 1999 University of Waikato, Hamilton, New Zealand
   *
   */
  
  
  package weka.filters.unsupervised.attribute;
  
  import weka.core.Attribute;
  import weka.core.Capabilities;
  import weka.core.FastVector;
  import weka.core.Instance; 
  import weka.core.DenseInstance;
  import weka.core.Instances;
  import weka.core.Option;
  import weka.core.OptionHandler;
  import weka.core.Range;
  import weka.core.RevisionUtils;
  import weka.core.SelectedTag;
  import weka.core.SingleIndex;
  import weka.core.Tag;
  import weka.core.Utils;
  import weka.core.Capabilities.Capability;
  import weka.filters.Filter;
  import weka.filters.StreamableFilter;
  import weka.filters.UnsupervisedFilter;
  
  import java.text.SimpleDateFormat;
  import java.util.Enumeration;
  import java.util.Vector;
  
  /** 
   <!-- globalinfo-start -->
   * An instance filter that adds a new attribute to the dataset. The new attribute will contain all missing values.
   * <p/>
   <!-- globalinfo-end -->
   * 
   <!-- options-start -->
   * Valid options are: <p/>
   * 
   * <pre> -T &lt;NUM|NOM|STR|DAT&gt;
   *  The type of attribute to create:
   *  NUM = Numeric attribute
   *  NOM = Nominal attribute
   *  STR = String attribute
   *  DAT = Date attribute
   *  (default: NUM)</pre>
   * 
   * <pre> -C &lt;index&gt;
   *  Specify where to insert the column. First and last
   *  are valid indexes.(default: last)</pre>
   * 
   * <pre> -N &lt;name&gt;
   *  Name of the new attribute.
   *  (default: 'Unnamed')</pre>
   * 
   * <pre> -L &lt;label1,label2,...&gt;
   *  Create nominal attribute with given labels
   *  (default: numeric attribute)</pre>
   * 
   * <pre> -F &lt;format&gt;
   *  The format of the date values (see ISO-8601)
   *  (default: yyyy-MM-dd'T'HH:mm:ss)</pre>
   * 
   <!-- options-end -->
   *
   * @author Len Trigg (trigg@cs.waikato.ac.nz)
   * @version $Revision: 5987 $
   */
  public class Add 
    extends Filter 
    implements UnsupervisedFilter, StreamableFilter, OptionHandler {
    
    /** for serialization. */
    static final long serialVersionUID = 761386447332932389L;
  
    /** the attribute type. */
    public static final Tag[] TAGS_TYPE = {
      new Tag(Attribute.NUMERIC, "NUM", "Numeric attribute"),
      new Tag(Attribute.NOMINAL, "NOM", "Nominal attribute"),
      new Tag(Attribute.STRING,  "STR", "String attribute"),
      new Tag(Attribute.DATE,    "DAT", "Date attribute")
    };
    
    /** Record the type of attribute to insert. */
    protected int m_AttributeType = Attribute.NUMERIC;
  
    /** The name for the new attribute. */
    protected String m_Name = "unnamed";
  
    /** The location to insert the new attribute. */
    private SingleIndex m_Insert = new SingleIndex("last"); 
  
    /** The list of labels for nominal attribute. */
    protected FastVector m_Labels = new FastVector();
  
    /** The date format. */
    protected String m_DateFormat = "yyyy-MM-dd'T'HH:mm:ss";
    
    /**
     * Returns a string describing this filter.
     *
     * @return a description of the filter suitable for
     * displaying in the explorer/experimenter gui
     */
    public String globalInfo() {
  
      return "An instance filter that adds a new attribute to the dataset."
        + " The new attribute will contain all missing values.";
    }
  
    /**
     * Returns an enumeration describing the available options.
     *
     * @return an enumeration of all the available options.
     */
    public Enumeration listOptions() {
      Vector 		newVector;
      String		desc;
      SelectedTag		tag;
      int			i;
  
      newVector = new Vector();
  
      desc  = "";
      for (i = 0; i < TAGS_TYPE.length; i++) {
        tag = new SelectedTag(TAGS_TYPE[i].getID(), TAGS_TYPE);
        desc  +=   "\t" + tag.getSelectedTag().getIDStr() 
        	       + " = " + tag.getSelectedTag().getReadable()
        	       + "\n";
      }
      newVector.addElement(new Option(
  	"\tThe type of attribute to create:\n"
  	+ desc
  	+"\t(default: " + new SelectedTag(Attribute.NUMERIC, TAGS_TYPE) + ")",
  	"T", 1, "-T " + Tag.toOptionList(TAGS_TYPE)));
  
      newVector.addElement(new Option(
  	"\tSpecify where to insert the column. First and last\n"
  	+"\tare valid indexes.(default: last)",
  	"C", 1, "-C <index>"));
  
      newVector.addElement(new Option(
  	"\tName of the new attribute.\n"
  	+"\t(default: 'Unnamed')",
  	"N", 1,"-N <name>"));
      
      newVector.addElement(new Option(
  	"\tCreate nominal attribute with given labels\n"
  	+"\t(default: numeric attribute)",
  	"L", 1, "-L <label1,label2,...>"));
  
      newVector.addElement(new Option(
  	"\tThe format of the date values (see ISO-8601)\n"
  	+"\t(default: yyyy-MM-dd'T'HH:mm:ss)",
  	"F", 1, "-F <format>"));
  
      return newVector.elements();
    }
  
  
    /**
     * Parses a given list of options. <p/>
     * 
     <!-- options-start -->
     * Valid options are: <p/>
     * 
     * <pre> -T &lt;NUM|NOM|STR|DAT&gt;
     *  The type of attribute to create:
     *  NUM = Numeric attribute
     *  NOM = Nominal attribute
     *  STR = String attribute
     *  DAT = Date attribute
     *  (default: NUM)</pre>
     * 
     * <pre> -C &lt;index&gt;
     *  Specify where to insert the column. First and last
     *  are valid indexes.(default: last)</pre>
     * 
     * <pre> -N &lt;name&gt;
     *  Name of the new attribute.
     *  (default: 'Unnamed')</pre>
     * 
     * <pre> -L &lt;label1,label2,...&gt;
     *  Create nominal attribute with given labels
     *  (default: numeric attribute)</pre>
     * 
     * <pre> -F &lt;format&gt;
     *  The format of the date values (see ISO-8601)
     *  (default: yyyy-MM-dd'T'HH:mm:ss)</pre>
     * 
     <!-- options-end -->
     *
     * @param options the list of options as an array of strings
     * @throws Exception if an option is not supported
     */
    public void setOptions(String[] options) throws Exception {
      String	tmpStr;
  
      tmpStr = Utils.getOption('T', options);
      if (tmpStr.length() != 0)
        setAttributeType(new SelectedTag(tmpStr, TAGS_TYPE));
      else
        setAttributeType(new SelectedTag(Attribute.NUMERIC, TAGS_TYPE));
      
      tmpStr = Utils.getOption('C', options);
      if (tmpStr.length() == 0)
        tmpStr = "last";
      setAttributeIndex(tmpStr);
      
      setAttributeName(Utils.unbackQuoteChars(Utils.getOption('N', options)));
      
      if (m_AttributeType == Attribute.NOMINAL) {
        tmpStr = Utils.getOption('L', options);
        if (tmpStr.length() != 0)
  	setNominalLabels(tmpStr);
      }
      else if (m_AttributeType == Attribute.DATE) {
        tmpStr = Utils.getOption('F', options);
        if (tmpStr.length() != 0)
  	setDateFormat(tmpStr);
      }
  
      if (getInputFormat() != null) {
        setInputFormat(getInputFormat());
      }
    }
  
    /**
     * Gets the current settings of the filter.
     *
     * @return an array of strings suitable for passing to setOptions
     */
    public String [] getOptions() {
      Vector<String>	result;
      
      result = new Vector<String>();
      
      if (m_AttributeType != Attribute.NUMERIC) {
        result.add("-T");
        result.add("" + getAttributeType());
      }
      
      result.add("-N");
      result.add(Utils.backQuoteChars(getAttributeName()));
      
      if (m_AttributeType == Attribute.NOMINAL) {
        result.add("-L");
        result.add(getNominalLabels());
      }
      else if (m_AttributeType == Attribute.NOMINAL) {
        result.add("-F");
        result.add(getDateFormat());
      }
      
      result.add("-C");
      result.add("" + getAttributeIndex());
  
      return result.toArray(new String[result.size()]);
    }
  
    /** 
     * Returns the Capabilities of this filter.
     *
     * @return            the capabilities of this object
     * @see               Capabilities
     */
    public Capabilities getCapabilities() {
      Capabilities result = super.getCapabilities();
      result.disableAll();
  
      // attributes
      result.enableAllAttributes();
      result.enable(Capability.MISSING_VALUES);
      
      // class
      result.enableAllClasses();
      result.enable(Capability.MISSING_CLASS_VALUES);
      result.enable(Capability.NO_CLASS);
      
      return result;
    }
  
    /**
     * Sets the format of the input instances.
     *
     * @param instanceInfo an Instances object containing the input instance
     * structure (any instances contained in the object are ignored - only the
     * structure is required).
     * @return true if the outputFormat may be collected immediately
     * @throws Exception if the format couldn't be set successfully
     */
    public boolean setInputFormat(Instances instanceInfo) throws Exception {
  
      super.setInputFormat(instanceInfo);
  
      m_Insert.setUpper(instanceInfo.numAttributes());
      Instances outputFormat = new Instances(instanceInfo, 0);
      Attribute newAttribute = null;
      switch (m_AttributeType) {
        case Attribute.NUMERIC:
  	newAttribute = new Attribute(m_Name);
  	break;
        case Attribute.NOMINAL:
  	newAttribute = new Attribute(m_Name, m_Labels);
  	break;
        case Attribute.STRING:
  	newAttribute = new Attribute(m_Name, (FastVector) null);
  	break;
        case Attribute.DATE:
  	newAttribute = new Attribute(m_Name, m_DateFormat);
  	break;
        default:
  	throw new IllegalArgumentException("Unknown attribute type in Add");
      }
  
      if ((m_Insert.getIndex() < 0) || 
  	(m_Insert.getIndex() > getInputFormat().numAttributes())) {
        throw new IllegalArgumentException("Index out of range");
      }
      outputFormat.insertAttributeAt(newAttribute, m_Insert.getIndex());
      setOutputFormat(outputFormat);
      
      // all attributes, except index of added attribute
      // (otherwise the length of the input/output indices differ)
      Range atts = new Range(m_Insert.getSingleIndex());
      atts.setInvert(true);
      atts.setUpper(outputFormat.numAttributes() - 1);
      initOutputLocators(outputFormat, atts.getSelection());
      
      return true;
    }
  
    /**
     * Input an instance for filtering. Ordinarily the instance is processed
     * and made available for output immediately. Some filters require all
     * instances be read before producing output.
     *
     * @param instance the input instance
     * @return true if the filtered instance may now be
     * collected with output().
     * @throws IllegalStateException if no input format has been defined.
     */
    public boolean input(Instance instance) {
  
      if (getInputFormat() == null) {
        throw new IllegalStateException("No input instance format defined");
      }
      if (m_NewBatch) {
        resetQueue();
        m_NewBatch = false;
      }
  
      Instance inst = (Instance)instance.copy();
  
      // First copy string values from input to output
      copyValues(inst, true, inst.dataset(), getOutputFormat());
      
      // Insert the new attribute and reassign to output
      inst.setDataset(null);
      inst.insertAttributeAt(m_Insert.getIndex());
      inst.setDataset(getOutputFormat());
      push(inst);
      return true;
    }
  
    /**
     * Returns the tip text for this property.
     *
     * @return tip text for this property suitable for
     * displaying in the explorer/experimenter gui
     */
    public String attributeNameTipText() {
  
      return "Set the new attribute's name.";
    }
  
    /**
     * Get the name of the attribute to be created.
     *
     * @return the new attribute name
     */
    public String getAttributeName() {
  
      return m_Name;
    }
  
    /** 
     * Set the new attribute's name.
     *
     * @param name the new name
     */
    public void setAttributeName(String name) {
      if (name.trim().equals(""))
        m_Name = "unnamed";
      else
        m_Name = name;
    }
  
    /**
     * Returns the tip text for this property.
     *
     * @return tip text for this property suitable for
     * displaying in the explorer/experimenter gui
     */
    public String attributeIndexTipText() {
  
      return "The position (starting from 1) where the attribute will be inserted "
        + "(first and last are valid indices).";
    }
  
    /**
     * Get the index of the attribute used.
     *
     * @return the index of the attribute
     */
    public String getAttributeIndex() {
  
      return m_Insert.getSingleIndex();
    }
  
    /**
     * Sets index of the attribute used.
     *
     * @param attIndex the index of the attribute
     */
    public void setAttributeIndex(String attIndex) {
      
      m_Insert.setSingleIndex(attIndex);
    }
  
    /**
     * Returns the tip text for this property.
     *
     * @return tip text for this property suitable for
     * displaying in the explorer/experimenter gui
     */
    public String nominalLabelsTipText() {
      return "The list of value labels (nominal attribute creation only). "
        + " The list must be comma-separated, eg: \"red,green,blue\"."
        + " If this is empty, the created attribute will be numeric.";
    }
  
    /**
     * Get the list of labels for nominal attribute creation.
     *
     * @return the list of labels for nominal attribute creation
     */
    public String getNominalLabels() {
  
      String labelList = "";
      for(int i = 0; i < m_Labels.size(); i++) {
        if (i == 0) {
  	labelList = (String)m_Labels.elementAt(i);
        } else {
  	labelList += "," + (String)m_Labels.elementAt(i); 
        }
      }
      return labelList;
    }
  
    /**
     * Set the labels for nominal attribute creation.
     *
     * @param labelList a comma separated list of labels
     * @throws IllegalArgumentException if the labelList was invalid
     */
    public void setNominalLabels(String labelList) {
  
      FastVector labels = new FastVector (10);
  
      // Split the labelList up into the vector
      int commaLoc;
      while ((commaLoc = labelList.indexOf(',')) >= 0) {
        String label = labelList.substring(0, commaLoc).trim();
        if (!label.equals("")) {
  	labels.addElement(label);
        } else {
  	throw new IllegalArgumentException("Invalid label list at "+
                                             labelList.substring(commaLoc));
        }
        labelList = labelList.substring(commaLoc + 1);
      }
      String label = labelList.trim();
      if (!label.equals("")) {
        labels.addElement(label);
      }
  
      // If everything is OK, make the type change
      m_Labels = labels;
      if (labels.size() == 0) {
        m_AttributeType = Attribute.NUMERIC;
      } else {
        m_AttributeType = Attribute.NOMINAL; 
      }
    }
  
    /**
     * Returns the tip text for this property
     * 
     * @return 		tip text for this property suitable for
     * 			displaying in the explorer/experimenter gui
     */
    public String attributeTypeTipText() {
      return "Defines the type of the attribute to generate.";
    }
  
    /**
     * Sets the type of attribute to generate. 
     *
     * @param value 	the attribute type
     */
    public void setAttributeType(SelectedTag value) {
      if (value.getTags() == TAGS_TYPE) {
        m_AttributeType = value.getSelectedTag().getID();
      }
    }
  
    /**
     * Gets the type of attribute to generate. 
     *
     * @return 		the current attribute type.
     */
    public SelectedTag getAttributeType() {
      return new SelectedTag(m_AttributeType, TAGS_TYPE);
    }
  
    /**
     * Returns the tip text for this property.
     *
     * @return 		tip text for this property suitable for
     * 			displaying in the explorer/experimenter gui
     */
    public String dateFormatTipText() {
      return "The format of the date values (see ISO-8601).";
    }
  
    /**
     * Get the date format, complying to ISO-8601.
     *
     * @return 		the date format
     */
    public String getDateFormat() {
      return m_DateFormat;
    }
  
    /**
     * Set the date format, complying to ISO-8601.
     *
     * @param value 	a comma separated list of labels
     */
    public void setDateFormat(String value) {
      try {
        new SimpleDateFormat(value);
        m_DateFormat = value;
      }
      catch (Exception e) {
        e.printStackTrace();
      }
    }
    
    /**
     * Returns the revision string.
     * 
     * @return		the revision
     */
    public String getRevision() {
      return RevisionUtils.extract("$Revision: 5987 $");
    }
  
    /**
     * Main method for testing this class.
     *
     * @param argv should contain arguments to the filter: use -h for help
     */
    public static void main(String [] argv) {
      runFilter(new Add(), argv);
    }
  }
  