001// BiblioScope.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 represent an extent or scope of the content of the cited resource.
034 * It can include spatial location (a place name or geographic co-ordinates),
035 * temporal period (a period label, date, or date range), or both.
036 * Finally, it can have additional dynamic properties such as jurisdiction.
037 * </p>
038 *
039 * @author <A HREF="mailto:senger@ebi.ac.uk">Martin Senger</A>
040 * @version $Id$
041 * @since 1.3
042 */
043public class BiblioScope {
044
045    /**
046     * It may contain additional properties related to the extend or
047     * scope of the cited resource. For example:
048     * <pre>
049     *    jurisdiction => government
050     * </pre>
051     * As with all properties, it is recommended to use a controlled vocabulary.
052     * Such vocabulary should be named {@link BibRefSupport#ATTR_SCOPE}.
053     */
054    public Hashtable properties = new Hashtable();
055
056    /**
057     * <p>
058     * It defines a spatial location of the cited resource.
059     * </p>
060     *
061     * <p>
062     * This specification does not suggest any rules for representing geographical
063     * names but implementations may consider 
064     * <a href="http://shiva.pub.getty.edu/tgn_browser/">Getty Thesaurus of Geographic Names</a>, or
065     * <a href="http://lcweb.loc.gov/marc/countries/">MARC lists of countries</a> and
066     * <a href="http://lcweb.loc.gov/marc/geoareas/">MARC list of geographical areas</a>.
067     * </p>
068     */
069    public String spatialLocation;
070
071    /**
072     * It defines temporal period of the cited resource.
073     * It may be a period label, date, or date range.
074     */
075    public String temporalPeriod;
076
077}
078