org.dkpro.tc.api.features.Instance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dkpro-tc-api-features Show documentation
There is a newer version: 1.1.0
Show newest version
/*******************************************************************************
 * Copyright 2015
 * 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.api.features;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
import java.util.Set;

import org.apache.commons.lang.StringUtils;

/**
 * Internal representation of an instance.
 *
 */
public class Instance
{
    private List features;
    private List outcomes;
    private double weight;
    private int sequenceId;
    private int sequencePosition;

    public Instance()  
    {
        this.features = new ArrayList();
        this.outcomes = new ArrayList();
        this.weight = 0.0;
        this.sequenceId = 0;
        this.sequencePosition = 0;
    }

    public Instance(Collection features, String outcome) 
    {
        this.features = new ArrayList(features);
        this.features.sort(getComparator());
        this.outcomes = new ArrayList();
        this.outcomes.add(outcome);
        this.weight = 0.0;
        this.sequenceId = 0;
        this.sequencePosition = 0;
    }

    public Instance(Collection features, String... outcomes) 
    {
        this.features = new ArrayList(features);
        this.features.sort(getComparator());
        this.outcomes = Arrays.asList(outcomes);
        this.weight = 0.0;
        this.sequenceId = 0;
        this.sequencePosition = 0;
    }

    public Instance(Collection features, List outcomes)  
    {
        this.features = new ArrayList(features);
        this.outcomes = outcomes;
        this.weight = 0.0;
        this.sequenceId = 0;
        this.sequencePosition = 0;
    }

    public void setOutcomes(Collection outcomes)
    {
        this.outcomes.clear();
        this.outcomes.addAll(outcomes);
    }

    public void addFeature(Feature feature) 
    {
        features.add(feature);
        features.sort(getComparator());
    }

    public void addFeatures(Collection featureCollection)  
    {
        features.addAll(featureCollection);
        features.sort(getComparator());
    }

    public String getOutcome()
    {
        if (outcomes.size() > 0) {
            return outcomes.get(0);
        }
        return null;
    }

    public List getOutcomes()
    {
        return this.outcomes;
    }

    public void setOutcomes(String... outcomes)
    {
        this.outcomes.clear();
        this.outcomes.addAll(Arrays.asList(outcomes));
    }

    public double getWeight()
    {
        return this.weight;
    }

    public void setWeight(double weight)
    {
        this.weight = weight;
    }

    public Collection getFeatures()
    {
        return features;
    }

    public void setFeatures(Set featureSet)  
    {
        features = new ArrayList(featureSet);
        features.sort(getComparator());
    }

    /**
     * @return The id of the sequence this instance is part of. 0 if not part of any sequence.
     */
    public int getSequenceId()
    {
        return sequenceId;
    }

    public void setSequenceId(int sequenceId)
    {
        this.sequenceId = sequenceId;
    }

    public int getSequencePosition()
    {
        return sequencePosition;
    }

    public void setSequencePosition(int sequencePosition)
    {
        this.sequencePosition = sequencePosition;
    }

    @Override
    public String toString()
    {
        StringBuilder sb = new StringBuilder();
        sb.append(sequenceId);
        sb.append(" - ");
        sb.append(sequencePosition);
        sb.append("\n");
        for (Feature feature : getFeatures()) {
            sb.append(feature);
            sb.append("\n");
        }
        sb.append(StringUtils.join(outcomes, "-"));
        return sb.toString();
    }
    
    private Comparator getComparator(){
    	return new Comparator(){

			@Override
			public int compare(Feature o1, Feature o2) {
				return o1.name.compareTo(o2.name);
			}};
    }

}