Package org.rcsb.cif.schema

Class DelegatingCifFile<B extends DelegatingBlock>

java.lang.Object

org.rcsb.cif.schema.DelegatingCifFile<B>

Type Parameters:

B - the type of Block instances according to this schema

All Implemented Interfaces:

CifFile

Direct Known Subclasses:

CifCoreFile, MmCifFile

public abstract class DelegatingCifFile<B extends DelegatingBlock>
extends Object
implements CifFile

The schema is implemented by wrapping a CifFile and all block, category, and column data therein in dedicated classes that provide the schema (category names, column names, and column types) defined by some dictionary.

The implementation achieves this behavior by reimplementing all model interfaces (CifFile, Block, Category, Column) using a delegating approach. Each schema-supporting wraps a schema-unaware instance of the original data. Schemata subclass all model instances and are than able to enumerate all child nodes in the data model and provide appropriate types by additional schema-specific code. Code is generated by SchemaGenerator from dictionary files.

Field Summary

Fields

Modifier and Type	Field	Description
protected CifFile	delegate

Constructor Summary

Constructors

Constructor	Description
DelegatingCifFile(CifFile delegate)

Method Summary

Modifier and Type	Method	Description
List<B>	getBlocks()	Access to all blocks of this file.
B	getFirstBlock()	Convenience function to give access to all data in this file.
protected abstract B	getTypedBlock(Block block)

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

as, asButWithoutValidation, blocks

Field Details

delegate

protected final CifFile delegate

Constructor Details

DelegatingCifFile

public DelegatingCifFile(CifFile delegate)

Method Details

getBlocks

public List<B> getBlocks()

Description copied from interface: CifFile

Access to all blocks of this file.

Specified by:

getBlocks in interface CifFile

Returns:

a list of present blocks

getFirstBlock

public B getFirstBlock()

Convenience function to give access to all data in this file. CifFile does not provide this functionality to give users a subtle indication whether a schema is in place or the model is accessed in the generic, 'low-level' mode.

Returns:

the typed block that wraps all data of this file

getTypedBlock

protected abstract B getTypedBlock(Block block)