de.tudarmstadt.ukp.jwktl.api.IWiktionarySense Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dkpro-jwktl Show documentation

JWKTL (Java Wiktionary Library) is a Java-based API that enables efficient and structured access to the information encoded in the English and the German Wiktionary edition, including sense definitions, part of speech tags, etymology, example sentences, translations, semantic relations and many other lexical information types.

The newest version!

/*******************************************************************************
 * Copyright 2013
 * 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.jwktl.api;

import java.util.List;

import de.tudarmstadt.ukp.jwktl.api.util.ILanguage;

/**
 * A {@link IWiktionarySense} represents one word sense of a lexical entry 
 * (also called a lexical unit). Each {@link IWiktionarySense} belongs to 
 * exactly one {@link IWiktionaryEntry}. Note that 
 * {@link IWiktionaryEntry#getUnassignedSense()} returns a dummy word sense
 * carrying all information that has not been assigned to a particular 
 * sense - for this case, the {@link IWiktionarySense} does not model an
 * actual word sense,  
 * @author Christian M. Meyer
 */
public interface IWiktionarySense {
	
	// -- Identifier --
	
	/** Returns a unique ID for this word sense. The ID is unique for all 
	 *  {@link IWiktionarySense}s of the {@link IWiktionaryEdition}. Note 
	 *  however that the ID of a sense may differ between different software 
	 *  versions or dump dates. */
	String getKey();
	
	/** Returns an ID of this sense that is unique for all senses 
	 *  of the containing {@link IWiktionaryEntry}. Use {@link #getKey()} 
	 *  for a globally unique identifier. */
	String getId();
	
	/** Returns the index of this sense. That is, the running number of 
	 *  the sense in accordance to the list of senses of the 
	 *  {@link IWiktionaryEntry}. The first sense has index 1. 
	 *  Note that this is not generally the index marker used in Wiktionary: 
	 *  the first sense has for example always index 1, although it might
	 *  be marked with "[2]" or "[1a]". See {@link #getMarker()} for details. */
	int getIndex();
	
	/** Returns the marker for this sense as defined in Wiktionary. This 
	 *  can be different for each type of Wiktionary edition; for example,
	 *  running numbers, short textual labels,... */
	String getMarker();
	
	
	// -- Parent --
	
	/** Returns a reference to the {@link IWiktionaryEntry} that contains
	 *  this sense. */
	IWiktionaryEntry getEntry();
	
	/** Returns a reference to the {@link IWiktionaryPage} that contains
	 *  this sense. */
	IWiktionaryPage getPage();
	
	
	// -- Sense --
	
	/** Returns the sense description as a {@link IWikiString}. */
	IWikiString getGloss();
	
	/** Returns a list of sense examples or null if no sense 
	 *  examples are encoded. */
	List getExamples();
	
	/** Returns a list of quotations or null if no 
	 *  quotations are encoded. */
	List getQuotations();
	
	/** Returns the list of all sense relations (or null 
	 *  if no relations are encoded). */
	List getRelations();
	
	/** Returns the list of sense relations of the given relation type. 
	 *  If there are no relations of this type, an empty list will be 
	 *  returned. */
	List getRelations(final RelationType relationType);
	
	/** Returns a list of references for this sense or 
	 *  null if no referemces are encoded. */
	List getReferences();
	
	/** Returns the list of all translations (or null 
	 *  if no translations are encoded). */
	List getTranslations();

	/** Returns the list of translations into the given language. 
	 *  If there are no translations of this type, an empty list will be 
	 *  returned. */
	List getTranslations(final ILanguage language);
	
	
	// -- Subsenses --

	//public List getSenses();

}