IDMapperClient.java

/*
 Copyright (c) 2006, 2007, The Cytoscape Consortium (www.cytoscape.org)

 The Cytoscape Consortium is:
 - Institute for Systems Biology
 - University of California San Diego
 - Memorial Sloan-Kettering Cancer Center
 - Institut Pasteur
 - Agilent Technologies

 This library is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 any later version.

 This library 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.  The software and
 documentation provided hereunder is on an "as is" basis, and the
 Institute for Systems Biology and the Whitehead Institute
 have no obligations to provide maintenance, support,
 updates, enhancements or modifications.  In no event shall the
 Institute for Systems Biology and the Whitehead Institute
 be liable to any party for direct, indirect, special,
 incidental or consequential damages, including lost profits, arising
 out of the use of this software and its documentation, even if the
 Institute for Systems Biology and the Whitehead Institute
 have been advised of the possibility of such damage.  See
 the GNU Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation,
 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 */

package org.bridgedb.cytoscape.internal;

import org.bridgedb.IDMapper;
import org.bridgedb.IDMapperException;
import org.bridgedb.file.IDMapperFile;
import org.bridgedb.rdb.IDMapperRdb;
import org.bridgedb.webservice.IDMapperWebservice;

/**
 *
 * @author gjj
 */
public interface IDMapperClient {
    public enum ClientType {
        FILE,
        RDB,
        WEBSERVICE,
        OTHER;

        public static ClientType getClientType(IDMapper mapper) {
            if (mapper==null)
                return null;
            if (mapper instanceof IDMapperFile) {
                return FILE;
            } else if (mapper instanceof IDMapperRdb) {
                return RDB;
            } else if (mapper instanceof IDMapperWebservice) {
                return WEBSERVICE;
            }
            return OTHER;
        }
    }

    public String getId(); // client id

    public String getDisplayName();

    public String getConnectionString();

    public void setConnectionString(String connectionString) 
            throws IDMapperException ;

    public IDMapper getIDMapper();
    
    public String getClassString();

    public ClientType getClientType();

    boolean isSelected();

    void setSelected(boolean selected);
}