Package org.rcsb.cif.model.generated

Class PdbxChemCompDepositorInfo

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.PdbxChemCompDepositorInfo

All Implemented Interfaces:

Category

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

Data items in the PDBX_CHEM_COMP_DEPOSITOR_INFO category record additional details provided by depositors about deposited chemical components.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrColumn	getAltCompId()	The alternate chemical component identifier matching the deposited chemical component.
StrColumn	getCompId()	The chemical component identifier used by the depositor to represent this component.
StrColumn	getDescriptor()	This data item contains the descriptor value for this component.
StrColumn	getDescriptorType()	This data item contains the descriptor type.
StrColumn	getDetails()	This data item contains additional details about this component.
StrColumn	getFormula()	The formula for the chemical component.
StrColumn	getInDictionaryFlag()	A flag to indicate if the chemical component is defined in the chemical component dictionary.
StrColumn	getName()	The chemical name of the component.
IntColumn	getOrdinal()	Ordinal index for this category.
StrColumn	getType()	This data item contains the chemical component type.

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

PdbxChemCompDepositorInfo

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

PdbxChemCompDepositorInfo

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

PdbxChemCompDepositorInfo

public PdbxChemCompDepositorInfo(String name)

Method Detail

getOrdinal

public IntColumn getOrdinal()

Ordinal index for this category.

Returns:

IntColumn

getCompId

public StrColumn getCompId()

The chemical component identifier used by the depositor to represent this component.

Returns:

StrColumn

getAltCompId

public StrColumn getAltCompId()

The alternate chemical component identifier matching the deposited chemical component.

Returns:

StrColumn

getName

public StrColumn getName()

The chemical name of the component.

Returns:

StrColumn

getFormula

public StrColumn getFormula()

The formula for the chemical component. Formulae are written according to the following rules: (1) Only recognized element symbols may be used. (2) Each element symbol is followed by a 'count' number. A count of '1' may be omitted. (3) A space or parenthesis must separate each cluster of (element symbol + count), but in general parentheses are not used. (4) The order of elements depends on whether carbon is present or not. If carbon is present, the order should be: C, then H, then the other elements in alphabetical order of their symbol. If carbon is not present, the elements are listed purely in alphabetic order of their symbol. This is the 'Hill' system used by Chemical Abstracts.

Returns:

StrColumn

getType

public StrColumn getType()

This data item contains the chemical component type.

Returns:

StrColumn

getDescriptor

public StrColumn getDescriptor()

This data item contains the descriptor value for this component.

Returns:

StrColumn

getDescriptorType

public StrColumn getDescriptorType()

This data item contains the descriptor type.

Returns:

StrColumn

getInDictionaryFlag

public StrColumn getInDictionaryFlag()

A flag to indicate if the chemical component is defined in the chemical component dictionary.

Returns:

StrColumn

getDetails

public StrColumn getDetails()

This data item contains additional details about this component.

Returns:

StrColumn