forester/java/src/org/forester/ws/seqdb/UniProtEntry.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 import java.util.SortedSet;
  30 import java.util.TreeSet;
  31 import java.util.regex.Matcher;
  32 import java.util.regex.Pattern;
  33
  34 import org.forester.go.BasicGoTerm;
  35 import org.forester.go.GoNameSpace;
  36 import org.forester.go.GoTerm;
  37 import org.forester.phylogeny.data.Accession;
  38 import org.forester.phylogeny.data.Annotation;
  39 import org.forester.sequence.BasicSequence;
  40 import org.forester.sequence.MolecularSequence;
  41 import org.forester.util.ForesterUtil;
  42
  43 public final class UniProtEntry implements SequenceDatabaseEntry {
  44
  45     public final static Pattern  BindingDB_PATTERN  = Pattern.compile( "BindingDB;\\s+([0-9A-Z]+);" );
  46     public final static Pattern  CTD_PATTERN        = Pattern.compile( "CTD;\\s+(\\d+);" );
  47     public final static Pattern  DrugBank_PATTERN   = Pattern.compile( "DrugBank;\\s+([0-9A-Z]+);\\s+([^\\.]+)" );
  48     public final static Pattern  GO_PATTERN         = Pattern.compile( "GO;\\s+(GO:\\d+);\\s+([PFC]):([^;]+);" );
  49     public final static Pattern  KEGG_PATTERN       = Pattern.compile( "KEGG;\\s+([a-z]+:[0-9]+);" );
  50     public final static Pattern  MIM_PATTERN        = Pattern.compile( "MIM;\\s+(\\d+);" );
  51     public final static Pattern  NextBio_PATTERN    = Pattern.compile( "NextBio;\\s+(\\d+);" );
  52     public final static Pattern  Orphanet_PATTERN   = Pattern.compile( "Orphanet;\\s+(\\d+);\\s+([^\\.]+)" );
  53     public final static Pattern  PDB_PATTERN        = Pattern.compile( "PDB;\\s+([0-9A-Z]{4});\\s+([^;]+)" );
  54     public final static Pattern  PharmGKB_PATTERN   = Pattern.compile( "PharmGKB;\\s+([0-9A-Z]+);" );
  55     public final static Pattern  Reactome_PATTERN   = Pattern.compile( "Reactome;\\s+([0-9A-Z]+);\\s+([^\\.]+)" );
  56     public final static Pattern  HGNC_PATTERN       = Pattern.compile( "HGNC;\\s+HGNC:(\\d+);" );
  57     public final static Pattern  NCBI_TAXID_PATTERN = Pattern.compile( "NCBI_TaxID=(\\d+)" );
  58     private String               _ac;
  59     private SortedSet<Accession> _cross_references;
  60     private String               _gene_name;
  61     private SortedSet<GoTerm>    _go_terms;
  62     private String               _name;
  63     private String               _os_scientific_name;
  64     private String               _symbol;
  65     private String               _tax_id;
  66     private MolecularSequence    _mol_seq;
  67
  68     private UniProtEntry() {
  69     }
  70
  71     @Override
  72     public Object clone() throws CloneNotSupportedException {
  73         throw new CloneNotSupportedException();
  74     }
  75
  76     @Override
  77     public String getAccession() {
  78         return _ac;
  79     }
  80
  81     @Override
  82     public SortedSet<Accession> getCrossReferences() {
  83         return _cross_references;
  84     }
  85
  86     @Override
  87     public String getGeneName() {
  88         return _gene_name;
  89     }
  90
  91     @Override
  92     public SortedSet<GoTerm> getGoTerms() {
  93         return _go_terms;
  94     }
  95
  96     @Override
  97     public String getProvider() {
  98         return "uniprot";
  99     }
 100
 101     @Override
 102     public String getSequenceName() {
 103         return _name;
 104     }
 105
 106     @Override
 107     public String getSequenceSymbol() {
 108         return _symbol;
 109     }
 110
 111     @Override
 112     public String getTaxonomyIdentifier() {
 113         return _tax_id;
 114     }
 115
 116     @Override
 117     public String getTaxonomyScientificName() {
 118         return _os_scientific_name;
 119     }
 120
 121     @Override
 122     public boolean isEmpty() {
 123         return ( ForesterUtil.isEmpty( getAccession() ) && ForesterUtil.isEmpty( getSequenceName() )
 124                 && ForesterUtil.isEmpty( getTaxonomyScientificName() ) && ForesterUtil.isEmpty( getSequenceSymbol() )
 125                 && ForesterUtil.isEmpty( getGeneName() ) && ForesterUtil.isEmpty( getTaxonomyIdentifier() )
 126                 && ForesterUtil.isEmpty( getSequenceSymbol() ) && ( ( getGoTerms() == null ) || getGoTerms().isEmpty() ) && ( ( getCrossReferences() == null ) || getCrossReferences()
 127                 .isEmpty() ) );
 128     }
 129
 130     private void addCrossReference( final Accession accession ) {
 131         if ( _cross_references == null ) {
 132             _cross_references = new TreeSet<Accession>();
 133         }
 134         _cross_references.add( accession );
 135     }
 136
 137     private void addGoTerm( final BasicGoTerm g ) {
 138         if ( _go_terms == null ) {
 139             _go_terms = new TreeSet<GoTerm>();
 140         }
 141         _go_terms.add( g );
 142     }
 143
 144     private void setAc( final String ac ) {
 145         if ( _ac == null ) {
 146             _ac = ac;
 147         }
 148     }
 149
 150     private void setMolecularSequence( final MolecularSequence mol_seq ) {
 151         _mol_seq = mol_seq;
 152     }
 153
 154     private void setGeneName( final String gene_name ) {
 155         if ( _gene_name == null ) {
 156             _gene_name = gene_name;
 157         }
 158     }
 159
 160     private void setOsScientificName( final String os_scientific_name ) {
 161         if ( _os_scientific_name == null ) {
 162             _os_scientific_name = os_scientific_name;
 163         }
 164     }
 165
 166     private void setSequenceName( final String name ) {
 167         if ( _name == null ) {
 168             _name = name;
 169         }
 170     }
 171
 172     private void setSequenceSymbol( final String symbol ) {
 173         _symbol = symbol;
 174     }
 175
 176     private void setTaxId( final String tax_id ) {
 177         if ( _tax_id == null ) {
 178             _tax_id = tax_id;
 179         }
 180     }
 181
 182     public static SequenceDatabaseEntry createInstanceFromPlainText( final List<String> lines ) {
 183         final UniProtEntry e = new UniProtEntry();
 184         boolean saw_sq = false;
 185         final StringBuffer sq_buffer = new StringBuffer();
 186         boolean is_aa = false;
 187         for( final String line : lines ) {
 188             if ( line.startsWith( "AC" ) ) {
 189                 e.setAc( SequenceDbWsTools.extractFromTo( line, "AC", ";" ) );
 190             }
 191             else if ( line.startsWith( "DE" ) && ForesterUtil.isEmpty( e.getSequenceName() ) ) {
 192                 if ( ( line.indexOf( "RecName:" ) > 0 ) && ( line.indexOf( "Full=" ) > 0 ) ) {
 193                     if ( line.indexOf( "{" ) > 0 ) {
 194                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", "{" ) );
 195                     }
 196                     else {
 197                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", ";" ) );
 198                     }
 199                 }
 200                 else if ( ( line.indexOf( "SubName:" ) > 0 ) && ( line.indexOf( "Full=" ) > 0 ) ) {
 201                     if ( line.indexOf( "{" ) > 0 ) {
 202                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", "{" ) );
 203                     }
 204                     else {
 205                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", ";" ) );
 206                     }
 207                 }
 208             }
 209             else if ( line.startsWith( "DE" ) && ForesterUtil.isEmpty( e.getSequenceSymbol() ) ) {
 210                 if ( line.indexOf( "Short=" ) > 0 ) {
 211                     if ( line.indexOf( "{" ) > 0 ) {
 212                         e.setSequenceSymbol( SequenceDbWsTools.extractFromTo( line, "Short=", "{" ) );
 213                     }
 214                     else {
 215                         e.setSequenceSymbol( SequenceDbWsTools.extractFromTo( line, "Short=", ";" ) );
 216                     }
 217                 }
 218             }
 219             else if ( line.startsWith( "GN" ) && ForesterUtil.isEmpty( e.getGeneName() ) ) {
 220                 if ( line.indexOf( "Name=" ) > 0 ) {
 221                     if ( line.indexOf( "{" ) > 0 ) {
 222                         e.setGeneName( SequenceDbWsTools.extractFromTo( line, "Name=", "{" ) );
 223                     }
 224                     else {
 225                         e.setGeneName( SequenceDbWsTools.extractFromTo( line, "Name=", ";" ) );
 226                     }
 227                 }
 228             }
 229             else if ( line.startsWith( "DR" ) ) {
 230                 if ( line.indexOf( "GO;" ) > 0 ) {
 231                     final Matcher m = GO_PATTERN.matcher( line );
 232                     if ( m.find() ) {
 233                         final String id = m.group( 1 );
 234                         final String ns_str = m.group( 2 );
 235                         final String desc = m.group( 3 );
 236                         String gns = GoNameSpace.BIOLOGICAL_PROCESS_STR;
 237                         if ( ns_str.equals( "F" ) ) {
 238                             gns = GoNameSpace.MOLECULAR_FUNCTION_STR;
 239                         }
 240                         else if ( ns_str.equals( "C" ) ) {
 241                             gns = GoNameSpace.CELLULAR_COMPONENT_STR;
 242                         }
 243                         e.addGoTerm( new BasicGoTerm( id, desc, gns, false ) );
 244                     }
 245                 }
 246                 else if ( line.indexOf( "PDB;" ) > 0 ) {
 247                     final Matcher m = PDB_PATTERN.matcher( line );
 248                     if ( m.find() ) {
 249                         e.addCrossReference( new Accession( m.group( 1 ), "PDB", m.group( 2 ) ) );
 250                     }
 251                 }
 252                 else if ( line.indexOf( "KEGG;" ) > 0 ) {
 253                     final Matcher m = KEGG_PATTERN.matcher( line );
 254                     if ( m.find() ) {
 255                         e.addCrossReference( new Accession( m.group( 1 ), "KEGG" ) );
 256                     }
 257                 }
 258                 else if ( line.indexOf( "CTD;" ) > 0 ) {
 259                     final Matcher m = CTD_PATTERN.matcher( line );
 260                     if ( m.find() ) {
 261                         e.addCrossReference( new Accession( m.group( 1 ), "CTD" ) );
 262                     }
 263                 }
 264                 else if ( line.indexOf( "MIM;" ) > 0 ) {
 265                     final Matcher m = MIM_PATTERN.matcher( line );
 266                     if ( m.find() ) {
 267                         e.addCrossReference( new Accession( m.group( 1 ), "MIM" ) );
 268                     }
 269                 }
 270                 else if ( line.indexOf( "Orphanet;" ) > 0 ) {
 271                     final Matcher m = Orphanet_PATTERN.matcher( line );
 272                     if ( m.find() ) {
 273                         e.addCrossReference( new Accession( m.group( 1 ), "Orphanet", m.group( 2 ) ) );
 274                     }
 275                 }
 276                 else if ( line.indexOf( "PharmGKB;" ) > 0 ) {
 277                     final Matcher m = PharmGKB_PATTERN.matcher( line );
 278                     if ( m.find() ) {
 279                         e.addCrossReference( new Accession( m.group( 1 ), "PharmGKB" ) );
 280                     }
 281                 }
 282                 else if ( line.indexOf( "BindingDB;" ) > 0 ) {
 283                     final Matcher m = BindingDB_PATTERN.matcher( line );
 284                     if ( m.find() ) {
 285                         e.addCrossReference( new Accession( m.group( 1 ), "BindingDB" ) );
 286                     }
 287                 }
 288                 else if ( line.indexOf( "DrugBank;" ) > 0 ) {
 289                     final Matcher m = DrugBank_PATTERN.matcher( line );
 290                     if ( m.find() ) {
 291                         e.addCrossReference( new Accession( m.group( 1 ), "DrugBank", m.group( 2 ) ) );
 292                     }
 293                 }
 294                 else if ( line.indexOf( "NextBio;" ) > 0 ) {
 295                     final Matcher m = NextBio_PATTERN.matcher( line );
 296                     if ( m.find() ) {
 297                         e.addCrossReference( new Accession( m.group( 1 ), "NextBio" ) );
 298                     }
 299                 }
 300                 else if ( line.indexOf( "Reactome;" ) > 0 ) {
 301                     final Matcher m = Reactome_PATTERN.matcher( line );
 302                     if ( m.find() ) {
 303                         e.addCrossReference( new Accession( m.group( 1 ), "Reactome", m.group( 2 ) ) );
 304                     }
 305                 }
 306                 else if ( line.indexOf( "HGNC;" ) > 0 ) {
 307                     final Matcher m = HGNC_PATTERN.matcher( line );
 308                     if ( m.find() ) {
 309                         e.addCrossReference( new Accession( m.group( 1 ), "HGNC" ) );
 310                     }
 311                 }
 312             }
 313             else if ( line.startsWith( "OS" ) ) {
 314                 if ( line.indexOf( "(" ) > 0 ) {
 315                     e.setOsScientificName( SequenceDbWsTools.extractFromTo( line, "OS", "(" ) );
 316                 }
 317                 else {
 318                     e.setOsScientificName( SequenceDbWsTools.extractFromTo( line, "OS", "." ) );
 319                 }
 320             }
 321             else if ( line.startsWith( "OX" ) ) {
 322                 if ( line.indexOf( "NCBI_TaxID=" ) > 0 ) {
 323                     final Matcher m = NCBI_TAXID_PATTERN.matcher( line );
 324                     if ( m.find() ) {
 325                         e.setTaxId( m.group( 1 ) );
 326                     }
 327                 }
 328             }
 329             else if ( line.startsWith( "SQ" ) ) {
 330                 saw_sq = true;
 331                 if ( line.contains( "AA;" ) ) {
 332                     is_aa = true;
 333                 }
 334             }
 335             else if ( saw_sq && line.startsWith( " " ) ) {
 336                 sq_buffer.append( line.replaceAll( "\\s+", "" ) );
 337             }
 338         }
 339         if ( sq_buffer.length() > 0 ) {
 340             if ( is_aa ) {
 341                 e.setMolecularSequence( BasicSequence.createAaSequence( e.getAccession(), sq_buffer.toString() ) );
 342             }
 343             else {
 344                 e.setMolecularSequence( BasicSequence.createDnaSequence( e.getAccession(), sq_buffer.toString() ) );
 345             }
 346         }
 347         return e;
 348     }
 349
 350     @Override
 351     public SortedSet<Annotation> getAnnotations() {
 352         return null;
 353     }
 354
 355     @Override
 356     public String getMap() {
 357         return null;
 358     }
 359
 360     @Override
 361     public String getChromosome() {
 362         return null;
 363     }
 364
 365     @Override
 366     public MolecularSequence getMolecularSequence() {
 367         return _mol_seq;
 368     }
 369 }