Package org.rcsb.cif.model.generated

Class IhmExternalReferenceInfo

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmExternalReferenceInfo

All Implemented Interfaces:

Category

@Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmExternalReferenceInfo
extends BaseCategory

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).

Field Summary

Fields inherited from class org.rcsb.cif.model.BaseCategory

isText, textFields

Constructor Summary

Constructors

Constructor	Description
IhmExternalReferenceInfo(String name)
IhmExternalReferenceInfo(String name, int rowCount, Object[] encodedColumns)
IhmExternalReferenceInfo(String name, Map<String,Column> columns)

Method Summary

Modifier and Type	Method	Description
StrColumn	getAssociatedUrl()	The Uniform Resource Locator (URL) corresponding to the external reference (DOI).
StrColumn	getReference()	The external reference or the Digital Object Identifier (DOI).
IntColumn	getReferenceId()	A unique identifier for the external reference.
StrColumn	getReferenceProvider()	The name of the reference provider.
StrColumn	getReferenceType()	The type of external reference.
StrColumn	getRefersTo()	The type of object that the external reference points to, usually a single file or an archive.

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

Constructor Detail

IhmExternalReferenceInfo

public IhmExternalReferenceInfo(String name,
                                Map<String,Column> columns)

IhmExternalReferenceInfo

public IhmExternalReferenceInfo(String name,
                                int rowCount,
                                Object[] encodedColumns)

IhmExternalReferenceInfo

public IhmExternalReferenceInfo(String name)

Method Detail

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