c5ef3c2000e3a029e12ad1c1711177809a01a415
[jalview.git] / src / jalview / io / xdb / genbank / GenBankSource.java
1 package jalview.io.xdb.genbank;
2
3 /**
4  * <p>Free-format information including an abbreviated form of the organism
5  * name, sometimes followed by a molecule type. (See section 3.4.10 of the
6  * GenBank release notes for more info.)</p>
7  * <p>Entrez Search Field: Organism [ORGN] </p>
8  * <p>Search Tip: For some organisms that have well-established common names,
9  * such as baker's yeast, mouse, and human, a search for the common name will
10  * yield the same results as a search for the scientific name, e.g., a search
11  * for "baker's yeast" in the organism field retrieves the same number of
12  * documents as "Saccharomyces cerevisiae". This is true because the Organism
13  * field is connected to the NCBI Taxonomy Database, which contains
14  * cross-references between common names, scientific names, and synonyms for
15  * organisms represented in the Sequence databases.</p>
16  * <h1>Organism</h1>
17  * <p>The formal scientific name for the source organism (genus and species,
18  * where appropriate) and its lineage, based on the phylogenetic classification
19  * scheme used in the NCBI Taxonomy Database. If the complete lineage of an
20  * organism is very long, an abbreviated lineage will be shown in the GenBank
21  * record and the complete lineage will be available in the Taxonomy Database.
22  * (See also the /db_xref=taxon:nnnn Feature qualifer, below.)</p>
23  * <p>Entrez Search Field: Organism [ORGN] </p>
24  * <p>Search Tip: You can search the Organism field by any node in the taxonomic
25  * hierarchy, e.g., you can search for the term "Saccharomyces cerevisiae",
26  * "Saccharomycetales", "Ascomycota", etc. to retrieve all the sequences from
27  * organisms in a particular taxon. </p>
28  * 
29  */
30 public class GenBankSource {
31     private String source="";
32     private String organism="";
33     private String taxonomic="";
34
35     public GenBankSource() {
36     }
37
38     @Override
39     public String toString() {
40         return String.format("%s\n\t%s\n\t%s", getSource(), getOrganism(), getTaxonomic());
41     }
42
43     /**
44      * @return the source
45      */
46     public String getSource() {
47         return source;
48     }
49
50     /**
51      * @param source the source to set
52      */
53     public void setSource(String source) {
54         this.source = source;
55     }
56
57     /**
58      * @return the organism
59      */
60     public String getOrganism() {
61         return organism;
62     }
63
64     /**
65      * @param organism the organism to set
66      */
67     public void setOrganism(String organism) {
68         this.organism = organism;
69     }
70
71     /**
72      * @return the taxonomic
73      */
74     public String getTaxonomic() {
75         return taxonomic;
76     }
77
78     /**
79      * @param taxonomic the taxonomic to set
80      */
81     public void setTaxonomic(String taxonomic) {
82         this.taxonomic = taxonomic;
83     }
84
85 }