org.biojava3.ws.alignment
Interface RemotePairwiseAlignmentOutputProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
NCBIQBlastOutputProperties

public interface RemotePairwiseAlignmentOutputProperties
extends Serializable

RemotePairwiseAlignmentOutputProperties: the simplest representation of an object capable of holding output formatting informations to be fed to a RemotePairwiseAlignmentService-implemented object.

Since:
Biojava 3
Author:
Sylvain Foisy, Diploide BioIT

Field Summary
static long serialVersionUID
           
 
Method Summary
 String getOutputOption(String key)
          Method that returns the value associated with the key given in parameter.
 Set<String> getOutputOptions()
          Method to get all keys to the information stored in this object.
 void setOutputOption(String key, String val)
          Method to set the value for a specific output parameter using a key to store in a map.
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

getOutputOption

String getOutputOption(String key)
                       throws Exception
Method that returns the value associated with the key given in parameter.

Parameters:
key - :a String with the required key for this map.
Returns:
a String with the value associated with this key
Throws:
Exception - if key is not in the map of output options.

setOutputOption

void setOutputOption(String key,
                     String val)
Method to set the value for a specific output parameter using a key to store in a map.

Parameters:
key - :the key use to designate the value to be stored
val - :the actual value matched to key

getOutputOptions

Set<String> getOutputOptions()
Method to get all keys to the information stored in this object.

Returns:
a Set with all keys held in this instance of the object