Package org.rcsb.cif.model.builder

Class BlockBuilderImpl<P extends CifFileBuilder>

java.lang.Object

org.rcsb.cif.model.builder.BlockBuilderImpl<P>

All Implemented Interfaces:

BlockBuilder<P>

Direct Known Subclasses:

CifCoreBlockBuilder, MmCifBlockBuilder

public class BlockBuilderImpl<P extends CifFileBuilder>
extends Object
implements BlockBuilder<P>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Category>	categories
protected P	parent

Constructor Summary

Constructors

Constructor	Description
BlockBuilderImpl(String blockName, P parent)

Method Summary

Modifier and Type	Method	Description
BlockBuilder<P>	addCategory(Category category)	Add a category to this builder.
Block	build()	Build this block as a detached instance.
void	digest(CategoryBuilder<? extends BlockBuilder<P>,P> builder)	A hook to make this instance aware of the data in all child nodes.
CategoryBuilder<? extends BlockBuilder<P>,P>	enterCategory(String categoryName)	Descend 1 level and enter a new Category.
String	getBlockHeader()	The header of this block.
Map<String,Category>	getCategories()	The category map of this builder (and Block about to be created).
P	leaveBlock()	Leave this block and move back to the parent builder at CifFile level.

Methods inherited from class java.lang.Object

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

Field Details

categories

protected final Map<String,Category> categories

parent

protected final P extends CifFileBuilder parent

Constructor Details

BlockBuilderImpl

public BlockBuilderImpl(String blockName, P parent)

Method Details

enterCategory

public CategoryBuilder<? extends BlockBuilder<P>,P> enterCategory(String categoryName)

Description copied from interface: BlockBuilder

Descend 1 level and enter a new Category.

Specified by:

enterCategory in interface BlockBuilder<P extends CifFileBuilder>

Parameters:

categoryName - the name for this category

Returns:

a parent-aware builder instance at category level

getBlockHeader

public String getBlockHeader()

Description copied from interface: BlockBuilder

The header of this block.

Specified by:

getBlockHeader in interface BlockBuilder<P extends CifFileBuilder>

Returns:

a String

getCategories

public Map<String,Category> getCategories()

Description copied from interface: BlockBuilder

The category map of this builder (and Block about to be created).

Specified by:

getCategories in interface BlockBuilder<P extends CifFileBuilder>

Returns:

a map with category names as keys and Category instances as values

digest

public void digest(CategoryBuilder<? extends BlockBuilder<P>,P> builder)

Description copied from interface: BlockBuilder

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

Specified by:

digest in interface BlockBuilder<P extends CifFileBuilder>

Parameters:

builder - the child builder to digest

leaveBlock

public P leaveBlock()

Description copied from interface: BlockBuilder

Leave this block and move back to the parent builder at CifFile level.

Specified by:

leaveBlock in interface BlockBuilder<P extends CifFileBuilder>

Returns:

the parent builder

build

public Block build()

Description copied from interface: BlockBuilder

Build this block as a detached instance.

Specified by:

build in interface BlockBuilder<P extends CifFileBuilder>

Returns:

the Block described by this builder

addCategory

public BlockBuilder<P> addCategory(Category category)

Description copied from interface: BlockBuilder

Add a category to this builder.

Specified by:

addCategory in interface BlockBuilder<P extends CifFileBuilder>

Parameters:

category - some category with data

Returns:

this builder instance