001/** 
002 * Copyright (c) 2007-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.feature.extractor;
025
026import java.util.List;
027
028import org.apache.uima.jcas.JCas;
029import org.apache.uima.jcas.tcas.Annotation;
030import org.cleartk.ml.Feature;
031
032/**
033 * <br>
034 * Copyright (c) 2007-2009, Regents of the University of Colorado <br>
035 * All rights reserved.
036 * 
037 * @author Philipp Wetzler
038 */
039public class NamingExtractor1<T extends Annotation> implements FeatureExtractor1<T> {
040
041  /**
042   * Prepends the name of the features produced by subExtractor with the passed in name. To apply
043   * the name to multiple feature extractors pass in a {@link CombinedExtractor1}
044   * 
045   * @param name
046   *          The name to prepend to extracted feature names
047   * @param subExtractor
048   *          delegated extractor
049   */
050  public NamingExtractor1(String name, FeatureExtractor1<T> subExtractor) {
051    this.name = name;
052    this.subExtractor = subExtractor;
053  }
054
055  public List<Feature> extract(JCas view, T focusAnnotation) throws CleartkExtractorException {
056    List<Feature> features = subExtractor.extract(view, focusAnnotation);
057
058    for (Feature feature : features) {
059      feature.setName(Feature.createName(name, feature.getName()));
060    }
061
062    return features;
063  }
064
065  private String name;
066
067  private FeatureExtractor1<T> subExtractor;
068
069}