medlinecitationset.java

一个自然语言处理的Java开源工具包。LingPipe目前已有很丰富的功能

/*
 * LingPipe v. 3.5
 * Copyright (C) 2003-2008 Alias-i
 *
 * This program is licensed under the Alias-i Royalty Free License
 * Version 1 WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the Alias-i
 * Royalty Free License Version 1 for more details.
 *
 * You should have received a copy of the Alias-i Royalty Free License
 * Version 1 along with this program; if not, visit
 * http://alias-i.com/lingpipe/licenses/lingpipe-license-1.txt or contact
 * Alias-i, Inc. at 181 North 11th Street, Suite 401, Brooklyn, NY 11211,
 * [phone].
 */

package com.aliasi.medline;

import java.util.HashSet;
import java.util.Set;


/**
 * The <code>MedlineCitationSet</code> provides static constants for
 * the XML elements, attributes and constant values used in MEDLINE.
 * The current version is for the 2008 MEDLINE baseline and update
 * releases.
 *
 * <P>For more information, see the LingPipe tutorial on parsing MEDLINE.
 *
 * <P>Thorough documentation for the content of a
 * <code>MedlineCitationSet</code> XML document is provided by NLM at:
 *
 * <blockquote>
 * <a
 * href="http://www.nlm.nih.gov/bsd/licensee/data_elements_doc.html"
 * >MEDLINE XML Element Descriptions and Their Attributes</a>.
 * </blockquote>
 *
 * The DTDs for MEDLINE citations are available in the same directory
 * as this file, and the small sample file is available in LingPipe's
 * <code>demos/data</code> directory.  The DTDs and further sample files
 * are available from:
 *
 * <blockquote>
 *  <a href="http://www.nlm.nih.gov/bsd/licensee.html"
 *    >MEDLINE DTDs and Sample Data</a>
 * </blockquote>
 *
 * @author  Bob Carpenter
 * @version 3.3
 * @since   LingPipe2.0
 */
public class MedlineCitationSet {

    // do not allow instances
    private MedlineCitationSet() {
        /* do nothing */
    }

    /**
     * The <code>MedlineCitationSet</code> element.
     */
    public static final String MEDLINE_CITATION_SET_ELT = "MedlineCitationSet";

    /**
     * The <code>MedlineCitation</code> element.
     */
    public static final String MEDLINE_CITATION_ELT = "MedlineCitation";

    /**
     * The <code>PMID</code> element.
     */
    public static final String PMID_ELT = "PMID";

    /**
     * The <code>DateCreated</code> element.
     */
    public static final String DATE_CREATED_ELT = "DateCreated";

    /**
     * The <code>DateCompleted</code> element.
     */
    public static final String DATE_COMPLETED_ELT = "DateCompleted";

    /**
     * The <code>DateRevised</code> element.
     */
    public static final String DATE_REVISED_ELT = "DateRevised";

    /**
     * The <code>Year</code> element.
     */
    public static final String YEAR_ELT = "Year";

    /**
     * The <code>Season</code> element.
     */
    public static final String SEASON_ELT = "Season";

    /**
     * The <code>Month</code> element.
     */
    public static final String MONTH_ELT = "Month";

    /**
     * The <code>Day</code> element.
     */
    public static final String DAY_ELT = "Day";

    /**
     * The <code>MeshHeadingList</code> element.
     */
    public static final String MESH_HEADING_LIST_ELT = "MeshHeadingList";

    /**
     * The <code>MeshHeading</code> element.
     */
    public static final String MESH_HEADING_ELT = "MeshHeading";

    /**
     * The <code>DescriptorName</code> element.
     */
    public static final String DESCRIPTOR_NAME_ELT = "DescriptorName";

    /**
     * The <code>QualifierName</code> element.
     */
    public static final String QUALIFIER_NAME_ELT = "QualifierName";

    /**
     * The <code>CitationSubset</code> element.
     */
    public static final String CITATION_SUBSET_ELT = "CitationSubset";

    /**
     * The <code>Chemical</code> element.
     */
    public static final String CHEMICAL_ELT = "Chemical";

    /**
     * The <code>ChemicalList</code> element.
     */
    public static final String CHEMICAL_LIST_ELT = "ChemicalList";

    /**
     * The <code>RegistryNumber</code> element.
     */
    public static final String REGISTRY_NUMBER_ELT = "RegistryNumber";

    /**
     * The <code>NameOfSubstance</code> element.
     */
    public static final String NAME_OF_SUBSTANCE_ELT = "NameOfSubstance";

    /**
     * The <code>KeywordList</code> element.
     */
    public static final String KEYWORD_LIST_ELT = "KeywordList";

    /**
     * The <code>Keyword</code> element.
     */
    public static final String KEYWORD_ELT = "Keyword";

    /**
     * The <code>GeneralNote</code> element.
     */
    public static final String GENERAL_NOTE_ELT = "GeneralNote";

    /**
     * The <code>GeneSymbol</code> element.
     */
    public static final String GENE_SYMBOL_ELT = "GeneSymbol";

    /**
     * The <code>SpaceFlightMission</code> element.
     */
    public static final String SPACE_FLIGHT_MISSION_ELT = "SpaceFlightMission";

    /**
     * The <code>OtherID</code> element.
     */
    public static final String OTHER_ID_ELT = "OtherID";

    /**
     * The <code>Investigator</code> element.
     */
    public static final String INVESTIGATOR_ELT = "Investigator";

    /**
     * The <code>ForeName</code> element.
     */
    public static final String FORE_NAME_ELT = "ForeName";

