Package org.rcsb.cif.model.builder

Class CategoryBuilderImpl<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

java.lang.Object

org.rcsb.cif.model.builder.CategoryBuilderImpl<P,PP>

All Implemented Interfaces:

CategoryBuilder<P,PP>

Direct Known Subclasses:

CifCoreCategoryBuilder, MmCifCategoryBuilder

public class CategoryBuilderImpl<P extends BlockBuilder<PP>,PP extends CifFileBuilder>
extends Object
implements CategoryBuilder<P,PP>

Field Summary

Fields

Modifier and Type	Field	Description
protected P	parent

Constructor Summary

Constructors

Constructor	Description
CategoryBuilderImpl(String categoryName, P parent)

Method Summary

Modifier and Type	Method	Description
CategoryBuilder<P,PP>	addColumn(Column<?> column)	Add a column to this builder.
Category	build()	Build this category as a detached instance.
void	digest(FloatColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)	A hook to make this instance aware of the data in all child nodes.
void	digest(IntColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)	A hook to make this instance aware of the data in all child nodes.
void	digest(StrColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)	A hook to make this instance aware of the data in all child nodes.
FloatColumnBuilder<CategoryBuilder<P,PP>,P,PP>	enterFloatColumn(String columnName)	Descend 1 level and enter a new FloatColumn.
IntColumnBuilder<CategoryBuilder<P,PP>,P,PP>	enterIntColumn(String columnName)	Descend 1 level and enter a new IntColumn.
StrColumnBuilder<CategoryBuilder<P,PP>,P,PP>	enterStrColumn(String columnName)	Descend 1 level and enter a new StrColumn.
String	getCategoryName()	The name of this category.
Map<String,Column<?>>	getColumns()	The column map of this builder (and Category about to be created).
P	leaveCategory()	Leave this category and move back to the parent builder at Block level.
void	registerChild(ColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> builder)	Make this builder aware of a child builder at column level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

parent

protected final P extends BlockBuilder<PP> parent

Constructor Details

CategoryBuilderImpl

public CategoryBuilderImpl(String categoryName, P parent)

Method Details

getCategoryName

public String getCategoryName()

Description copied from interface: CategoryBuilder

The name of this category.

Specified by:

getCategoryName in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Returns:

a String

getColumns

public Map<String,Column<?>> getColumns()

Description copied from interface: CategoryBuilder

The column map of this builder (and Category about to be created).

Specified by:

getColumns in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Returns:

a map with column names as keys and Column instances as values

leaveCategory

public P leaveCategory()

Description copied from interface: CategoryBuilder

Leave this category and move back to the parent builder at Block level.

Specified by:

leaveCategory in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Returns:

the parent builder

build

public Category build()

Description copied from interface: CategoryBuilder

Build this category as a detached instance.

Specified by:

build in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Returns:

the Category described by this builder

addColumn

public CategoryBuilder<P,PP> addColumn(Column<?> column)

Description copied from interface: CategoryBuilder

Add a column to this builder.

Specified by:

addColumn in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

column - some column with data

Returns:

this builder instance

digest

public void digest(IntColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)

Description copied from interface: CategoryBuilder

A hook to make this instance aware of the data in all child nodes.

Specified by:

digest in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnBuilder - the child builder to digest

digest

public void digest(FloatColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)

Description copied from interface: CategoryBuilder

A hook to make this instance aware of the data in all child nodes.

Specified by:

digest in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnBuilder - the child builder to digest

digest

public void digest(StrColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> columnBuilder)

Description copied from interface: CategoryBuilder

A hook to make this instance aware of the data in all child nodes.

Specified by:

digest in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnBuilder - the child builder to digest

enterIntColumn

public IntColumnBuilder<CategoryBuilder<P,PP>,P,PP> enterIntColumn(String columnName)

Description copied from interface: CategoryBuilder

Descend 1 level and enter a new IntColumn.

Specified by:

enterIntColumn in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnName - the name for this column

Returns:

a parent-aware builder instance at column level

enterFloatColumn

public FloatColumnBuilder<CategoryBuilder<P,PP>,P,PP> enterFloatColumn(String columnName)

Description copied from interface: CategoryBuilder

Descend 1 level and enter a new FloatColumn.

Specified by:

enterFloatColumn in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnName - the name for this column

Returns:

a parent-aware builder instance at column level

enterStrColumn

public StrColumnBuilder<CategoryBuilder<P,PP>,P,PP> enterStrColumn(String columnName)

Description copied from interface: CategoryBuilder

Descend 1 level and enter a new StrColumn.

Specified by:

enterStrColumn in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

columnName - the name for this column

Returns:

a parent-aware builder instance at column level

registerChild

public void registerChild(ColumnBuilder<? extends CategoryBuilder<P,PP>,P,PP> builder)

Description copied from interface: CategoryBuilder

Make this builder aware of a child builder at column level. This allows for a somewhat more convenient way to add columns to a category in a more concise fashion.

Specified by:

registerChild in interface CategoryBuilder<P extends BlockBuilder<PP>,PP extends CifFileBuilder>

Parameters:

builder - instance to register