Package org.rcsb.cif.model.generated

Class IhmModelList

  • All Implemented Interfaces:
    Category
    @Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmModelList
extends BaseCategory
    Data items in the IHM_MODEL_LIST category record the details of the models being deposited.

    • Constructor Detail

      • IhmModelList

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

      • IhmModelList

        public IhmModelList​(String name)

    • Method Detail

      • getOrdinalId

        public IntColumn getOrdinalId()
        A unique identifier for the model / model group combination.
        Returns:
        IntColumn

      • getModelId

        public IntColumn getModelId()
        A unique identifier for the structural model being deposited.
        Returns:
        IntColumn

      • getModelGroupId

        public IntColumn getModelGroupId()
        An identifier to group structural models into collections or sets. This data item can be used to group models into structural clusters or using other criteria based on experimental data or other relationships such as those belonging to the same state or time stamp. An ensemble of models and its representative can either be grouped together or can be separate groups in the ihm_model_list table. The choice between the two options should be decided based on how the modeling was carried out and how the representative was chosen. If the representative is a member of the ensemble (i.e., best scoring model), then it is recommended that the representative and the ensemble belong to the same model group. If the representative is calculated from the ensemble (i.e., centroid), then it is recommended that the representative be separated into a different group. If the models do not need to be grouped into collections, then the _ihm_model_list.model_group_id is the same as _ihm_model_list.model_id.
        Returns:
        IntColumn

      • getModelName

        public StrColumn getModelName()
        A decsriptive name for the model.
        Returns:
        StrColumn

      • getModelGroupName

        public StrColumn getModelGroupName()
        A decsriptive name for the model group.
        Returns:
        StrColumn

      • getAssemblyId

        public IntColumn getAssemblyId()
        An identifier to the structure assembly corresponding to the model. This data item is a pointer to the _ihm_struct_assembly.assembly_id in the IHM_STRUCT_ASSEMBLY category.
        Returns:
        IntColumn

      • getProtocolId

        public IntColumn getProtocolId()
        An identifier to the modeling protocol that produced the model. This data item is a pointer to the _ihm_modeling_protocol.protocol_id in the IHM_MODELING_PROTOCOL category.
        Returns:
        IntColumn

      • getRepresentationId

        public IntColumn getRepresentationId()
        An identifier to the multi-scale model representation id of the model. This data item is a pointer to the _ihm_model_representation.representation_id in the IHM_MODEL_REPRESENTATION category.
        Returns:
        IntColumn