org.rcsb.openmms.cifparse
Interface CatLoader

All Known Implementing Classes:

AtomSiteAnisotropCatLoader, AtomSiteCatLoader, AtomSitesAltCatLoader, AtomSitesAltEnsCatLoader, AtomSitesAltGenCatLoader, AtomSitesCatLoader, AtomSitesFootnoteCatLoader, AtomTypeCatLoader, CellCatLoader, CellMeasurementCatLoader, CellMeasurementReflnCatLoader, ChemCompAngleCatLoader, ChemCompAtomCatLoader, ChemCompBondCatLoader, ChemCompCatLoader, ChemCompChirAtomCatLoader, ChemCompChirCatLoader, ChemCompLinkCatLoader, ChemCompPlaneAtomCatLoader, ChemCompPlaneCatLoader, ChemCompTorCatLoader, ChemCompTorValueCatLoader, ChemLinkAngleCatLoader, ChemLinkBondCatLoader, ChemLinkCatLoader, ChemLinkChirAtomCatLoader, ChemLinkChirCatLoader, ChemLinkPlaneAtomCatLoader, ChemLinkPlaneCatLoader, ChemLinkTorCatLoader, ChemLinkTorValueCatLoader, CitationAuthorCatLoader, CitationCatLoader, CitationEditorCatLoader, ComputingCatLoader, DatabaseCatLoader, DatabasePdbCaveatCatLoader, DatabasePdbMatrixCatLoader, DatabasePdbRemarkCatLoader, DatabasePdbRevCatLoader, DatabasePdbRevRecordCatLoader, DatabasePdbTvectCatLoader, DiffrnAttenuatorCatLoader, DiffrnCatLoader, DiffrnDetectorCatLoader, DiffrnMeasurementCatLoader, DiffrnOrientMatrixCatLoader, DiffrnOrientReflnCatLoader, DiffrnRadiationCatLoader, DiffrnRadiationWavelengthCatLoader, DiffrnReflnCatLoader, DiffrnReflnsCatLoader, DiffrnScaleGroupCatLoader, DiffrnSourceCatLoader, DiffrnStandardReflnCatLoader, DiffrnStandardsCatLoader, EntityCatLoader, EntityKeywordsCatLoader, EntityLinkCatLoader, EntityNameComCatLoader, EntityNameSysCatLoader, EntityPolyCatLoader, EntityPolySeqCatLoader, EntitySrcGenCatLoader, EntitySrcNatCatLoader, EntryLinkCatLoader, ExptlCatLoader, ExptlCrystalCatLoader, ExptlCrystalFaceCatLoader, ExptlCrystalGrowCatLoader, ExptlCrystalGrowCompCatLoader, GeomAngleCatLoader, GeomBondCatLoader, GeomCatLoader, GeomContactCatLoader, GeomHbondCatLoader, GeomTorsionCatLoader, PdbxDatabaseMessageCatLoader, PdbxDatabasePdbObsSprCatLoader, PdbxDatabaseProcCatLoader, PdbxDatabaseRelatedCatLoader, PdbxDatabaseRemarkCatLoader, PdbxDatabaseStatusCatLoader, PdbxEntityAssemblyCatLoader, PdbxEntityNameCatLoader, PdbxEntitySrcSynCatLoader, PdbxNmrConstraintsCatLoader, PdbxNmrDetailsCatLoader, PdbxNmrEnsembleCatLoader, PdbxNmrEnsembleRmsCatLoader, PdbxNmrExptlCatLoader, PdbxNmrExptlSampleCatLoader, PdbxNmrExptlSampleConditionsCatLoader, PdbxNmrForceConstantsCatLoader, PdbxNmrRefineCatLoader, PdbxNmrRepresentativeCatLoader, PdbxNmrSampleDetailsCatLoader, PdbxNmrSoftwareCatLoader, PdbxNmrSpectrometerCatLoader, PdbxNonpolySchemeCatLoader, PdbxPolySeqSchemeCatLoader, PdbxPrereleaseSeqCatLoader, PdbxRefineAuxFileCatLoader, PdbxRefineCatLoader, PdbxRefineTlsCatLoader, PdbxRefineTlsGroupCatLoader, PdbxStructSheetHbondCatLoader, PdbxXplorFileCatLoader, PhasingAveragingCatLoader, PhasingCatLoader, PhasingIsomorphousCatLoader, PhasingMadCatLoader, PhasingMadClustCatLoader, PhasingMadExptCatLoader, PhasingMadRatioCatLoader, PhasingMadSetCatLoader, PhasingMirCatLoader, PhasingMirDerCatLoader, PhasingMirDerReflnCatLoader, PhasingMirDerShellCatLoader, PhasingMirDerSiteCatLoader, PhasingMirShellCatLoader, PhasingSetCatLoader, PhasingSetReflnCatLoader, RefineAnalyzeCatLoader, RefineBIsoCatLoader, RefineCatLoader, RefineHistCatLoader, RefineLsRestrCatLoader, RefineLsRestrNcsCatLoader, RefineLsShellCatLoader, RefineOccupancyCatLoader, ReflnCatLoader, ReflnsCatLoader, ReflnsScaleCatLoader, ReflnsShellCatLoader, SoftwareCatLoader, StructAsymCatLoader, StructBiolCatLoader, StructBiolGenCatLoader, StructBiolKeywordsCatLoader, StructBiolViewCatLoader, StructCatLoader, StructConfCatLoader, StructConfTypeCatLoader, StructConnCatLoader, StructConnTypeCatLoader, StructKeywordsCatLoader, StructMonDetailsCatLoader, StructMonNuclCatLoader, StructMonProtCatLoader, StructMonProtCisCatLoader, StructNcsDomCatLoader, StructNcsDomLimCatLoader, StructNcsEnsCatLoader, StructNcsEnsGenCatLoader, StructNcsOperCatLoader, StructRefCatLoader, StructRefSeqCatLoader, StructRefSeqDifCatLoader, StructSheetCatLoader, StructSheetHbondCatLoader, StructSheetOrderCatLoader, StructSheetRangeCatLoader, StructSheetTopologyCatLoader, StructSiteCatLoader, StructSiteGenCatLoader, StructSiteKeywordsCatLoader, StructSiteViewCatLoader, SymmetryCatLoader, SymmetryEquivCatLoader

