com.aliasi.medline
Class Article

java.lang.Object
  extended by com.aliasi.medline.Article

Deprecated. Moved to lingmed sandbox project.

@Deprecated
public class Article
extends Object

An Article represents the content of the Article element of a MEDLINE citation.

An article contains information about the journal in which it is published.

Each article is required to have a title, and its text is returned by the method articleTitle(). Each article also has information about its page numbers within the journal in which it was published, which is returned by the methods pagination() and eLocationIds(). There will be a pagination and zero or more e-locations, or there will be one or more e-locations for each article.

An article optionally contains an abstract, which will be a non-null return value from abstrct(); note the unusual argument naming to avoid conflict with the keyword abstract.

Articles also optionally contain an author list and affiliation for the first author, which will be available as a non-null return values from authorList() and affiliation().

One or more languages in which the text of the article appeared is available from languages(). Note that abstracts, if available, are always in English. For articles not in English, the vernacularTitle() method returns the original title transliterated into the Roman alphabet; for English articles, it returns the empty string.

Some articles contain linkages to sequence databanks. The method dataBankList() returns a list of zero or more such linkages, organized by database.

Some articles contain information about grant funding for the research reported. The method grantList() returns zero or more grant objects.

Each article contains a non-empty list of publication types, available through publicationTypes().

Articles that were published electronically as well as in print also specify the electronic publication date as a non-null value for articleDate().

Since:
LingPipe2.0
Version:
3.9.1
Author:
Bob Carpenter

Method Summary
 Abstract abstrct()
          Deprecated. See class documentation.
 String affiliation()
          Deprecated. Returns the affiliation for the the first author of this article.
 ArticleDate articleDate()
          Deprecated. See class documentation.
 String articleTitle()
          Deprecated. Returns the title of this article.
 String articleTitleText()
          Deprecated. Return the article title without any brackets that may have been added to indicate translation and without any indication of the author having translated it.
 boolean articleTranslated()
          Deprecated. Returns true if the article has been translated from a language other than English.
 AuthorList authorList()
          Deprecated. See class documentation.
 DataBankList dataBankList()
          Deprecated. See class documentation.
 ELocationId[] eLocationIds()
          Deprecated. See class documentation.
 GrantList grantList()
          Deprecated. See class documentation.
 Journal journal()
          Deprecated. See class documentation.
 String[] languages()
          Deprecated. Returns an array of three-letter language abbreviations indicating the language(s) in which the article was published.
 String pagination()
          Deprecated. Returns the page numbering for this article as a string, or null if there is no page numbering for this article if it is electronic only.
 String publicationModel()
          Deprecated. Returns the publication model for this article.
 String[] publicationTypes()
          Deprecated. Returns a complete list of publication types for this article in alphabetical order.
 String toString()
          Deprecated. Returns a string representation of this article.
 String vernacularTitle()
          Deprecated. Returns the title of the article if it was originally published in a language other than English.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

publicationModel

public String publicationModel()
Deprecated. 
Returns the publication model for this article. All articles have one of the following models:
Publication TypeConstant
PrintMedlineCitationSet.PRINT_VALUE
Print-ElectronicMedlineCitationSet.PRINT_ELECTRONIC_VALUE
ElectronicMedlineCitationSet.ELECTRONIC_VALUE
Electronic-PrintMedlineCitationSet.ELECTRONIC_PRINT_VALUE


pagination

public String pagination()
Deprecated. 
Returns the page numbering for this article as a string, or null if there is no page numbering for this article if it is electronic only. Articles without pagination must have at least one electronic location identifier, returned by method eLocationIds().

The pagination is presented without redundant prefixes; for example 212-27 indicates pages 212 to 227. MEDLINE presents a wide range of possible pagination schemes. There may be be alphanumeric page numbering (e.g. P32-4), split pages (e.g. 24-32, 64), pages plus sections (e.g. 176-8 concl or suppl 111-2), Roman numerals (e.g. iii-viii or XC-CIII), or other descriptive content (e.g. 1 p preceding table of contents or [6021 words; 81 paragraphs]).

Returns:
The page numbering for this article as a string.

eLocationIds

