de.tudarmstadt.ukp.jwktl.api.entry.WiktionarySense 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.entry;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;

import com.sleepycat.persist.model.Persistent;

import de.tudarmstadt.ukp.jwktl.api.IQuotation;
import de.tudarmstadt.ukp.jwktl.api.IWikiString;
import de.tudarmstadt.ukp.jwktl.api.IWiktionaryEntry;
import de.tudarmstadt.ukp.jwktl.api.IWiktionaryExample;
import de.tudarmstadt.ukp.jwktl.api.IWiktionaryPage;
import de.tudarmstadt.ukp.jwktl.api.IWiktionaryRelation;
import de.tudarmstadt.ukp.jwktl.api.IWiktionarySense;
import de.tudarmstadt.ukp.jwktl.api.IWiktionaryTranslation;
import de.tudarmstadt.ukp.jwktl.api.RelationType;
import de.tudarmstadt.ukp.jwktl.api.util.ILanguage;

/**
 * Default implementation of the {@link IWiktionarySense} interface.
 * See there for details.
 * @author Christian M. Meyer
 */
@Persistent
public class WiktionarySense implements IWiktionarySense {

	protected int index;
	protected String marker;

	protected transient WiktionaryEntry entry;
	protected long entryId;
		
	protected IWikiString gloss;
	protected List examples;
	protected List quotations;
	protected List references;
	protected List relations;
	protected List translations;

	/** Initialize the sense using the given Wiktionary entry. This is necessary
	 *  to initialize the back references to the parent entry, which are not 
	 *  explicitly stored in the database. */
	public void init(final WiktionaryEntry entry) {
		this.entry = entry;
		entryId = entry.getId();
	}

	
	// -- Identifier --
	
	public String getKey() {
		return getEntry().getKey() + ":" + getId();
	}
	
	public String getId() {
		return Integer.toString(index);
	}
	
	/** Shorthand for getEntry().getId(). */
	public long getEntryId() {
		return entryId;
	}
	
	public int getIndex() {
		return index;
	}
	
	/** Assigns the given index to this sense. */
	protected void setIndex(int index) {
		this.index = index;
	}

	public String getMarker() {
		return marker;
	}
	
	/** Assigns the given sense marker to this sense. */
	public void setMarker(final String marker) {
		this.marker = marker;
	}

	
	// -- Parent --
	
	public IWiktionaryEntry getEntry() {
		return entry;
	}

	public IWiktionaryPage getPage() {
		return entry.getPage();
	}
	
	
	// -- Sense --
	
	public IWikiString getGloss() {
		return gloss;
	}
	
	/** Add the given sense definition to this sense. */
	public void setGloss(final IWikiString gloss) {
		this.gloss = gloss;
	}

	/** Add the given example to this sense. */
	public void addExample(final IWiktionaryExample example) {
		if (examples == null)
			examples = new ArrayList<>();
		examples.add(example);
	}

	public List getExamples() {
		return examples;
	}
	
	/** Add the given quotation to this sense. */
	public void addQuotation(final IQuotation quotation) {
		if (quotations == null)
			quotations = new ArrayList<>();
		quotations.add(quotation);
	}

	public List getQuotations() {
		return quotations;
	}
	
	/** Add the given reference to this sense. */
	public void addReference(final IWikiString reference) {
		if (references == null)
			references = new ArrayList<>();
		references.add(reference);
	}
	
	public List getReferences() {
		return references;
	}
	
	/** Add the given relation to this sense. */
	public void addRelation(final IWiktionaryRelation relation) {
		if (relations == null)
			relations = new ArrayList<>();
		relations.add(relation);
	}

	public List getRelations() {
		return relations;
	}
	
	public List getRelations(final RelationType relationType) {
		if (relations != null) {
			return relations.stream()
				.filter(relation -> relation.getRelationType() == relationType)
				.collect(Collectors.toList());
		} else {
			return Collections.emptyList();
		}
	}
	
	/** Add the given translation to this sense. */
	public void addTranslation(final IWiktionaryTranslation translation) {
		if (translations == null)
			translations = new ArrayList<>();
		translations.add(translation);
	}
	
	public List getTranslations(final ILanguage language) {		
		if (translations != null) {
			return translations.stream()
				.filter(trans -> language == trans.getLanguage() || (language != null && language.equals(trans.getLanguage())))
				.collect(Collectors.toList());
		} else {
			return Collections.emptyList();
		}
	}
	
	public List getTranslations() {
		return translations;
	}

	
	// -- Subsenses --
	
	/*public List getSenses() {
		return null;
	}*/


	@Override
	public String toString() {
		return getClass().getName() + ":" + index + ":" + gloss;
	}
	
}