public interface CatLoader

Base interface for all category loaders. Methods in this interface are called by the builder to pass values to specific categories. For each category, a class that implements a CatLoader is used to handle values parsed in the CIF file. The methods and their parameters are determined by the mmCIF grammer and syntax, e.g. there is no beginLoop() method since the category name is not known when the first "_loop" statement is encountered. The first defineLoopItem (or beginRow) call can however be used a "beginLoop" method. The adjective "single" is used in Category Loaders and Builders to mean Non-loop, i.e. values specified in a CIF file outside of _loop statements.

Version:

1.3

Author:

Douglas S. Greer

Method Summary

void	beginCategory()
void	beginRow()
void	defineLoopItem(java.lang.Object e, int fieldCode)
void	defineSingleItem(java.lang.Object e, int fieldCode)
void	endCompound(java.lang.Object e)
void	endLoop(java.lang.Object e)
void	endRow()
void	insertLoopValue(int fieldCode, java.lang.String value)
void	insertSingleValue(java.lang.Object e, int fieldCode, java.lang.String value)

Method Detail

beginCategory

public void beginCategory()
                   throws CifParseException

CifParseException

endCompound

public void endCompound(java.lang.Object e)
                 throws CifParseException

CifParseException

defineSingleItem

public void defineSingleItem(java.lang.Object e,
                             int fieldCode)
                      throws CifParseException

CifParseException

insertSingleValue

public void insertSingleValue(java.lang.Object e,
                              int fieldCode,
                              java.lang.String value)
                       throws CifParseException

CifParseException

defineLoopItem

public void defineLoopItem(java.lang.Object e,
                           int fieldCode)
                    throws CifParseException

CifParseException

beginRow

public void beginRow()
              throws CifParseException

CifParseException

endRow

public void endRow()
            throws CifParseException

CifParseException

insertLoopValue

public void insertLoopValue(int fieldCode,
                            java.lang.String value)
                     throws CifParseException

CifParseException

endLoop

public void endLoop(java.lang.Object e)
             throws CifParseException

CifParseException