@Deprecated
public ELocationId[] eLocationIds()
Deprecated. See class documentation.

Returns zero or more electronic location identifiers for this article. If the return value of pagination() is null, then the list returned by this method will contain at least one element. If pagination is not null, the array of electronic locations may have zero or more elements.

Returns:
The electronic location identifiers for this article.

journal

@Deprecated
public Journal journal()
Deprecated. See class documentation.

Returns a representation of the journal in which this article appeared.

Returns:
The journal in which this article was published.

articleTitle

public String articleTitle()
Deprecated. 
Returns the title of this article. Article titles are always returned in English. A translated title appears wrapped in square brackets (e.g.. [Biological rhythms and human disease] or [Anterior panhypopituitarism after sella turcica fracture (author's trans)]). Note that if the citation is in process, the title will appear as [In Process Citation]. Untranslated titles end with a period unless the article title itself ends with another punctuation mark (e.g. Why is xenon not more widely used for anaesthesia? or The Kleine-Levin syndrome as a neuropsychiatric disorder: a case report.).

Returns:
The title of this article.

articleTranslated

public boolean articleTranslated()
Deprecated. 
Returns true if the article has been translated from a language other than English. The method determines this by inspecting the article title for marking that it has been translated.

Returns:
true if the article has been translated from a language other than English.

articleTitleText

public String articleTitleText()
Deprecated. 
Return the article title without any brackets that may have been added to indicate translation and without any indication of the author having translated it. Note that sentence-final periods may have also been inserted by NLM, but there is no reliable way to remove them without potentially removing periods that ended original titles, such as those ending acronyms.

Returns:
The text of the title of th is article.

abstrct

@Deprecated
public Abstract abstrct()
Deprecated. See class documentation.

Returns the abstract for this article, or null if there is no abstract.

Returns:
The abstract for this article.

authorList

@Deprecated
public AuthorList authorList()
Deprecated. See class documentation.

Returns the author list for this article. Note that this list will not be null, but may be empty. This varies slightly from the XML, which simply elides the author list when it has no members, as in the case of an anonymous article.

Returns:
The author list for this article.

affiliation

public String affiliation()
Deprecated. 
Returns the affiliation for the the first author of this article. The way in which affiliation is recorded has evolved from its introduction in 1988. At one point, it included city information along with state and zip code information for the United States and country information for elsewhere. Later it added the USA for United States-based institutiones. In 1996, the email was added as it appears in the article. As of 2003, first author address is included as it appears in the article.

Returns:
Affiliation information for first author.

languages

public String[] languages()
Deprecated. 
Returns an array of three-letter language abbreviations indicating the language(s) in which the article was published. A complete list of language abbreviations cna be found at:
MEDLINE Language Table

Returns:
The abbreviations of languages in which the article appeared.

dataBankList

@Deprecated
public DataBankList dataBankList()
Deprecated. See class documentation.

Returns an object representing a list of linkages of molecular sequences mentioned in the paper to their accession numbers in a given data bank. This method may return null if there are no linkages.

Returns:
The data bank linkage list for this article.

grantList

@Deprecated
public GrantList grantList()
Deprecated. See class documentation.

Returns the list of agencies and grant identifiers sponsoring the work reporting in this article. This method may return null if no grants are provided.

Returns:
The grant list for this

publicationTypes

public String[] publicationTypes()
Deprecated. 
Returns a complete list of publication types for this article in alphabetical order. A full list of publication types may be found at:
PubMed Help: Publication Types

Returns:
The complete list of publication types for this article.

vernacularTitle

public String vernacularTitle()
Deprecated. 
Returns the title of the article if it was originally published in a language other than English. All vernacular titles are transliterated into Roman characters. May be the empty string if there is no vernacular title.

Returns:
The original language title for this article.

articleDate

@Deprecated
public ArticleDate articleDate()
Deprecated. See class documentation.

Returns the date on which the publisher released an electronic version of this article. This method may return null if there was no electronic publication date supplied by the publisher or if the article was never published electronically.

Returns:
The date on which the publisher produced an electronic version of this article.

toString

public String toString()
Deprecated. 
Returns a string representation of this article.

Overrides:
toString in class Object
Returns:
A string representation of this article.