eu.eubrazilcc.lvl.core.xml.PubMedXmlBinder.java Source code

Java tutorial

Introduction

Here is the source code for eu.eubrazilcc.lvl.core.xml.PubMedXmlBinder.java

Source

/*
 * Copyright 2014 EUBrazilCC (EU?Brazil Cloud Connect)
 * 
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by 
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * 
 *   http://ec.europa.eu/idabc/eupl
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and 
 * limitations under the Licence.
 * 
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */

package eu.eubrazilcc.lvl.core.xml;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.Lists.newArrayList;
import static org.apache.commons.lang.StringUtils.isNotBlank;

import java.util.List;

import javax.annotation.Nullable;
import javax.xml.bind.JAXBElement;

import eu.eubrazilcc.lvl.core.Reference;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.AccessionNumber;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.DataBank;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.ObjectFactory;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.PubmedArticle;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.PubmedArticleSet;
import eu.eubrazilcc.lvl.core.xml.ncbi.pubmed.Year;

/**
 * NCBI PubMed article XML binding helper.
 * @author Erik Torres <ertorser@upv.es>
 */
public class PubMedXmlBinder extends XmlBinder {

    private static final Class<?>[] SUPPORTED_CLASSES = { PubmedArticleSet.class, PubmedArticle.class };

    public static final ObjectFactory PUBMED_XML_FACTORY = new ObjectFactory();

    public static final PubMedXmlBinder PUBMED_XMLB = new PubMedXmlBinder();

    private PubMedXmlBinder() {
        super(SUPPORTED_CLASSES);
    }

    @Override
    @SuppressWarnings("unchecked")
    protected <T> JAXBElement<T> createType(final T obj) {
        Object element = null;
        Class<? extends Object> clazz = obj.getClass();
        if (clazz.equals(PubmedArticleSet.class)) {
            element = PUBMED_XML_FACTORY.createPubmedArticleSet();
        } else if (clazz.equals(PubmedArticle.class)) {
            element = PUBMED_XML_FACTORY.createPubmedArticle();
        } else {
            throw new IllegalArgumentException("Unsupported type: " + clazz.getCanonicalName());
        }
        return (JAXBElement<T>) element;
    }

    /**
     * Gets the PubMed identifier (PMID) from a PubMed article.
     * @param article - PubMed article
     * @return if found, the PubMed identifier (PMID), otherwise {@code null}.
     */
    public static final @Nullable String getPubMedId(final PubmedArticle article) {
        checkArgument(article != null && article.getMedlineCitation() != null
                && article.getMedlineCitation().getPMID() != null, "Uninitialized or invalid article");
        return isNotBlank(article.getMedlineCitation().getPMID().getvalue())
                ? article.getMedlineCitation().getPMID().getvalue().trim()
                : null;
    }

    public static int getYear(final PubmedArticle article) {
        checkArgument(
                article != null && article.getMedlineCitation() != null
                        && article.getMedlineCitation().getArticle() != null
                        && article.getMedlineCitation().getArticle().getJournal() != null
                        && article.getMedlineCitation().getArticle().getJournal().getJournalIssue() != null
                        && article.getMedlineCitation().getArticle().getJournal().getJournalIssue()
                                .getPubDate() != null
                        && article.getMedlineCitation().getArticle().getJournal().getJournalIssue().getPubDate()
                                .getYearOrMonthOrDayOrSeasonOrMedlineDate() != null
                        && !article.getMedlineCitation().getArticle().getJournal().getJournalIssue().getPubDate()
                                .getYearOrMonthOrDayOrSeasonOrMedlineDate().isEmpty(),
                "Uninitialized or invalid article");
        int year = -1;
        final List<Object> pubDate = article.getMedlineCitation().getArticle().getJournal().getJournalIssue()
                .getPubDate().getYearOrMonthOrDayOrSeasonOrMedlineDate();
        for (final Object obj : pubDate) {
            if (obj instanceof Year) {
                year = Integer.valueOf(((Year) obj).getvalue());
            }
        }
        checkState(year > 1900, "No valid year found");
        return year;
    }

    public static List<String> getSequences(final PubmedArticle article) {
        final List<String> sequences = newArrayList();
        checkArgument(article != null && article.getMedlineCitation() != null
                && article.getMedlineCitation().getArticle() != null, "Uninitialized or invalid article");
        if (article.getMedlineCitation().getArticle().getDataBankList() != null
                && article.getMedlineCitation().getArticle().getDataBankList().getDataBank() != null) {
            final List<DataBank> databanks = article.getMedlineCitation().getArticle().getDataBankList()
                    .getDataBank();
            for (final DataBank db : databanks) {
                if (db != null && "GENBANK".equalsIgnoreCase(db.getDataBankName())
                        && db.getAccessionNumberList() != null
                        && db.getAccessionNumberList().getAccessionNumber() != null) {
                    for (final AccessionNumber an : db.getAccessionNumberList().getAccessionNumber()) {
                        if (isNotBlank(an.getvalue())) {
                            sequences.add(an.getvalue().trim());
                        }
                    }
                }
            }
        }
        return sequences;
    }

    /**
     * Parses a publication reference from a PubMed article.
     * @param article - PubMed article
     * @return a {@link Reference} built from the input PubMed article.
     */
    public static final Reference parseArticle(final PubmedArticle article) {
        checkArgument(article != null, "Uninitialized or invalid article");
        return Reference.builder().title(article.getMedlineCitation().getArticle().getArticleTitle())
                .pubmedId(article.getMedlineCitation().getPMID().getvalue()).publicationYear(getYear(article))
                .article(article).build();
    }

}