TermFreqTuple.java

/*
 * Copyright 2011
 * 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.api.frequency.util;

public class TermFreqTuple<T>
    implements Comparable<TermFreqTuple<T>>
{
    private T key;
    private long freq;

    public TermFreqTuple(T key, long freq)
    {
        super();
        this.key = key;
        this.freq = freq;
    }

    public T getKey()
    {
        return key;
    }
    public void setKey(T key)
    {
        this.key = key;
    }
    public long getFreq()
    {
        return freq;
    }
    public void setFreq(long freq)
    {
        this.freq = freq;
    }

    @Override
    public String toString()
    {
        return key + " - " + freq;
    }

    @Override
    public int compareTo(TermFreqTuple<T> arg0)
    {
        if (this.freq < arg0.freq) {
            return 1;
        }
        else if (this.freq > arg0.freq) {
            return -1;
        }
        else {
            return 0;
        }
    }
}