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;
028import java.util.Stack;
029
030import org.cleartk.ml.Feature;
031import org.cleartk.ml.Instance;
032
033/**
034 * Copyright (c) 2012, Regents of the University of Colorado <br>
035 * All rights reserved.
036 */
037
038public abstract class TrainableExtractor_ImplBase<OUTCOME_T> implements
039    TrainableExtractor<OUTCOME_T> {
040
041  protected String name;
042
043  public TrainableExtractor_ImplBase(String name) {
044    this.name = name;
045  }
046
047  protected boolean isTransformable(Feature feature) {
048    return feature instanceof TransformableFeature && this.name.equals(feature.getName());
049  }
050
051  /**
052   * Recursively look through all features in an instance to find the features this extractor is
053   * responsible for extracting
054   */
055  protected List<TransformableFeature> selectTransformableFeatures(Instance<OUTCOME_T> instance) {
056
057    List<TransformableFeature> features = new ArrayList<TransformableFeature>();
058    Stack<Feature> featuresToProcess = new Stack<Feature>();
059    featuresToProcess.addAll(instance.getFeatures());
060
061    while (!featuresToProcess.isEmpty()) {
062      Feature currFeature = featuresToProcess.pop();
063      if (currFeature instanceof TransformableFeature) {
064        TransformableFeature transformable = (TransformableFeature) currFeature;
065        if (transformable.getName().equals(this.name)) {
066          features.add(transformable);
067        } else {
068          featuresToProcess.addAll(transformable.getFeatures());
069        }
070      }
071    }
072    return features;
073  }
074
075}