TueppPos.java

/*
 * Copyright 2014
 * 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 de.tudarmstadt.ukp.dkpro.core.io.tuepp.internal.model;

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

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;

public class TueppPos
{
    @XmlAttribute(name="t")
    public String tag;

    @XmlAttribute(name="r")
    public int rank;

    @XmlAttribute(name="c")
    public float certainty;
    
    @XmlElement(name = "b")
    public List<TueppBaseform> baseforms = new ArrayList<TueppBaseform>();
    
    /**
     * A part-of-speech tag can have multiple baseforms. This method returns the first baseform.
     */
    public TueppBaseform getPrimaryBaseForm()
    {
        if (!baseforms.isEmpty()) {
            return baseforms.get(0);
        }
        else {
            return null;
        }
    }
}