com.hfg.bio.taxonomy.ncbi.NCBITaxonomyDataSource 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.taxonomy.ncbi;


import java.util.Set;

//------------------------------------------------------------------------------
/**
 Interface for an NCBI taxonomy data source used with NCBITaxon.
 
  @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg 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 interface NCBITaxonomyDataSource
{
   /**
    Retrieves the taxon for the specified NCBI taxon id.

    @param inValue the taxon id for the taxon object to retrieve
    @return the taxon object corresponding to the specified id. Returns null if the taxon cannot be found.
    */
   public NCBITaxon getByTaxonId(int inValue);


   /**
    Retrieves the NCBITaxon for the specified common name, scientific name,
    or GenBank common name. Generally there will be a single taxon found for a given
    name, but there are instances where multiple taxons may be found.

    @param inValue the species name (common or scientific) for the taxon object to return
    @return a Set of taxon objects corresponding to the specified name. Returns null if a match cannot be found.
    */
   public Set getByName(String inValue);

}