001/** 
002 * Copyright (c) 2009, Regents of the University of Colorado 
003 * All rights reserved.
004 * 
005 * Redistribution and use in source and binary forms, with or without
006 * modification, are permitted provided that the following conditions are met:
007 * 
008 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
009 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
010 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
011 * 
012 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
013 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
014 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
015 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
016 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
017 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
018 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
019 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
020 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
021 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
022 * POSSIBILITY OF SUCH DAMAGE. 
023 */
024package org.cleartk.ml.util;
025
026import org.cleartk.ml.Feature;
027import org.cleartk.ml.Instance;
028
029/**
030 * <br>
031 * Copyright (c) 2009, Regents of the University of Colorado <br>
032 * All rights reserved.
033 * 
034 * @author Philip Ogren
035 * 
036 */
037
038public class InstanceFactory {
039
040  /**
041   * @param outcome
042   *          the outcome of the returned instance
043   * @param featureData
044   *          an even number of elements corresponding to name/value pairs used to create features
045   * @return a single instance with the provided outcome and features corresponding to the
046   *         featureData provided
047   */
048  public static <T> Instance<T> createInstance(T outcome, Object... featureData) {
049    if (featureData.length % 2 != 0) {
050      throw new IllegalArgumentException(
051          "feature data must consist of an even number of elements corresponding to name/value pairs used to create features. ");
052    }
053    Instance<T> instance = new Instance<T>(outcome);
054    for (int i = 0; i < featureData.length;) {
055      instance.add(new Feature(featureData[i].toString(), featureData[i + 1]));
056      i += 2;
057    }
058    return instance;
059  }
060
061  /**
062   * @param outcome
063   *          the outcome of the returned instance
064   * @param featureData
065   *          space delimited features. Here the features only have names (no values) corresponding
066   *          to the space delimited strings.
067   * @return a single instance with the provided outcome and name-only string features found in the
068   *         provided featureData
069   */
070  public static <T> Instance<T> createInstance(T outcome, String featureData) {
071    Instance<T> instance = new Instance<T>(outcome);
072    String[] columns = featureData.split(" ");
073    for (int i = 0; i < columns.length; i++) {
074      Feature feature = new Feature();
075      feature.setName(columns[i]);
076      instance.add(feature);
077    }
078    return instance;
079  }
080
081}