Package org.rcsb.cif.model.generated
Class Citation
- java.lang.Object
-
- org.rcsb.cif.model.BaseCategory
-
- org.rcsb.cif.model.generated.Citation
-
- All Implemented Interfaces:
Category
@Generated("org.rcsb.cif.generator.SchemaGenerator") public class Citation extends BaseCategory
Data items in the CITATION category record details about the literature cited as being relevant to the contents of the data block.
-
-
Field Summary
-
Fields inherited from class org.rcsb.cif.model.BaseCategory
isText, textFields
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StrColumngetAbstract()Abstract for the citation.StrColumngetAbstractIdCAS()The Chemical Abstracts Service (CAS) abstract identifier; relevant for journal articles.StrColumngetBookIdISBN()The International Standard Book Number (ISBN) code assigned to the book cited; relevant for books or book chapters.StrColumngetBookPublisher()The name of the publisher of the citation; relevant for books or book chapters.StrColumngetBookPublisherCity()The location of the publisher of the citation; relevant for books or book chapters.StrColumngetBookTitle()The title of the book in which the citation appeared; relevant for books or book chapters.StrColumngetCoordinateLinkage()_citation.coordinate_linkage states whether this citation is concerned with precisely the set of coordinates given in the data block.StrColumngetCountry()The country of publication; relevant for books and book chapters.StrColumngetDatabaseIdCSD()Identifier ('refcode') of the database record in the Cambridge Structural Database that contains details of the cited structure.IntColumngetDatabaseIdMedline()Accession number used by Medline to categorize a specific bibliographic entry.StrColumngetDetails()A description of special aspects of the relationship of the contents of the data block to the literature item cited.StrColumngetId()The value of _citation.id must uniquely identify a record in the CITATION list.StrColumngetJournalAbbrev()Abbreviated name of the cited journal as given in the Chemical Abstracts Service Source Index.StrColumngetJournalFull()Full name of the cited journal; relevant for journal articles.StrColumngetJournalIdASTM()The American Society for Testing and Materials (ASTM) code assigned to the journal cited (also referred to as the CODEN designator of the Chemical Abstracts Service); relevant for journal articles.StrColumngetJournalIdCSD()The Cambridge Structural Database (CSD) code assigned to the journal cited; relevant for journal articles.StrColumngetJournalIdISSN()The International Standard Serial Number (ISSN) code assigned to the journal cited; relevant for journal articles.StrColumngetJournalIssue()Issue number of the journal cited; relevant for journal articles.StrColumngetJournalVolume()Volume number of the journal cited; relevant for journal articles.StrColumngetLanguage()Language in which the cited article is written.StrColumngetPageFirst()The first page of the citation; relevant for journal articles, books and book chapters.StrColumngetPageLast()The last page of the citation; relevant for journal articles, books and book chapters.StrColumngetPdbxDatabaseIdDOI()Document Object Identifier used by doi.org to uniquely specify bibliographic entry.IntColumngetPdbxDatabaseIdPubMed()Ascession number used by PubMed to categorize a specific bibliographic entry.StrColumngetTitle()The title of the citation; relevant for journal articles, books and book chapters.StrColumngetUnpublishedFlag()Flag to indicate that this citation will not be published.IntColumngetYear()The year of the citation; relevant for journal articles, books and book chapters.-
Methods inherited from class org.rcsb.cif.model.BaseCategory
getBinaryColumn, getCategoryName, getColumn, getColumnNames, getRowCount, isDefined
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.rcsb.cif.model.Category
columnNames, columns, get
-
-
-
-
Method Detail
-
getAbstract
public StrColumn getAbstract()
Abstract for the citation. This is used most when the citation is extracted from a bibliographic database that contains full text or abstract information.- Returns:
- StrColumn
-
getAbstractIdCAS
public StrColumn getAbstractIdCAS()
The Chemical Abstracts Service (CAS) abstract identifier; relevant for journal articles.- Returns:
- StrColumn
-
getBookIdISBN
public StrColumn getBookIdISBN()
The International Standard Book Number (ISBN) code assigned to the book cited; relevant for books or book chapters.- Returns:
- StrColumn
-
getBookPublisher
public StrColumn getBookPublisher()
The name of the publisher of the citation; relevant for books or book chapters.- Returns:
- StrColumn
-
getBookPublisherCity
public StrColumn getBookPublisherCity()
The location of the publisher of the citation; relevant for books or book chapters.- Returns:
- StrColumn
-
getBookTitle
public StrColumn getBookTitle()
The title of the book in which the citation appeared; relevant for books or book chapters.- Returns:
- StrColumn
-
getCoordinateLinkage
public StrColumn getCoordinateLinkage()
_citation.coordinate_linkage states whether this citation is concerned with precisely the set of coordinates given in the data block. If, for instance, the publication described the same structure, but the coordinates had undergone further refinement prior to the creation of the data block, the value of this data item would be 'no'.- Returns:
- StrColumn
-
getCountry
public StrColumn getCountry()
The country of publication; relevant for books and book chapters.- Returns:
- StrColumn
-
getDatabaseIdMedline
public IntColumn getDatabaseIdMedline()
Accession number used by Medline to categorize a specific bibliographic entry.- Returns:
- IntColumn
-
getDetails
public StrColumn getDetails()
A description of special aspects of the relationship of the contents of the data block to the literature item cited.- Returns:
- StrColumn
-
getId
public StrColumn getId()
The value of _citation.id must uniquely identify a record in the CITATION list. The _citation.id 'primary' should be used to indicate the citation that the author(s) consider to be the most pertinent to the contents of the data block. Note that this item need not be a number; it can be any unique identifier.- Returns:
- StrColumn
-
getJournalAbbrev
public StrColumn getJournalAbbrev()
Abbreviated name of the cited journal as given in the Chemical Abstracts Service Source Index.- Returns:
- StrColumn
-
getJournalIdASTM
public StrColumn getJournalIdASTM()
The American Society for Testing and Materials (ASTM) code assigned to the journal cited (also referred to as the CODEN designator of the Chemical Abstracts Service); relevant for journal articles.- Returns:
- StrColumn
-
getJournalIdCSD
public StrColumn getJournalIdCSD()
The Cambridge Structural Database (CSD) code assigned to the journal cited; relevant for journal articles. This is also the system used at the Protein Data Bank (PDB).- Returns:
- StrColumn
-
getJournalIdISSN
public StrColumn getJournalIdISSN()
The International Standard Serial Number (ISSN) code assigned to the journal cited; relevant for journal articles.- Returns:
- StrColumn
-
getJournalFull
public StrColumn getJournalFull()
Full name of the cited journal; relevant for journal articles.- Returns:
- StrColumn
-
getJournalIssue
public StrColumn getJournalIssue()
Issue number of the journal cited; relevant for journal articles.- Returns:
- StrColumn
-
getJournalVolume
public StrColumn getJournalVolume()
Volume number of the journal cited; relevant for journal articles.- Returns:
- StrColumn
-
getLanguage
public StrColumn getLanguage()
Language in which the cited article is written.- Returns:
- StrColumn
-
getPageFirst
public StrColumn getPageFirst()
The first page of the citation; relevant for journal articles, books and book chapters.- Returns:
- StrColumn
-
getPageLast
public StrColumn getPageLast()
The last page of the citation; relevant for journal articles, books and book chapters.- Returns:
- StrColumn
-
getTitle
public StrColumn getTitle()
The title of the citation; relevant for journal articles, books and book chapters.- Returns:
- StrColumn
-
getYear
public IntColumn getYear()
The year of the citation; relevant for journal articles, books and book chapters.- Returns:
- IntColumn
-
getDatabaseIdCSD
public StrColumn getDatabaseIdCSD()
Identifier ('refcode') of the database record in the Cambridge Structural Database that contains details of the cited structure.- Returns:
- StrColumn
-
getPdbxDatabaseIdDOI
public StrColumn getPdbxDatabaseIdDOI()
Document Object Identifier used by doi.org to uniquely specify bibliographic entry.- Returns:
- StrColumn
-
getPdbxDatabaseIdPubMed
public IntColumn getPdbxDatabaseIdPubMed()
Ascession number used by PubMed to categorize a specific bibliographic entry.- Returns:
- IntColumn
-
getUnpublishedFlag
public StrColumn getUnpublishedFlag()
Flag to indicate that this citation will not be published.- Returns:
- StrColumn
-
-