001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022package org.biojava.nbio.ws.alignment;
023
024import java.io.Serializable;
025import java.util.Set;
026
027/**
028 * RemotePairwiseAlignmentOutputProperties: the simplest representation of an object capable of holding
029 * output formatting informations to be fed to a RemotePairwiseAlignmentService-implemented object.
030 *
031 * @author Sylvain Foisy, Diploide BioIT
032 * @since Biojava 3
033 *
034 *
035 */
036public interface RemotePairwiseAlignmentOutputProperties extends Serializable{
037        /**
038         *
039         */
040        public static final long serialVersionUID = 1L;
041
042        /**
043         * Method that returns the value associated with the key given in parameter.
044         *
045         * @param key :a String with the required key for this map.
046         * @return a String with the value associated with this key
047         * @throws Exception if key is not in the map of output options.
048         */
049        public String getOutputOption(String key) throws Exception;
050
051
052        /**
053         * Method to set the value for a specific output parameter using a key to store in a map.
054         *
055         * @param key :the key use to designate the value to be stored
056         * @param val :the actual value matched to key
057         */
058        public void setOutputOption(String key,String val);
059
060        /**
061         * Method to get all keys to the information stored in this object.
062         *
063         * @return a <code>Set</code> with all keys held in this instance of the object
064         */
065        public Set<String> getOutputOptions();
066}