Package org.rcsb.cif.schema.core

Class DatabaseRelated

java.lang.Object

org.rcsb.cif.schema.DelegatingCategory.DelegatingCifCoreCategory

org.rcsb.cif.schema.core.DatabaseRelated

All Implemented Interfaces:

Category

@Generated("org.rcsb.cif.schema.generator.SchemaGenerator")
public class DatabaseRelated
extends DelegatingCategory.DelegatingCifCoreCategory

A category of items recording entries in databases that describe the same or related data. Databases wishing to insert their own canonical codes when archiving and delivering data blocks should use items from the DATABASE category.

Nested Class Summary

Nested classes/interfaces inherited from interface org.rcsb.cif.model.Category

Category.EmptyCategory

Field Summary

Fields inherited from class org.rcsb.cif.schema.DelegatingCategory.DelegatingCifCoreCategory

parentBlock

Constructor Summary

Constructors

Constructor	Description
DatabaseRelated(CifCoreBlock parentBlock)

Method Summary

Modifier and Type	Method	Description
StrColumn	getDatabaseId()	An identifier for the database that contains the related dataset.
StrColumn	getEntryCode()	The code used by the database referred to in _database_related.database_id to identify the related dataset.
StrColumn	getId()	An identifer for this database reference
StrColumn	getRelation()	The general relationship of the data in the data block to the dataset referred to in the database.
StrColumn	getSpecialDetails()	Information about the external dataset and relationship not encoded elsewhere.

Methods inherited from class org.rcsb.cif.schema.DelegatingCategory.DelegatingCifCoreCategory

getCategoryName, getColumn, getColumns, getRowCount

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

columns, getColumn, isDefined

Constructor Details

DatabaseRelated

public DatabaseRelated(CifCoreBlock parentBlock)

Method Details

getId

public StrColumn getId()

An identifer for this database reference

Returns:

StrColumn

getDatabaseId

public StrColumn getDatabaseId()

An identifier for the database that contains the related dataset.

Returns:

StrColumn

getEntryCode

public StrColumn getEntryCode()

The code used by the database referred to in _database_related.database_id to identify the related dataset.

Returns:

StrColumn

getRelation

public StrColumn getRelation()

The general relationship of the data in the data block to the dataset referred to in the database.

Returns:

StrColumn

getSpecialDetails

public StrColumn getSpecialDetails()

Information about the external dataset and relationship not encoded elsewhere.

Returns:

StrColumn