Package org.rcsb.cif.schema

Class MmCifSchemaProvider

java.lang.Object

org.rcsb.cif.schema.MmCifSchemaProvider

All Implemented Interfaces:

SchemaProvider<MmCifFile,MmCifFileBuilder>

public class MmCifSchemaProvider
extends Object
implements SchemaProvider<MmCifFile,MmCifFileBuilder>

Provides schema support for mmCIF files.

Constructor Summary

Constructors

Constructor	Description
MmCifSchemaProvider()

Method Summary

Modifier and Type	Method	Description
MmCifFileBuilder	createTypedBuilder()	Create an instance of a schema-supporting builder.
MmCifFile	createTypedFile(CifFile cifFile)	Wrap a CifFile in a schema-supporting implementation of the data model.
void	validate(CifFile cifFile)	Perform an optional check if the provided argument matches this schema.

Methods inherited from class java.lang.Object

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

Constructor Details

MmCifSchemaProvider

public MmCifSchemaProvider()

Method Details

createTypedFile

public MmCifFile createTypedFile(CifFile cifFile)

Description copied from interface: SchemaProvider

Wrap a CifFile in a schema-supporting implementation of the data model.

Specified by:

createTypedFile in interface SchemaProvider<MmCifFile,MmCifFileBuilder>

Parameters:

cifFile - the generic file

Returns:

a schema-aware cif file instance

createTypedBuilder

public MmCifFileBuilder createTypedBuilder()

Description copied from interface: SchemaProvider

Create an instance of a schema-supporting builder.

Specified by:

createTypedBuilder in interface SchemaProvider<MmCifFile,MmCifFileBuilder>

Returns:

a schema-aware builder instance

validate

public void validate(CifFile cifFile) throws SchemaMismatchException

Description copied from interface: SchemaProvider

Perform an optional check if the provided argument matches this schema.

Specified by:

validate in interface SchemaProvider<MmCifFile,MmCifFileBuilder>

Parameters:

cifFile - the CifFile to check

Throws:

SchemaMismatchException - if the argument fails this test