fr.univnantes.termsuite.model.RelationProperty Maven / Gradle / Ivy

Go to download
package fr.univnantes.termsuite.model;

import java.util.Comparator;
import java.util.Optional;
import java.util.Set;

public enum RelationProperty implements Property {

	VARIATION_RANK("VariationRank", "vRank",  Integer.class, "The rank of the variation among all variations starting from the same source term, when the relation is a variation."),
	
	VARIATION_RULES("VariationRule", "vRules", Set.class, "The set of YAML variation rules that detected this pair of terms as a term variation, when the relation is a variation."),
	DERIVATION_TYPE("DerivationType", "derivType", String.class, "The derivation type of the variation, when the relation is a variation."),
	GRAPHICAL_SIMILARITY("GraphSimilarity", "graphSim", Double.class, "The edition distance between the two terms of the relation."),
	VARIANT_SCORE("Score", "vScore", Double.class, "The global variation score of the relation assigned by TermSuite post-processor engine, when the relation if a variation."), 
	AFFIX_GAIN("AffixGain", "affGain", Double.class, "When the relation is a variation of type \"extension\", the "+TermProperty.FREQUENCY+" of the variant divided by the "+TermProperty.FREQUENCY+" of the affix term."),
	AFFIX_SPEC("AffixSpec", "affSpec", Double.class, "When the relation is a variation of type \"extension\", the "+TermProperty.SPECIFICITY+" of the affix term."),
	AFFIX_RATIO("AffixRatio", "affRatio", Double.class, "When the relation is a variation of type \"extension\", the "+TermProperty.FREQUENCY+" of the affix term divided by the "+TermProperty.FREQUENCY+" of the base term."),
	AFFIX_SCORE("AffixScore", "affScore", Double.class, "When the relation is a variation of type \"extension\", the weighted average of `"+AFFIX_GAIN+"` and `"+AFFIX_RATIO+"`."), 
	NORMALIZED_AFFIX_SCORE("NormalizedAffixScore", "nAffScore", Double.class, "When the relation is a variation of type \"extension\", the min-max normalization of `" + AFFIX_SCORE.getPropertyName() + "`."), 
	AFFIX_ORTHOGRAPHIC_SCORE("AffixOrthographicScore", "affOrtho", Double.class, "When the relation is a variation of type \"extension\", the orthographic score of extension affix term."),
	EXTENSION_SCORE("ExtensionScore", "extScore", Double.class, "When the relation is a variation of type \"extension\", the score of the extension affix term (combines `"+AFFIX_GAIN.getPropertyName()+"` and `"+AFFIX_GAIN.getPropertyName()+"`)."),
	NORMALIZED_EXTENSION_SCORE("NormalizedExtensionScore", "nExtScore", Double.class, "When the relation is a variation of type \"extension\", the min-max normalization of `" + EXTENSION_SCORE.getPropertyName() + "`."), 
	HAS_EXTENSION_AFFIX("HasExtensionAffix", "hasExtAffix", Boolean.class, "When the relation is a variation of type \"extension\", wether there is an affix term."),
	IS_EXTENSION("IsExtension", "isExt", Boolean.class, "Wether this relation is an extension."), 
	VARIANT_BAG_FREQUENCY("VariantBagFrequency", "vBagFreq", Integer.class, "When the relation is a variation, the total of number of occurrences of the variant term and of variant's variant terms (order-2 variants)."), 
	SOURCE_GAIN("SourceGain", "srcGain", Double.class, "When the relation is a variation, the log10 of `"+VARIANT_BAG_FREQUENCY.getPropertyName()+"` divided by the "+TermProperty.FREQUENCY+" of the base term."),
	NORMALIZED_SOURCE_GAIN("NormalizedSourceGain", "nSrcGain", Double.class, "When the relation is a variation of type \"extension\", the linear normalization of `" + SOURCE_GAIN.getPropertyName() + "`."), 

	IS_INFERED("IsInfered", "isInfered", Boolean.class, "When the relation is a variation, wether it has been infered from two other base variations."), 
	IS_GRAPHICAL("IsGraphical", "isGraph", Boolean.class, "When the relation is a variation, wether there is a graphical similarity between the two terms."), 
	IS_DERIVATION("IsDerivation", "isDeriv", Boolean.class, "When the relation is a variation, wether one term is the derivation of the other."), 
	IS_PREFIXATION("IsPrefixation", "isPref", Boolean.class, "When the relation is a variation, wether one term is the prefix of the other."), 
	IS_SYNTAGMATIC("IsSyntagmatic", "isSyntag", Boolean.class, "When the relation is a variation, wether it is a syntagmatic variation."), 
	IS_MORPHOLOGICAL("IsMorphological", "isMorph", Boolean.class, "When the relation is a variation, wether the variation implies morphosyntactic variations."), 

	IS_SEMANTIC("IsSemantic", "isSem", Boolean.class, "When the relation is a variation, wether there is a semantic similarity between the two terms."), 
	IS_DISTRIBUTIONAL("Distributional", "distrib", Boolean.class, "When the relation is a semantic relation, wheter the relation is of type \"distributional\", i.e. the variation has been found by context vector alignment."),
	SEMANTIC_SIMILARITY("SemanticSimilarity", "semSim", Double.class, "When the relation is a semantic variation found by alignment, the similarity of the two context vectors of the two terms of the relation."), 
	IS_DICO("Dico", "isDico", Boolean.class, "When the relation is a semantic relation, wheter the relation is of type \"dictionary\", i.e. the variation has been found with a synonymic dico."), 
	SEMANTIC_SCORE("SemanticScore", "semScore", Double.class, "When the relation is a semantic variation, the score of pertinency of the variation. This property is set for all types of semantic variations, both from dico and distributional."), 
	;
	
	private PropertyHolderBase delegate;

	private RelationProperty(String propertyName, String jsonField, Class range, String description) {
		delegate = new PropertyHolderBase<>(propertyName, jsonField, range, description);
	}
	

	@Override
	public String getPropertyName() {
		return delegate.getPropertyName();
	}


	@Override
	public String getJsonField() {
		return delegate.getJsonField();
	}


	@Override
	public Class getRange() {
		return delegate.getRange();
	}

	@Override
	public String getDescription() {
		return delegate.getDescription();
	}

	@Override
	public boolean isNumeric() {
		return delegate.isNumeric();
	}


	@Override
	public boolean isDecimalNumber() {
		return delegate.isDecimalNumber();
	}


	@Override
	public Comparator getComparator() {
		return delegate.getComparator(this);
	}


	@Override
	public Comparator getComparator(boolean reverse) {
		return delegate.getComparator(this, reverse);
	}

	@Override
	public int compare(Relation o1, Relation o2) {
		return delegate.compare(this, o1, o2);
	}

	public static RelationProperty fromJsonString(String field) {
		return PropertyHolderBase.fromJsonString(RelationProperty.class, field);
	}

	public static RelationProperty forName(String name) {
		return (RelationProperty) Property.forName(name, RelationProperty.values());
	}

	public static Optional forNameOptional(String name) {
		Optional> opt = Property.forNameOptional(name, RelationProperty.values());
		if(opt.isPresent())
			return Optional.of((RelationProperty)opt.get());
		else
			return Optional.empty();
	}
}