org.dkpro.tc.features.syntax.PronounRatioFeatureExtractor Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright 2018
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package org.dkpro.tc.features.syntax;

import java.util.HashSet;
import java.util.Set;

import org.apache.uima.fit.descriptor.TypeCapability;
import org.apache.uima.fit.util.JCasUtil;
import org.apache.uima.jcas.JCas;
import org.dkpro.tc.api.exception.TextClassificationException;
import org.dkpro.tc.api.features.Feature;
import org.dkpro.tc.api.features.FeatureExtractor;
import org.dkpro.tc.api.features.FeatureExtractorResource_ImplBase;
import org.dkpro.tc.api.features.FeatureType;
import org.dkpro.tc.api.type.TextClassificationTarget;

import de.tudarmstadt.ukp.dkpro.core.api.lexmorph.type.pos.POS_PRON;

/**
 * Extracts the ratio of the 6 major English pronouns to the total pronouns
 * 
 * English only.
 */

@TypeCapability(inputs = { "de.tudarmstadt.ukp.dkpro.core.api.lexmorph.type.pos.POS" })
public class PronounRatioFeatureExtractor
    extends FeatureExtractorResource_ImplBase
    implements FeatureExtractor
{
    public static final String FN_I_RATIO = "PronounRatioI";
    public static final String FN_HE_RATIO = "PronounRatioHe";
    public static final String FN_SHE_RATIO = "PronounRatioShe";
    public static final String FN_WE_RATIO = "PronounRatioWe";
    public static final String FN_THEY_RATIO = "PronounRatioThey";
    public static final String FN_US_RATIO = "PronounRatioUs";
    public static final String FN_IT_RATIO = "PronounRatioIt";
    public static final String FN_YOU_RATIO = "PronounRatioYou";

    @Override
    public Set extract(JCas jcas, TextClassificationTarget aTarget)
        throws TextClassificationException
    {

        int heCount = 0;
        int sheCount = 0;
        int iCount = 0;
        int weCount = 0;
        int theyCount = 0;
        int usCount = 0;
        int youCount = 0;
        int itCount = 0;

        int n = 0;
        for (POS_PRON pronoun : JCasUtil.selectCovered(jcas, POS_PRON.class, aTarget)) {
            n++;

            String text = pronoun.getCoveredText().toLowerCase();
            if (text.equals("he")) {
                heCount++;
            }
            else if (text.equals("she")) {
                sheCount++;
            }
            else if (text.equals("i")) {
                iCount++;
            }
            else if (text.equals("we")) {
                weCount++;
            }
            else if (text.equals("they")) {
                theyCount++;
            }
            else if (text.equals("us")) {
                usCount++;
            }
            else if (text.equals("you")) {
                youCount++;
            }else if (text.equals("it")) {
                itCount++;
            }
        }

        Set features = new HashSet();
        features.add(new Feature(FN_HE_RATIO, (double) heCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_SHE_RATIO, (double) sheCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_I_RATIO, (double) iCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_WE_RATIO, (double) weCount / n, n == 0, FeatureType.NUMERIC));
        features.add(
                new Feature(FN_THEY_RATIO, (double) theyCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_US_RATIO, (double) usCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_YOU_RATIO, (double) youCount / n, n == 0, FeatureType.NUMERIC));
        features.add(new Feature(FN_IT_RATIO, (double) itCount / n, n == 0, FeatureType.NUMERIC));

        return features;
    }
}