StructSheetOrder (ciftools-java 0.7.1 API)

java.lang.Object
- org.rcsb.cif.model.BaseCategory
- - org.rcsb.cif.model.generated.StructSheetOrder

All Implemented Interfaces:

Category
```
@Generated("org.rcsb.cif.generator.SchemaGenerator")
public class StructSheetOrder
extends BaseCategory
```
Data items in the STRUCT_SHEET_ORDER category record details about the order of the residue ranges that form a beta-sheet. All order links are pairwise and the specified pairs are assumed to be adjacent to one another in the sheet. These data items are an alternative to the STRUCT_SHEET_TOPOLOGY data items and they allow all manner of sheets to be described.

Field Summary
- Fields inherited from class org.rcsb.cif.model.BaseCategory
  isText, textFields

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IntColumn`	`getOffset()`	Designates the relative position in the sheet, plus or minus, of the second residue range to the first.
`StrColumn`	`getRangeId1()`	This data item is a pointer to _struct_sheet_range.id in the STRUCT_SHEET_RANGE category.
`StrColumn`	`getRangeId2()`	This data item is a pointer to _struct_sheet_range.id in the STRUCT_SHEET_RANGE category.
`StrColumn`	`getSense()`	A flag to indicate whether the two designated residue ranges are parallel or antiparallel to one another.
`StrColumn`	`getSheetId()`	This data item is a pointer to _struct_sheet.id in the STRUCT_SHEET category.

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
  - StructSheetOrder
```
public StructSheetOrder(String name,
                        Map<String,Column> columns)
```
  - StructSheetOrder
```
public StructSheetOrder(String name,
                        int rowCount,
                        Object[] encodedColumns)
```
  - StructSheetOrder
```
public StructSheetOrder(String name)
```
- Method Detail
  - getOffset
```
public IntColumn getOffset()
```
    Designates the relative position in the sheet, plus or minus, of the second residue range to the first.
    
    Returns:
    
    IntColumn
  - getRangeId1
```
public StrColumn getRangeId1()
```
    This data item is a pointer to _struct_sheet_range.id in the STRUCT_SHEET_RANGE category.
    
    Returns:
    
    StrColumn
  - getRangeId2
```
public StrColumn getRangeId2()
```
    This data item is a pointer to _struct_sheet_range.id in the STRUCT_SHEET_RANGE category.
    
    Returns:
    
    StrColumn
  - getSense
```
public StrColumn getSense()
```
    A flag to indicate whether the two designated residue ranges are parallel or antiparallel to one another.
    
    Returns:
    
    StrColumn
  - getSheetId
```
public StrColumn getSheetId()
```
    This data item is a pointer to _struct_sheet.id in the STRUCT_SHEET category.
    
    Returns:
    
    StrColumn