org.cleartk.ml.feature.function.FeatureFunctionExtractor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleartk-ml Show documentation
ClearTK machine learning library and interfaces
The newest version!
/** 
 * Copyright (c) 2007-2012, Regents of the University of Colorado 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
 * 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. 
 * 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. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE. 
 */
package org.cleartk.ml.feature.function;

import java.util.ArrayList;
import java.util.List;

import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.tcas.Annotation;
import org.cleartk.ml.Feature;
import org.cleartk.ml.feature.extractor.CleartkExtractorException;
import org.cleartk.ml.feature.extractor.FeatureExtractor1;

import com.google.common.base.Function;

/**
 * 

 * Copyright (c) 2007-2012, Regents of the University of Colorado 

 * All rights reserved.
 * 
 * 
 * @author Steven Bethard
 */
public class FeatureFunctionExtractor implements FeatureExtractor1 {

  /**
   * Specify what to do with the base features created by the passed in feature extractor.
   */
  public static enum BaseFeatures {
    /**
     * include the base features in the returned features.
     */
    INCLUDE,
    /**
     * exclude the base features from the returned features.
     */
    EXCLUDE,
  }

  public FeatureFunctionExtractor(
      FeatureExtractor1 extractor,
      FeatureFunction... featureFunctions) {
    this(extractor, BaseFeatures.INCLUDE, featureFunctions);
  }

  /**
   * @param baseFeatures
   *          determines if the base features created by the extractor parameter will be returned by
   *          the extract method.
   */
  public FeatureFunctionExtractor(
      FeatureExtractor1 extractor,
      BaseFeatures baseFeatures,
      FeatureFunction... featureFunctions) {
    this.extractor = extractor;
    this.baseFeatures = baseFeatures;
    this.featureFunctions = featureFunctions;
  }

  public List extract(JCas jCas, T focusAnnotation) throws CleartkExtractorException {
    List returnValues = new ArrayList();
    List features = this.extractor.extract(jCas, focusAnnotation);
    if (baseFeatures == BaseFeatures.INCLUDE)
      returnValues.addAll(features);
    for (Function> featureFunction : this.featureFunctions) {
      returnValues.addAll(apply(featureFunction, features));
    }
    return returnValues;
  }

  public static List apply(
      Function> featureFunction,
      List features) {
    List returnValues = new ArrayList();
    for (Feature feature : features) {
      returnValues.addAll(featureFunction.apply(feature));
    }
    return returnValues;
  }

  private FeatureExtractor1 extractor;

  private FeatureFunction[] featureFunctions;

  private BaseFeatures baseFeatures;
}