org.erasmusmc.data_mining.ontology.api.Label Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontology-api Show documentation
The newest version!
/**
 * Peregrine is an indexing engine that can recognize concepts in human readable
 * text, based on a database (thesaurus) of known terms.
 *
 * Copyright 2005-2011 Erasmus University Medical Centre (EMC)
 * Copyright 2009-2011 Netherlands Bioinformatics Centre (NBIC)
 *
 * Contact us at: [email protected]
 *
 * This file is part of Peregrine. Peregrine is free software: you can
 * redistribute it and/or modify it under the terms of the GNU Affero General
 * Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */
package org.erasmusmc.data_mining.ontology.api;

import org.erasmusmc.data_mining.ontology.common.LabelType;

/**
 * The interface for general label.
 *
 * @author Dmitry Katsubo
 */
public interface Label {

    /**
     * Get the LabelType for this label. The LabelType gives an indication of
     * the significance of the label in connection to a concept. The type
     * therefor has no meaning outside the context of a specific concept.
     *
     * @return The type of this label, see {@link LabelType} for the possible
     * options.
     */
    LabelType getType();

    /**
     * Get the text of this label. The text is the human readable form of this
     * label in a natural language.
     *
     * @return The text of the label.
     */
    String getText();

    /**
     * Get the language of the label.
     *
     * @return the language of this label.
     */
    Language getLanguage();
}