org.erasmusmc.data_mining.ontology.api.FlyweightProcessingOntology 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.util.Collection;

/**
 * The FlyweightProcessingOntology interface defines a lightweight
 * implementation of an ontology that will load the ontology through a callback
 * function.
 */
public interface FlyweightProcessingOntology {

    /**
     * Process the concepts in this ontology by invoking the handler's method
     * for each concept.
     * 
     * The concept passed as an argument is a flyweight object and it's
     * reference should not be saved - use object cloning for that.
     *
     * @param handler The callback handler for processing concepts.
     * @param langs A collection of languages for which the terms should be
     * loaded
     */
    void processConcepts(CallbackHandler handler,
            Collection langs);

    /**
     * Process the terms in this ontology by invoking handler's method for each
     * term.
     * 
     * The term passed as an argument is a flyweight object and it's reference
     * should not be saved - use object cloning for that.
     *
     * @param handler the callback handler for processing terms.
     */
    void processTerms(CallbackHandler handler);
}