001/**
002 * Copyright (C) 2014  Universidade de Aveiro, DETI/IEETA, Bioinformatics Group - http://bioinformatics.ua.pt/
003 *
004 * This file is part of Dicoogle/dicoogle-sdk-ext.
005 *
006 * Dicoogle/dicoogle-sdk-ext is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * Dicoogle/dicoogle-sdk-ext is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with Dicoogle.  If not, see <http://www.gnu.org/licenses/>.
018 */
019package pt.ua.dicoogle.sdk;
020
021import java.util.ArrayList;
022import java.util.Collection;
023import net.xeoh.plugins.base.Plugin;
024import pt.ua.dicoogle.sdk.Utils.TaskQueue;
025import pt.ua.dicoogle.sdk.Utils.TaskRequest;
026import pt.ua.dicoogle.sdk.datastructs.SearchResult;
027import pt.ua.dicoogle.sdk.observables.FileObservable;
028import pt.ua.dicoogle.sdk.observables.ListObservableSearch;
029
030/**
031 *
032 * @author Carlos Ferreira
033 */
034public interface GenericPluginInterface extends Plugin
035{
036    public void attendTask(TaskRequest task);
037    
038    //public ListObservable<TaskRequest> getTaskRequestsList();
039
040    //public ListObservable<SearchResult> getResults();
041
042    public String getName();
043
044    public void initialize(TaskQueue tasks);
045
046    public void Stop();
047
048    /**
049     * Although these methods return an observable, it is mandatory that the local indexes return the array with the results...
050     * @param query
051     * @param extrafields
052     * @return
053     */
054    
055    public ListObservableSearch<SearchResult> search(String query, Collection<String> extrafields);
056    public ListObservableSearch<SearchResult> searchOne(String query, Collection<String> Extrafields, String address);
057    public FileObservable requestFile(String address, String name, String hash);
058
059    public boolean isLocalPlugin();
060
061    public void setDefaultSettings();
062
063    public void setSettings(ArrayList<Object> settings);
064
065    public ArrayList<Object> getPanelInitilizationParams();
066
067    //public PluginPanel getConfigPanel();
068
069    //public void setSettings(PluginPanel settings);
070
071    public boolean isRunning();
072}