Package org.biojava.nbio.ws.alignment.qblast

Class MapToStringTransformer

  • public class MapToStringTransformer
extends java.lang.Object
    Transforms Map to String. Used by NCBIQBlastService to join given map of arguments to a single String to pass to QBlast service
    Author:
    Gediminas Rimsa

    • Constructor Summary

      Constructors 
      Constructor Description
      MapToStringTransformer()
      Creates MapToStringTransformer with defaults:
      MapToStringTransformer​(java.lang.String mappingSequence, java.lang.String separatorSequence, java.lang.String nullValue)
      Creates MapToStringTransformer with given values

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMappingSequence()  
      java.lang.String getNullValue()  
      java.lang.String getSeparatorSequence()  
      void setMappingSequence​(java.lang.String mappingSequence)  
      void setNullValue​(java.lang.String nullValue)  
      void setSeparatorSequence​(java.lang.String separatorSequence)  
      java.lang.String transform​(java.util.Map<?,​?> map)
      Transforms Map to String, representing every entry as key mappingSequence value , joined by separatorSequence

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MapToStringTransformer

        public MapToStringTransformer()
        Creates MapToStringTransformer with defaults: 
         mappingSequence = "=";
 separatorSequence = "&";
 nullValue = "null";

      • MapToStringTransformer

        public MapToStringTransformer​(java.lang.String mappingSequence,
                              java.lang.String separatorSequence,
                              java.lang.String nullValue)
        Creates MapToStringTransformer with given values
        Parameters:
        mappingSequence - sequence inserted between key and value
        separatorSequence - sequence inserted between every pair of Map entries
        nullValue - sequence inserted for every null key or value

    • Method Detail

      • transform

        public java.lang.String transform​(java.util.Map<?,​?> map)
        Transforms Map to String, representing every entry as key mappingSequence value , joined by separatorSequence

        Calls toString() for keys and values, replacing null with the value of nullValue property

        For example, if we have a map with two entries: ("key1", "1") and ("key2", "2") this method would return "key1=1&key2=2" if mappingSequence is "=" and separator sequence is "&";

        Parameters:
        map - map of arguments
        Returns:
        String resulting string

      • getMappingSequence

        public java.lang.String getMappingSequence()

      • setMappingSequence

        public void setMappingSequence​(java.lang.String mappingSequence)

      • getSeparatorSequence

        public java.lang.String getSeparatorSequence()

      • setSeparatorSequence

        public void setSeparatorSequence​(java.lang.String separatorSequence)

      • getNullValue

        public java.lang.String getNullValue()

      • setNullValue

        public void setNullValue​(java.lang.String nullValue)