Package org.rcsb.cif.model.generated

Class IhmOrderedEnsemble

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmOrderedEnsemble

All Implemented Interfaces:

Category

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

Data items in the IHM_ORDERED_ENSEMBLE category records the details of the ensembles ordered by time or other order. Ordered ensembles are described as directed graphs with edges between nodes representing models or model groups.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrColumn	getEdgeDescription()	Description of the edge.
IntColumn	getEdgeId()	An identifier that describes an edge in a directed graph, which represents an ordered ensemble.
IntColumn	getModelGroupIdBegin()	The model group id corresponding to the node at the origin of directed edge.
IntColumn	getModelGroupIdEnd()	The model group id corresponding to the node at the end of the directed edge.
StrColumn	getOrderedBy()	The parameter based on which the ordering is carried out.
StrColumn	getProcessDescription()	Description of the ordered process.
IntColumn	getProcessId()	An identifier for the ordered process.
StrColumn	getStepDescription()	Description of the step.
IntColumn	getStepId()	Identifier for a particular step in the ordered process.

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

IhmOrderedEnsemble

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

IhmOrderedEnsemble

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

IhmOrderedEnsemble

public IhmOrderedEnsemble(String name)

Method Detail

getProcessId

public IntColumn getProcessId()

An identifier for the ordered process. Forms the category key together with _ihm_ordered_ensemble.edge_id.

Returns:

IntColumn

getProcessDescription

public StrColumn getProcessDescription()

Description of the ordered process.

Returns:

StrColumn

getEdgeId

public IntColumn getEdgeId()

An identifier that describes an edge in a directed graph, which represents an ordered ensemble. Forms the category key together with _ihm_ordered_ensemble.process_id.

Returns:

IntColumn

getEdgeDescription

public StrColumn getEdgeDescription()

Description of the edge.

Returns:

StrColumn

getStepId

public IntColumn getStepId()

Identifier for a particular step in the ordered process.

Returns:

IntColumn

getStepDescription

public StrColumn getStepDescription()

Description of the step.

Returns:

StrColumn

getOrderedBy

public StrColumn getOrderedBy()

The parameter based on which the ordering is carried out.

Returns:

StrColumn

getModelGroupIdBegin

public IntColumn getModelGroupIdBegin()

The model group id corresponding to the node at the origin of directed edge. This data item is a pointer to _ihm_model_list.model_group_id in the IHM_MODEL_LIST category. If the node involves a single model instead of a collection of models, then the _ihm_model_list.model_group_id is the same as the _ihm_model_list.model_id.

Returns:

IntColumn

getModelGroupIdEnd

public IntColumn getModelGroupIdEnd()

The model group id corresponding to the node at the end of the directed edge. This data item is a pointer to _ihm_model_list.model_group_id in the IHM_MODEL_LIST category. If the node involves a single model instead of a collection of models, then the _ihm_model_list.model_group_id is the same as the _ihm_model_list.model_id.

Returns:

IntColumn