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