8172d3db636632c35734da32da3a71f2a6eb374c
[jalview.git] / EbiDbEntry.java
1 // $Id:
2 // forester -- software libraries and applications
3 // for genomics and evolutionary biology research.
4 //
5 // Copyright (C) 2010 Christian M Zmasek
6 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
7 // All rights reserved
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 //
23 // Contact: phylosoft @ gmail . com
24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
25
26 package org.forester.ws.seqdb;
27
28 import java.util.List;
29
30 import org.forester.go.GoTerm;
31 import org.forester.phylogeny.data.Accession;
32 import org.forester.util.ForesterUtil;
33
34 public final class EbiDbEntry implements SequenceDatabaseEntry {
35
36     //http://www.ebi.ac.uk/Tools/dbfetch/dbfetch/emb/AAR37336/
37     private String _pa;
38     private String _de;
39     private String _os;
40     private String _tax_id;
41     private String _symbol;
42     private String _provider;
43
44     private EbiDbEntry() {
45     }
46
47     @Override
48     public Object clone() throws CloneNotSupportedException {
49         throw new CloneNotSupportedException();
50     }
51
52     public static SequenceDatabaseEntry createInstanceFromPlainTextForRefSeq( final List<String> lines ) {
53         final EbiDbEntry e = new EbiDbEntry();
54         for( final String line : lines ) {
55             //  System.out.println( "-" + line );
56             if ( line.startsWith( "ACCESSION" ) ) {
57                 e.setPA( DatabaseTools.extract( line, "ACCESSION" ) );
58             }
59             else if ( line.startsWith( "DEFINITION" ) ) {
60                 if ( line.indexOf( "[" ) > 0 ) {
61                     e.setDe( DatabaseTools.extract( line, "DEFINITION", "[" ) );
62                 }
63                 else {
64                     e.setDe( DatabaseTools.extract( line, "DEFINITION" ) );
65                 }
66             }
67             else if ( line.startsWith( "SOURCE" ) ) {
68                 if ( line.indexOf( "(" ) > 0 ) {
69                     e.setOs( DatabaseTools.extract( line, "SOURCE", "(" ) );
70                 }
71                 else {
72                     e.setOs( DatabaseTools.extract( line, "SOURCE" ) );
73                 }
74             }
75         }
76         return e;
77     }
78
79     public static SequenceDatabaseEntry createInstanceFromPlainText( final List<String> lines ) {
80         final EbiDbEntry e = new EbiDbEntry();
81         for( final String line : lines ) {
82             if ( line.startsWith( "PA" ) ) {
83                 e.setPA( DatabaseTools.extract( line, "PA" ) );
84             }
85             else if ( line.startsWith( "DE" ) ) {
86                 e.setDe( DatabaseTools.extract( line, "DE" ) );
87             }
88             else if ( line.startsWith( "OS" ) ) {
89                 if ( line.indexOf( "(" ) > 0 ) {
90                     e.setOs( DatabaseTools.extract( line, "OS", "(" ) );
91                 }
92                 else {
93                     e.setOs( DatabaseTools.extract( line, "OS" ) );
94                 }
95             }
96             else if ( line.startsWith( "OX" ) ) {
97                 if ( line.indexOf( "NCBI_TaxID=" ) > 0 ) {
98                     e.setTaxId( DatabaseTools.extract( line, "NCBI_TaxID=", ";" ) );
99                 }
100             }
101         }
102         return e;
103     }
104
105     @Override
106     public String getAccession() {
107         return _pa;
108     }
109
110     private void setPA( final String pa ) {
111         if ( _pa == null ) {
112             _pa = pa;
113         }
114     }
115
116     @Override
117     public String getSequenceName() {
118         return _de;
119     }
120
121     private void setDe( final String rec_name ) {
122         if ( _de == null ) {
123             _de = rec_name;
124         }
125     }
126
127     @Override
128     public String getTaxonomyScientificName() {
129         return _os;
130     }
131
132     private void setOs( final String os ) {
133         if ( _os == null ) {
134             _os = os;
135         }
136     }
137
138     @Override
139     public String getTaxonomyIdentifier() {
140         return _tax_id;
141     }
142
143     private void setTaxId( final String tax_id ) {
144         if ( _tax_id == null ) {
145             _tax_id = tax_id;
146         }
147     }
148
149     @Override
150     public String getSequenceSymbol() {
151         return _symbol;
152     }
153
154     @Override
155     public boolean isEmpty() {
156         return ( ForesterUtil.isEmpty( getAccession() ) && ForesterUtil.isEmpty( getSequenceName() )
157                 && ForesterUtil.isEmpty( getTaxonomyScientificName() )
158                 && ForesterUtil.isEmpty( getTaxonomyIdentifier() ) && ForesterUtil.isEmpty( getSequenceSymbol() ) );
159     }
160
161     @Override
162     public String getProvider() {
163         return _provider;
164     }
165
166     public void setProvider( final String provider ) {
167         _provider = provider;
168     }
169
170     @Override
171     public String getGeneName() {
172         return null;
173     }
174
175     @Override
176     public List<GoTerm> getGoTerms() {
177         return null;
178     }
179
180     @Override
181     public List<Accession> getCrossReferences() {
182         return null;
183     }
184 }