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     @Override
 131     public String getMap() {
 132         return null;
 133     }
 134
 135     @Override
 136     public String getChromosome() {
 137         return null;
 138     }
 139
 140     @Override
 141     public MolecularSequence getMolecularSequence() {
 142         return _mol_seq;
 143     }
 144
 145     private void addCrossReference( final Accession accession ) {
 146         if ( _cross_references == null ) {
 147             _cross_references = new TreeSet<Accession>();
 148         }
 149         _cross_references.add( accession );
 150     }
 151
 152     private void addGoTerm( final BasicGoTerm g ) {
 153         if ( _go_terms == null ) {
 154             _go_terms = new TreeSet<GoTerm>();
 155         }
 156         _go_terms.add( g );
 157     }
 158
 159     private void setAc( final String ac ) {
 160         if ( _ac == null ) {
 161             _ac = ac;
 162         }
 163     }
 164
 165     private void setMolecularSequence( final MolecularSequence mol_seq ) {
 166         _mol_seq = mol_seq;
 167     }
 168
 169     private void setGeneName( final String gene_name ) {
 170         if ( _gene_name == null ) {
 171             _gene_name = gene_name;
 172         }
 173     }
 174
 175     private void setOsScientificName( final String os_scientific_name ) {
 176         if ( _os_scientific_name == null ) {
 177             _os_scientific_name = os_scientific_name;
 178         }
 179     }
 180
 181     private void setSequenceName( final String name ) {
 182         if ( _name == null ) {
 183             _name = name;
 184         }
 185     }
 186
 187     private void setSequenceSymbol( final String symbol ) {
 188         _symbol = symbol;
 189     }
 190
 191     private void setTaxId( final String tax_id ) {
 192         if ( _tax_id == null ) {
 193             _tax_id = tax_id;
 194         }
 195     }
 196
 197
 198
 199     @Override
 200     public SortedSet<Annotation> getAnnotations() {
 201         return null;
 202     }
 203
 204     public final static SequenceDatabaseEntry createInstance( final List<String> lines ) {
 205         final UniProtEntry e = new UniProtEntry();
 206         boolean saw_sq = false;
 207         final StringBuffer sq_buffer = new StringBuffer();
 208         boolean is_aa = false;
 209         for( final String line : lines ) {
 210             if ( line.startsWith( "AC" ) ) {
 211                 e.setAc( SequenceDbWsTools.extractFromTo( line, "AC", ";" ) );
 212             }
 213             else if ( line.startsWith( "DE" ) && ForesterUtil.isEmpty( e.getSequenceName() ) ) {
 214                 if ( ( line.indexOf( "RecName:" ) > 0 ) && ( line.indexOf( "Full=" ) > 0 ) ) {
 215                     if ( line.indexOf( "{" ) > 0 ) {
 216                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", "{" ) );
 217                     }
 218                     else {
 219                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", ";" ) );
 220                     }
 221                 }
 222                 else if ( ( line.indexOf( "SubName:" ) > 0 ) && ( line.indexOf( "Full=" ) > 0 ) ) {
 223                     if ( line.indexOf( "{" ) > 0 ) {
 224                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", "{" ) );
 225                     }
 226                     else {
 227                         e.setSequenceName( SequenceDbWsTools.extractFromTo( line, "Full=", ";" ) );
 228                     }
 229                 }
 230             }
 231             else if ( line.startsWith( "DE" ) && ForesterUtil.isEmpty( e.getSequenceSymbol() ) ) {
 232                 if ( line.indexOf( "Short=" ) > 0 ) {
 233                     if ( line.indexOf( "{" ) > 0 ) {
 234                         e.setSequenceSymbol( SequenceDbWsTools.extractFromTo( line, "Short=", "{" ) );
 235                     }
 236                     else {
 237                         e.setSequenceSymbol( SequenceDbWsTools.extractFromTo( line, "Short=", ";" ) );
 238                     }
 239                 }
 240             }
 241             else if ( line.startsWith( "GN" ) && ForesterUtil.isEmpty( e.getGeneName() ) ) {
 242                 if ( line.indexOf( "Name=" ) > 0 ) {
 243                     if ( line.indexOf( "{" ) > 0 ) {
 244                         e.setGeneName( SequenceDbWsTools.extractFromTo( line, "Name=", "{" ) );
 245                     }
 246                     else {
 247                         e.setGeneName( SequenceDbWsTools.extractFromTo( line, "Name=", ";" ) );
 248                     }
 249                 }
 250             }
 251             else if ( line.startsWith( "DR" ) ) {
 252                 if ( line.indexOf( "GO;" ) > 0 ) {
 253                     final Matcher m = GO_PATTERN.matcher( line );
 254                     if ( m.find() ) {
 255                         final String id = m.group( 1 );
 256                         final String ns_str = m.group( 2 );
 257                         final String desc = m.group( 3 );
 258                         String gns = GoNameSpace.BIOLOGICAL_PROCESS_STR;
 259                         if ( ns_str.equals( "F" ) ) {
 260                             gns = GoNameSpace.MOLECULAR_FUNCTION_STR;
 261                         }
 262                         else if ( ns_str.equals( "C" ) ) {
 263                             gns = GoNameSpace.CELLULAR_COMPONENT_STR;
 264                         }
 265                         e.addGoTerm( new BasicGoTerm( id, desc, gns, false ) );
 266                     }
 267                 }
 268                 else if ( line.indexOf( "PDB;" ) > 0 ) {
 269                     final Matcher m = PDB_PATTERN.matcher( line );
 270                     if ( m.find() ) {
 271                         e.addCrossReference( new Accession( m.group( 1 ), "PDB", m.group( 2 ) ) );
 272                     }
 273                 }
 274                 else if ( line.indexOf( "KEGG;" ) > 0 ) {
 275                     final Matcher m = KEGG_PATTERN.matcher( line );
 276                     if ( m.find() ) {
 277                         e.addCrossReference( new Accession( m.group( 1 ), "KEGG" ) );
 278                     }
 279                 }
 280                 else if ( line.indexOf( "CTD;" ) > 0 ) {
 281                     final Matcher m = CTD_PATTERN.matcher( line );
 282                     if ( m.find() ) {
 283                         e.addCrossReference( new Accession( m.group( 1 ), "CTD" ) );
 284                     }
 285                 }
 286                 else if ( line.indexOf( "MIM;" ) > 0 ) {
 287                     final Matcher m = MIM_PATTERN.matcher( line );
 288                     if ( m.find() ) {
 289                         e.addCrossReference( new Accession( m.group( 1 ), "MIM" ) );
 290                     }
 291                 }
 292                 else if ( line.indexOf( "Orphanet;" ) > 0 ) {
 293                     final Matcher m = Orphanet_PATTERN.matcher( line );
 294                     if ( m.find() ) {
 295                         e.addCrossReference( new Accession( m.group( 1 ), "Orphanet", m.group( 2 ) ) );
 296                     }
 297                 }
 298                 else if ( line.indexOf( "PharmGKB;" ) > 0 ) {
 299                     final Matcher m = PharmGKB_PATTERN.matcher( line );
 300                     if ( m.find() ) {
 301                         e.addCrossReference( new Accession( m.group( 1 ), "PharmGKB" ) );
 302                     }
 303                 }
 304                 else if ( line.indexOf( "BindingDB;" ) > 0 ) {
 305                     final Matcher m = BindingDB_PATTERN.matcher( line );
 306                     if ( m.find() ) {
 307                         e.addCrossReference( new Accession( m.group( 1 ), "BindingDB" ) );
 308                     }
 309                 }
 310                 else if ( line.indexOf( "DrugBank;" ) > 0 ) {
 311                     final Matcher m = DrugBank_PATTERN.matcher( line );
 312                     if ( m.find() ) {
 313                         e.addCrossReference( new Accession( m.group( 1 ), "DrugBank", m.group( 2 ) ) );
 314                     }
 315                 }
 316                 else if ( line.indexOf( "NextBio;" ) > 0 ) {
 317                     final Matcher m = NextBio_PATTERN.matcher( line );
 318                     if ( m.find() ) {
 319                         e.addCrossReference( new Accession( m.group( 1 ), "NextBio" ) );
 320                     }
 321                 }
 322                 else if ( line.indexOf( "Reactome;" ) > 0 ) {
 323                     final Matcher m = Reactome_PATTERN.matcher( line );
 324                     if ( m.find() ) {
 325                         e.addCrossReference( new Accession( m.group( 1 ), "Reactome", m.group( 2 ) ) );
 326                     }
 327                 }
 328                 else if ( line.indexOf( "HGNC;" ) > 0 ) {
 329                     final Matcher m = HGNC_PATTERN.matcher( line );
 330                     if ( m.find() ) {
 331                         e.addCrossReference( new Accession( m.group( 1 ), "HGNC" ) );
 332                     }
 333                 }
 334             }
 335             else if ( line.startsWith( "OS" ) ) {
 336                 if ( line.indexOf( "(" ) > 0 ) {
 337                     e.setOsScientificName( SequenceDbWsTools.extractFromTo( line, "OS", "(" ) );
 338                 }
 339                 else {
 340                     e.setOsScientificName( SequenceDbWsTools.extractFromTo( line, "OS", "." ) );
 341                 }
 342             }
 343             else if ( line.startsWith( "OX" ) ) {
 344                 if ( line.indexOf( "NCBI_TaxID=" ) > 0 ) {
 345                     final Matcher m = NCBI_TAXID_PATTERN.matcher( line );
 346                     if ( m.find() ) {
 347                         e.setTaxId( m.group( 1 ) );
 348                     }
 349                 }
 350             }
 351             else if ( line.startsWith( "SQ" ) ) {
 352                 saw_sq = true;
 353                 if ( line.contains( "AA;" ) ) {
 354                     is_aa = true;
 355                 }
 356             }
 357             else if ( saw_sq && line.startsWith( " " ) ) {
 358                 sq_buffer.append( line.replaceAll( "\\s+", "" ) );
 359             }
 360         }
 361         if ( sq_buffer.length() > 0 ) {
 362             if ( is_aa ) {
 363                 e.setMolecularSequence( BasicSequence.createAaSequence( e.getAccession(), sq_buffer.toString() ) );
 364             }
 365             else {
 366                 e.setMolecularSequence( BasicSequence.createDnaSequence( e.getAccession(), sq_buffer.toString() ) );
 367             }
 368         }
 369         return e;
 370     }
 371 }