de.unihd.dbs.uima.annotator.heideltime.resources.Language Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of heideltime Show documentation

HeidelTime is a multilingual cross-domain temporal tagger that extracts temporal expressions from documents and normalizes them according to the TIMEX3 annotation standard.

There is a newer version: 2.2.1

Show newest version

package de.unihd.dbs.uima.annotator.heideltime.resources;

import de.unihd.dbs.uima.annotator.heideltime.utilities.Logger;

/**
 * Hardcoded Language information for use with HeidelTime/Standalone. Contains
 * information on the resource folder name as well as the relevant treetagger
 * parameter file and command line switch.
 * 
 * @author Julian Zell
 */
public enum Language {
	/*
	 * set languages here. elements are:
	 * (languageName [for output labelling],
	 *  resourceFolder [where the resources for this language reside],
	 *  treeTaggerLangName [partial of the name of the treetagger parameter file],
	 *  treeTaggerSwitch [if tree-tagger tokenization script needs a special switch for this language]) 
	 */
	ENGLISH		("english", "english", "english", "-e"),
	GERMAN		("german", "german", "german", ""),
	DUTCH		("dutch", "dutch", "dutch", ""),
	ENGLISHCOLL	("englishcoll", "englishcoll", "english", "-e"),
	ENGLISHSCI	("englishsci", "englishsci", "english", "-e"),
	ITALIAN		("italian", "italian", "italian", "-i"),
	SPANISH		("spanish", "spanish", "spanish", ""),
	VIETNAMESE	("vietnamese", "vietnamese", "vietnamese", ""),
	ARABIC		("arabic", "arabic", "arabic", ""),
	FRENCH		("french", "french", "french", "-f"),
	CHINESE		("chinese", "chinese", "zh", ""),
    RUSSIAN		("russian", "russian", "russian", ""),
    CROATIAN	("croatian", "croatian", "croatian", ""),
	PORTUGUESE	("portuguese", "portuguese", "portuguese", ""),
    ESTONIAN	("estonian", "estonian", "estonian", ""),
	WILDCARD	("", "", "", ""), // if no match was found, this gets filled with parameter
	; // ends the enum element list
	
	private String languageName;
	private String treeTaggerSwitch;
	private String treeTaggerLangName;
	private String resourceFolder;
	
	/**
	 * Constructor for the Language elements.
	 * @param languageName formal name of the language
	 * @param resourceFolder folder name in the classpath that contains the resources
	 * @param treeTaggerLangName name of the treetagger parameter file (for treetaggerwrapper)
	 * @param treeTaggerSwitch special switch for the treetagger
	 */
	Language(String languageName, String resourceFolder, String treeTaggerLangName, String treeTaggerSwitch) {
		this.languageName = languageName;
		this.resourceFolder = resourceFolder;
		this.treeTaggerLangName = treeTaggerLangName;
		this.treeTaggerSwitch = treeTaggerSwitch;
	}
	
	/**
	 * Takes a string and checks whether we have hardcoded parameter support for the given language. 
	 * @param name name of the language, e.g. "english", "german"
	 * @return Language enum element that represents the requested language
	 */
	public final static Language getLanguageFromString(String name) {
		if(name == null) {
			Logger.printError("Language parameter was specified as NULL.");
			throw new NullPointerException();
		}
		
		// loop through languages that aren't the wildcard one to see if we have special info on that language
		for(Language l : Language.values()) {
			if(l != WILDCARD && name.toLowerCase().equals(l.getName().toLowerCase())) {
				return l;
			}
		}
		
		// if looping through present enums didn't yield a result, throw one that is customized with the name parameter
		Language.WILDCARD.languageName = name;
		Language.WILDCARD.treeTaggerLangName = name;
		Language.WILDCARD.resourceFolder = name;
		return WILDCARD;
	}
	
	/*
	 * getters
	 */
	
	public final String getName() {
		return this.languageName;
	}
	
	public final String getTreeTaggerSwitch() {
		return this.treeTaggerSwitch;
	}
	
	public final String getTreeTaggerLangName() {
		return this.treeTaggerLangName;
	}
	
	public final String getResourceFolder() {
		return this.resourceFolder;
	}
	
	@Override
	public String toString() {
		return getName();
	}
}