001/*
002 * Copyright (c) 2011, 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.feature.token;
025
026import java.util.ArrayList;
027import java.util.Arrays;
028import java.util.Collection;
029import java.util.HashSet;
030import java.util.List;
031import java.util.Set;
032
033import org.apache.uima.jcas.JCas;
034import org.cleartk.ml.Feature;
035import org.cleartk.ml.feature.extractor.CleartkExtractorException;
036import org.cleartk.ml.feature.extractor.CoveredTextExtractor;
037import org.cleartk.ml.feature.extractor.NamedFeatureExtractor1;
038import org.cleartk.token.type.Token;
039
040/**
041 * <br>
042 * Copyright (c) 2011, Regents of the University of Colorado <br>
043 * All rights reserved.
044 * 
045 * @author Steven Bethard
046 */
047public class TokenTextForSelectedPosExtractor implements NamedFeatureExtractor1<Token> {
048
049  private Set<String> acceptablePOSTags;
050
051  private CoveredTextExtractor<Token> extractor;
052
053  public TokenTextForSelectedPosExtractor(Collection<String> acceptablePOSTags) {
054    this.acceptablePOSTags = new HashSet<String>(acceptablePOSTags);
055    this.extractor = new CoveredTextExtractor<Token>();
056  }
057
058  public TokenTextForSelectedPosExtractor(String... acceptablePOSTags) {
059    this(Arrays.asList(acceptablePOSTags));
060  }
061  
062  @Override
063  public String getFeatureName() {
064    return this.extractor.getFeatureName();
065  }
066
067  @Override
068  public List<Feature> extract(JCas view, Token token)
069      throws CleartkExtractorException {
070    List<Feature> features = new ArrayList<Feature>();
071    String pos = token.getPos();
072    if (pos != null) {
073      if (pos.length() > 2) {
074        pos = pos.substring(0, 2);
075      }
076      if (this.acceptablePOSTags.contains(pos)) {
077        features.addAll(this.extractor.extract(view, token));
078      }
079    }
080    return features;
081  }
082}