    /**
     * The <code>MiddleName</code> element.
     */
    public static final String MIDDLE_NAME_ELT = "MiddleName";

    /**
     * The <code>LastName</code> element.
     */
    public static final String LAST_NAME_ELT = "LastName";

    /**
     * The <code>Initials</code> element.
     */
    public static final String INITIALS_ELT = "Initials";

    /**
     * The <code>Affiliation</code> element.
     */
    public static final String AFFILIATION_ELT = "Affiliation";

    /**
     * The <code>OtherAbstract</code> element.
     */
    public static final String OTHER_ABSTRACT_ELT = "OtherAbstract";

    /**
     * The <code>AbstractText</code> element.
     */
    public static final String ABSTRACT_TEXT_ELT = "AbstractText";

    /**
     * The <code>Note</code> element.
     */
    public static final String NOTE_ELT = "Note";

    /**
     * The <code>RefSource</code> element.
     */
    public static final String REF_SOURCE_ELT = "RefSource";

    /**
     * The <code>MedlineJournalInfo</code> element.
     */
    public static final String MEDLINE_JOURNAL_INFO_ELT = "MedlineJournalInfo";

    /**
     * The <code>MedlineTA</code> element.
     */
    public static final String MEDLINE_TA_ELT = "MedlineTA";

    /**
     * The <code>Country</code> element.
     */
    public static final String COUNTRY_ELT = "Country";

    /**
     * The <code>NlmUniqueID</code> element.
     */
    public static final String NLM_UNIQUE_ID_ELT = "NlmUniqueID";

    /**
     * The <code>Article</code> element.
     */
    public static final String ARTICLE_ELT = "Article";

    /**
     * The <code>MedlinePgn</code> element.
     */
    public static final String MEDLINE_PAGINATION_ELT = "MedlinePgn";

    /**
     * The <code>ELocationId</code> element.
     */
    public static final String E_LOCATION_ID_ELT = "ELocationId";

    /**
     * The <code>StartPage</code> element.
     */
    public static final String START_PAGE_ELT = "StartPage";

    /**
     * The <code>EndPage</code> element.
     */
    public static final String END_PAGE_ELT = "EndPage";

    /**
     * The <code>Journal</code> element.
     */
    public static final String JOURNAL_ELT = "Journal";

    /**
     * The <code>ISSN</code> element.
     */
    public static final String ISSN_ELT = "ISSN";

    /**
     * The <code>ISSNLinking</code> element.
     */
    public static final String ISSN_LINKING_ELT = "ISSNLinking";

    /**
     * The <code>JournalIssue</code> element.
     */
    public static final String JOURNAL_ISSUE_ELT = "JournalIssue";

    /**
     * The <code>Volume</code> element.
     */
    public static final String VOLUME_ELT = "Volume";

    /**
     * The <code>Issue</code> element.
     */
    public static final String ISSUE_ELT = "Issue";


    /**
     * The <code>Author</code> element.
     */
    public static final String AUTHOR_ELT = "Author";

    /**
     * The <code>Publisher</code> element.
     */
    public static final String PUBLISHER_ELT = "Publisher";

    /**
     * The <code>AuthorList</code> element.
     */
    public static final String AUTHOR_LIST_ELT = "AuthorList";

    /**
     * The <code>CollectionTitle</code> element.
     */
    public static final String COLLECTION_TITLE_ELT = "CollectionTitle";

    /**
     * The <code>MedlineDate</code> element.
     */
    public static final String MEDLINE_DATE_ELT = "MedlineDate";

    /**
     * The <code>CommentOn</code> element.
     */
    public static final String COMMENT_ON_ELT = "CommentOn";

    /**
     * The <code>CommentIn</code> element.
     */
    public static final String COMMENT_IN_ELT = "CommentIn";

    /**
     * The <code>ErratumIn</code> element.
     */
    public static final String ERRATUM_IN_ELT = "ErratumIn";

    /**
     * The <code>ErratumFor</code> element.
     */
    public static final String ERRATUM_FOR_ELT = "ErratumFor";

    /**
     * The <code>PartialRetractionOf</code> element.
     */
    public static final String PARTIAL_RETRACTION_OF_ELT = "PartialRetractionOf";

    /**
     * The <code>PartialRetractionIn</code> element.
     */
    public static final String PARTIAL_RETRACTION_IN_ELT = "PartialRetractionIn";

    /**
     * The <code>RepublishedFrom</code> element.
     */
    public static final String REPUBLISHED_FROM_ELT = "RepublishedFrom";

    /**
     * The <code>RepublishedIn</code> element.
     */
    public static final String REPUBLISHED_IN_ELT = "RepublishedIn";

    /**
     * The <code>RetractionOf</code> element.
     */
    public static final String RETRACTION_OF_ELT = "RetractionOf";

    /**
     * The <code>RetractionIn</code> element.
     */
    public static final String RETRACTION_IN_ELT = "RetractionIn";


    /**
     * The <code>UpdateIn</code> element.
     */
    public static final String UPDATE_IN_ELT = "UpdateIn";

    /**
     * The <code>UpdateOf</code> element.
     */
    public static final String UPDATE_OF_ELT = "UpdateOf";

    /**
     * The <code>SummaryForPatientsIn</code> element.
     */
    public static final String SUMMARY_FOR_PATIENTS_IN_ELT
        = "SummaryForPatientsIn";

    /**
     * The <code>OriginalReportIn</code> element.
     */
    public static final String ORIGINAL_REPORT_IN_ELT = "OriginalReportIn";

    /**