Interface RemotePairwiseAlignmentOutputProperties

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    NCBIQBlastOutputProperties

    public interface RemotePairwiseAlignmentOutputProperties
    extends java.io.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

      Fields 
      Modifier and Type Field Description
      static long serialVersionUID  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getOutputOption​(java.lang.String key)
      Method that returns the value associated with the key given in parameter.
      java.util.Set<java.lang.String> getOutputOptions()
      Method to get all keys to the information stored in this object.
      void setOutputOption​(java.lang.String key, java.lang.String val)
      Method to set the value for a specific output parameter using a key to store in a map.
    • Method Detail

      • getOutputOption

        java.lang.String getOutputOption​(java.lang.String key)
                                  throws java.lang.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:
        java.lang.Exception - if key is not in the map of output options.
      • setOutputOption

        void setOutputOption​(java.lang.String key,
                             java.lang.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

        java.util.Set<java.lang.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