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