com.hfg.bio.seq.alignment.blast.BLAST_Program Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.bio.seq.alignment.blast;

import com.hfg.bio.seq.BioSequenceType;

//==============================================================================
/**
 BLAST search programs.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//==============================================================================
// com.hfg XML/HTML Coding Library
//
// 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 (at your option) 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.  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
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//==============================================================================

public enum BLAST_Program
{
   blastn(BioSequenceType.NUCLEIC_ACID,  BioSequenceType.NUCLEIC_ACID, "nucleotide query vs. nucleotide db"),
   blastp(BioSequenceType.PROTEIN,       BioSequenceType.PROTEIN,      "protein query vs. protein db"),
   blastx(BioSequenceType.NUCLEIC_ACID,  BioSequenceType.PROTEIN,      "nucleotide query (translated) vs. protein db"),
   tblastn(BioSequenceType.PROTEIN,      BioSequenceType.NUCLEIC_ACID, "protein query vs. nucleotide db (translated)"),
   tblastx(BioSequenceType.NUCLEIC_ACID, BioSequenceType.NUCLEIC_ACID, "nucleotide query (translated) vs. nucleotide db (translated)");

   BioSequenceType mQueryBioSequenceType;
   BioSequenceType mDBBioSequenceType;
   String mDescription;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   private BLAST_Program(BioSequenceType inQueryBioSequenceType, BioSequenceType inDBBioSequenceType, String inDescription)
   {
      mQueryBioSequenceType = inQueryBioSequenceType;
      mDBBioSequenceType    = inDBBioSequenceType;
      mDescription = inDescription;
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public BioSequenceType getQueryBioSequenceType()
   {
      return mQueryBioSequenceType;
   }

   //---------------------------------------------------------------------------
   public BioSequenceType getDatabaseBioSequenceType()
   {
      return mDBBioSequenceType;
   }

   //---------------------------------------------------------------------------
   public String getDescription()
   {
      return mDescription;
   }

}