001/* 
002 * Copyright (c) 2012, 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.feature.transform;
025
026import java.util.ArrayList;
027import java.util.List;
028
029import org.cleartk.ml.Feature;
030import org.cleartk.ml.Instance;
031
032/**
033 * Copyright (c) 2012, Regents of the University of Colorado <br>
034 * All rights reserved.
035 * <p>
036 * 
037 * This implementation serves as a base for feature transformation from one feature into another
038 * feature (normalizing, tf*idf, etc). Many to one transformation should extend directly from
039 * {@link TrainableExtractor_ImplBase}.
040 */
041public abstract class OneToOneTrainableExtractor_ImplBase<OUTCOME_T> implements
042    TrainableExtractor<OUTCOME_T> {
043
044  protected String name;
045
046  public OneToOneTrainableExtractor_ImplBase(String name) {
047    this.name = name;
048  }
049
050  @Override
051  public Instance<OUTCOME_T> transform(Instance<OUTCOME_T> instance) {
052    List<Feature> features = new ArrayList<Feature>();
053    for (Feature feature : instance.getFeatures()) {
054      if (this.isTransformable(feature)) {
055        for (Feature origFeature : ((TransformableFeature) feature).getFeatures()) {
056          features.add(this.transform(origFeature));
057        }
058      } else {
059        features.add(feature);
060      }
061    }
062    return new Instance<OUTCOME_T>(instance.getOutcome(), features);
063  }
064
065  protected abstract Feature transform(Feature feature);
066
067  protected boolean isTransformable(Feature feature) {
068    return feature instanceof TransformableFeature && this.name.equals(feature.getName());
069  }
070
071}