ILanguage.java

/*******************************************************************************
 * Copyright 2016
 * 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.lmf.transform.wikipedia;


/**
 * Generic interface for languages used in Wikipedia. Each language is encoded using the
 * international standard of language classification (ISO 639). Languages
 * are compared by their internal code.
 * @author Christian M. Meyer
 * @author Christof Mller
 * @author Lizhen Qu
 */
public interface ILanguage extends  Comparable<ILanguage> {


	/** Returns the internal language code used by JWPL. These codes roughly
	 *  correspond to ISO 639-1, but also include language families,
	 *  deprecated classifications, and not yet classified languages. */
	public String getCode();

	/** Returns the language name (in English language). */
	public String getName();

	/** Returns the ISO 639-1 code or an empty string if none. */
	public String getISO639_1();

	/** Returns the ISO 639-2b code or an empty string if none. */
	public String getISO639_2B();

	/** Returns the ISO 639-2t code or an empty string if none. */
	public String getISO639_2T();

	/** Returns the ISO 639-3 code or an empty string if none. */
	public String getISO639_3();

}