ScoredTerm.java

/*******************************************************************************
 * Copyright 2015-2016 - CNRS (Centre National de Recherche Scientifique)
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 eu.project.ttc.models.scored;

import java.util.Collection;
import java.util.List;

import com.google.common.base.Objects;
import com.google.common.collect.Lists;

import eu.project.ttc.models.Term;
import eu.project.ttc.models.TermOccurrence;
import eu.project.ttc.models.TermVariation;
import eu.project.ttc.utils.TermOccurrenceUtils;

public class ScoredTerm extends ScoredTermOrVariant {

	private int rank;
	
	public int getRank() {
		return rank;
	}
	
	public void setRank(int rank) {
		this.rank = rank;
	}
	
	private List<ScoredVariation> variations;
	
	public ScoredTerm(ScoredModel scoredModel, Term t) {
		super(scoredModel, t);
	}
	
	public void setVariations(Iterable<ScoredVariation> variations) {
		this.variations = Lists.newLinkedList(variations);
	}

	public List<ScoredVariation> getVariations() {
		return this.variations;
	}
	
	private double independance = -1;

	
	/**
	 * 
	 * The ratio of this term appearance without any of its variants
	 * 
	 * @return
	 * 		The ratio of this term appearance without any of its variants.
	 */
	public double getTermIndependanceScore() {
		if(independance == -1) {
			Collection<TermOccurrence> occs = Lists.newLinkedList(getTerm().getOccurrences());
			for(TermVariation tv:getTerm().getVariations()) {
				TermOccurrenceUtils.removeOverlaps(tv.getVariant().getOccurrences(), occs);
			}
			for(Term ext:getTerm().getExtensions()) {
				TermOccurrenceUtils.removeOverlaps(ext.getOccurrences(), occs);
			}

			independance = ((double)occs.size())/this.getTerm().getFrequency();
		}
		return independance;
	}
	
	private int maxFrequency = Integer.MIN_VALUE;
	
	public int getMaxVariationFrequency() {
		if(maxFrequency == Integer.MIN_VALUE) {
			for(ScoredVariation tv:variations)
				if(tv.getFrequency() > maxFrequency)
					maxFrequency = tv.getFrequency();
		}
		return maxFrequency;
	}

	public void reset() {
		super.reset();
		maxFrequency = Integer.MIN_VALUE;
		maxExtensionAffixWRLog = Double.MIN_VALUE;
	}
	
	@Override
	public boolean equals(Object obj) {
		if (obj instanceof ScoredTerm) {
			ScoredTerm st = (ScoredTerm) obj;
			return Objects.equal(this.getTerm(), st.getTerm());
		} else
			return false;
	}

	private Double maxExtensionAffixWRLog = Double.MIN_VALUE;
	
	public double getMaxExtensionAffixWRLog() {
		if(maxExtensionAffixWRLog == Double.MIN_VALUE) {
			maxExtensionAffixWRLog = 0.00001d;
			for(ScoredVariation tv:variations)
				if(tv.getExtensionAffix() == null)
					continue;
				else if(tv.getExtensionAffix().getWRLog() > maxExtensionAffixWRLog)
					maxExtensionAffixWRLog = tv.getExtensionAffix().getWRLog();
		}
		return maxExtensionAffixWRLog;

	}

	private static final String LABEL_FORMAT = "I:%.2f,O:%.2f";
	public String getLabel() {
		return String.format(LABEL_FORMAT, getTermIndependanceScore(), getOrthographicScore());
	}
	
	@Override
	public int hashCode() {
		return this.term.hashCode();
	}
	


}