001// BiblioJournal.java
002//
003//    senger@ebi.ac.uk
004//    March 2001
005//
006
007/*
008 *                    BioJava development code
009 *
010 * This code may be freely distributed and modified under the
011 * terms of the GNU Lesser General Public Licence.  This should
012 * be distributed with the code.  If you do not have a copy,
013 * see:
014 *
015 *      http://www.gnu.org/copyleft/lesser.html
016 *
017 * Copyright for this code is held jointly by the individual
018 * authors.  These should be listed in @author doc comments.
019 *
020 * For more information on the BioJava project and its aims,
021 * or to join the biojava-l mailing list, visit the home page
022 * at:
023 *
024 *      http://www.biojava.org/
025 *
026 */
027package org.biojava.bibliography;
028
029import java.util.Hashtable;
030
031/**
032 * <p>
033 * A class describing journals. The citations referring to the journal articles
034 * have a reference to this class. There are only few explicit attributes defined,
035 * the rest are accessible using {@link #properties dynamic properties}.
036 * </p>
037 *
038 * @author <A HREF="mailto:senger@ebi.ac.uk">Martin Senger</A>
039 * @version $Id$
040 * @since 1.3
041 */
042
043public class BiblioJournal {
044
045    /**
046     * Additional properties used when the explicit attributes
047     * are not sufficient.
048     */
049    public Hashtable properties = new Hashtable();
050
051    /**
052     * A journal title.
053     * The list of available titles can be provided using a controlled vocabulary,
054     * taken, for example, from
055     * <a href="http://www.ncbi.nlm.nih.gov/PubMed/fulltext.html"> MEDLINE Journals</a>.
056     * Such controlled vocabulary should be named {@link BibRefSupport#JOURNAL_TITLES}.
057     */
058    public String name;
059
060    /**
061     * <p>
062     * A standard number for journals.
063     * </p>
064     *
065     * <p>
066     * Be aware, however, that in the real world even this attribute may change over time.
067     * Therefore, it is not suitable as a primary unique identifier for journals.
068     * </p>
069     */
070    public String issn;
071
072    /**
073     * <p>
074     * An abbreviation of the journal title.
075     * </p>
076     *
077     * <p>
078     * Note that some repositories use more abbreviation systems. For such cases,
079     * use {@link #properties dynamic properties} for additional abbreviations.
080     * </p>
081     *
082     * <p>
083     * An example for biological journals is in
084     * <a href="http://arachne.prl.msu.edu/journams/">Biological Journals and Abbreviations</a>.
085     * </p>
086     *
087     * A controlled vocabulary with abbreviation should be named
088     * {@link BibRefSupport#JOURNAL_ABBREV}.
089     */
090    public String abbreviation;
091
092}