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