001// BiblioEntryStatus.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 * It defines information related to the citation itself rather than to the cited resource.
034 * In other words, it represents a status of a record in a bibliographic repository.
035 * </p>
036 *
037 * @author <A HREF="mailto:senger@ebi.ac.uk">Martin Senger</A>
038 * @version $Id$
039 * @since 1.3
040 */
041
042public class BiblioEntryStatus {
043
044    /**
045     * <p>
046     * The dynamic properties may be used to add features related to
047     * the citation itself.  For example, a name of the citation
048     * annotator, or citation version.
049     * </p>
050     *
051     * <p>
052     * The property names should be made available in a controlled
053     * vocabulary named {@link BibRefSupport#ENTRY_PROPERTIES}.
054     * </p>
055     */
056    public Hashtable properties = new Hashtable();
057
058    /**
059     * <p>
060     * It defines when the citation record was added or last modified.
061     * Usually it is used to retrieve new or revised (since a specified date) citations.
062     * </p>
063     *
064     * @see BibRef#date date in BibRef for format discussion
065     */ 
066    public String lastModifiedDate;
067
068    /**
069     * <p>
070     * Some bibliographic repositories consist of several, or even
071     * many, databases.  The subset helps to locate the citation
072     * within the repository.
073     * </p>
074     *
075     * <p>
076     * The possible values of this member should be defined in a
077     * controlled vocabulary named {@link BibRefSupport#REPOSITORY_SUBSETS}.
078     * </p>
079     */
080    public String repositorySubset;
081
082}