Package org.rcsb.cif.schema.mm

Class IhmExternalReferenceInfo

java.lang.Object
org.rcsb.cif.schema.DelegatingCategory
org.rcsb.cif.schema.mm.IhmExternalReferenceInfo
All Implemented Interfaces:
Category
@Generated("org.rcsb.cif.schema.generator.SchemaGenerator")
public class IhmExternalReferenceInfo
extends DelegatingCategory
Category holds links to other external data sources for the I/H model entry. Input datasets held in other databases such as EMDB, BMRB, SASBDB etc. are referenced in the IHM_DATASET_RELATED_DB_REFERENCE category. This data category, along with IHM_EXTERNAL_FILES category, holds information regarding other non-database external data sources, such as DOIs (digital object identifiers) or supplementary files stored locally. The DOIs can either lead to the external data file(s) directly (as in case of DOIs provided by the PDB) or might lead to an HTML landing page (as provided by Zenodo). In the latter case, additional URL (Uniform Resource Locator) information is required to retrieve the external data file(s).

  • Constructor Details

  • Method Details

    • createDelegate

      protected Column createDelegate​(String columnName, Column column)
      Overrides:
      createDelegate in class DelegatingCategory

    • getReferenceId

      public IntColumn getReferenceId()
      A unique identifier for the external reference.
      Returns:
      IntColumn

    • getReferenceProvider

      public StrColumn getReferenceProvider()
      The name of the reference provider.
      Returns:
      StrColumn

    • getReferenceType

      public StrColumn getReferenceType()
      The type of external reference. Currently, only Digital Object Identifiers (DOIs) and supplementary files stored locally are supported.
      Returns:
      StrColumn

    • getReference

      public StrColumn getReference()
      The external reference or the Digital Object Identifier (DOI). This field is not relevant for local files.
      Returns:
      StrColumn

    • getRefersTo

      public StrColumn getRefersTo()
      The type of object that the external reference points to, usually a single file or an archive.
      Returns:
      StrColumn

    • getAssociatedUrl

      public StrColumn getAssociatedUrl()
      The Uniform Resource Locator (URL) corresponding to the external reference (DOI). This URL should link to the corresponding downloadable file or archive and is provided to enable automated software to download the referenced file or archive.
      Returns:
      StrColumn

    • getDetails

      public StrColumn getDetails()
      Additional details regarding the external reference.
      Returns:
      StrColumn