Package org.rcsb.cif.model.text

Class TextColumn

java.lang.Object

org.rcsb.cif.model.text.TextColumn

All Implemented Interfaces:

Column<String[]>, StrColumn

public class TextColumn
extends Object
implements StrColumn

Nested Class Summary

Nested classes/interfaces inherited from interface org.rcsb.cif.model.Column

Column.EmptyColumn

Constructor Summary

Constructors

Constructor	Description
TextColumn(String name, int rowCount, String textData, int[] startToken, int[] endToken)

Method Summary

Modifier and Type	Method	Description
String	get(int row)	Type-safe access to the native type of data stored in this column.
String[]	getArray()	Explicitly creates this array by parsing all data in this text column.
String	getColumnName()	The name of this Column.
int	getRowCount()	The number of rows in this Column.
String	getStringData(int row)	Access to entries of this Column without any assumptions about the content type.
ValueKind	getValueKind(int row)	States the ValueKind for a particular row.

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.Column

isDefined, stringData, valueKinds

Methods inherited from interface org.rcsb.cif.model.StrColumn

values

Constructor Details

TextColumn

public TextColumn(String name, int rowCount, String textData, int[] startToken, int[] endToken)

Method Details

getColumnName

public String getColumnName()

Description copied from interface: Column

The name of this Column.

Specified by:

getColumnName in interface Column<String[]>

Returns:

the String which is used to acquire this column from its parent Category

getRowCount

public int getRowCount()

Description copied from interface: Column

The number of rows in this Column. 0 indicates undefined a Column.

Specified by:

getRowCount in interface Column<String[]>

Returns:

the length of this Column

getStringData

public String getStringData(int row)

Description copied from interface: Column

Access to entries of this Column without any assumptions about the content type. No checks about the validity of the row argument are made. Values smaller than 0 or larger or equal to the row count will raise exceptions.

Specified by:

getStringData in interface Column<String[]>

Parameters:

row - index of the element to retrieve

Returns:

the String representation of the corresponding row

getValueKind

public ValueKind getValueKind(int row)

Description copied from interface: Column

States the ValueKind for a particular row. Elements may either be 'present', 'not_specified' (.) or 'unknown' (?).

Specified by:

getValueKind in interface Column<String[]>

Parameters:

row - index of the element for which the ValueKind should be retrieved

Returns:

the corresponding ValueKind enum entry

getArray

public String[] getArray()

Explicitly creates this array by parsing all data in this text column. Don't use this function on for text data - returned array is not cached

Specified by:

getArray in interface Column<String[]>

Returns:

the requested array

get

public String get(int row)

Description copied from interface: StrColumn

Type-safe access to the native type of data stored in this column.

Specified by:

get in interface StrColumn

Parameters:

row - the index to retrieve

Returns:

a String value