Package org.rcsb.cif.model.generated

Class AtomSitesFootnote

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.AtomSitesFootnote

All Implemented Interfaces:

Category

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

Data items in the ATOM_SITES_FOOTNOTE category record detailed comments about an atom site or a group of atom sites.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrColumn	getId()	A code that identifies the footnote.
StrColumn	getText()	The text of the footnote.

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

AtomSitesFootnote

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

AtomSitesFootnote

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

AtomSitesFootnote

public AtomSitesFootnote(String name)

Method Detail

getId

public StrColumn getId()

A code that identifies the footnote.

Returns:

StrColumn

getText

public StrColumn getText()

The text of the footnote. Footnotes are used to describe an atom site or a group of atom sites in the ATOM_SITE list. For example, footnotes may be used to indicate atoms for which the electron density is very weak, or atoms for which static disorder has been modelled.

Returns:

StrColumn