org.protempa.AlgorithmSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation

Protempa Framework is the core of Protempa.

There is a newer version: 5.2-Alpha-2

/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package org.protempa;

import java.util.List;
import java.util.Set;
import org.protempa.backend.AlgorithmSourceBackendUpdatedEvent;
import org.protempa.backend.asb.AlgorithmSourceBackend;

/**
 *
 * @author Andrew Post
 */
public interface AlgorithmSource extends Source{

    /**
     * Read an algorithm with the given id.
     *
     * @param id an algorithm id {@link String}.
     * @return an {@link Algorithm} object, or null if no algorithm
     * with the specified id exists. If a null id is      * specified, null is returned.
     *
     * @throws AlgorithmSourceReadException when an error occurs in a backend
     * reading the specified algorithm.
     */
    Algorithm readAlgorithm(String id) throws AlgorithmSourceReadException;

    /**
     * Reads all algorithms in this algorithm source.
     *
     * @return an unmodifiable Set of Algorithm
     * objects. Guaranteed not to return null.
     *
     * @throws AlgorithmSourceReadException when an error occurs in a backend
     * reading an algorithm.
     */
    Set readAlgorithms() throws AlgorithmSourceReadException;

}