org.erasmusmc.data_mining.ontology.api.ModifiableOntology 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 java.io.Serializable;

/**
 * The interface for the ontologies that support content modification.
 */
public interface ModifiableOntology extends Ontology {

    /**
     * Adds the given concept to the ontology.
     *
     * @param concept the concept to add to the ontology. This should be a
     * fully instantiated concept.
     */
    void addConcept(Concept concept);

    /**
     * Removes the given concept from the ontology.
     *
     * @param conceptId the primary identifier of the concept in this ontology.
     *
     * @return true if given concept was actually removed from the
     * ontology
     */
    boolean removeConcept(Serializable conceptId);

    /**
     * Register an listener to react on ontology modification events.
     *
     * @param listener A listener, must not be null.
     */
    void addListener(OntologyModificationListener listener);

    /**
     * Unregister an listener.
     *
     * @param listener A listener, must not be null.
     */
    void removeListener(OntologyModificationListener listener);
}