Package org.rcsb.cif.model

Class BaseColumn

java.lang.Object

org.rcsb.cif.model.BaseColumn

All Implemented Interfaces:

Column

Direct Known Subclasses:

FloatColumn, IntColumn, StrColumn

public abstract class BaseColumn
extends Object
implements Column

Method Summary

Modifier and Type	Method	Description
protected abstract String	getBinaryStringData(int row)
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.
boolean	isDefined()	Queries this column whether it is defined.
Stream<ValueKind>	valueKinds()	Stream of all ValueKind annotations.

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

stringData

Method Detail

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. However, values smaller than 0 or larger or equal to the row count will raise exceptions.

Specified by:

getStringData in interface Column

Parameters:

row - index of the element to retrieve

Returns:

the String representation of the corresponding row

getBinaryStringData

protected abstract String getBinaryStringData(int row)

getColumnName

public String getColumnName()

Description copied from interface: Column

The name of this Column.

Specified by:

getColumnName in interface Column

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

Returns:

the length of this Column

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

Parameters:

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

Returns:

the corresponding ValueKind enum entry

valueKinds

public Stream<ValueKind> valueKinds()

Description copied from interface: Column

Stream of all ValueKind annotations.

Specified by:

valueKinds in interface Column

Returns:

a Stream with a number of ValueKinds equal to row count

isDefined

public boolean isDefined()

Description copied from interface: Column

Queries this column whether it is defined. To avoid NullPointerException being thrown left, right, and center, categories and columns not present in a parsed file will be presented by an undefined state.

Specified by:

isDefined in interface Column

Returns:

false if this Column has row count 0 and no data in it