Data Model version 2.0.6
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: Entry


    Deposition (entry) for deposition into BMRB (NB may be used also for other depositions?).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nmrEntryStore to class NmrEntryStore
Main key: name
Mandatory Attributes: name
Known Subclasses: None
Children:
link entryMolecules to class EntryMolecule
link relatedEntries to class RelatedEntry
Constructor: newObj = Entry( nmrEntryStore,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
bmrbProcessing Text 0..1 BioMagResBank processing information  
details String 0..1 Free text, for notes, explanatory comments, etc.  
entryType EntryType 1..1 Type of NMR study in the entry  
experimentListDetails Text 0..1 Commens etc. to experiment list  
keywords Line 0..* Keywords for searching on Entry  
name Line 1..1 name of Entry  
title Text 0..1 Official title of Entry  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
authors ccp.api.general.Affiliation.Person 0..* Authors of entry.  
contactPersons ccp.api.general.Affiliation.Person 0..* Contact persons for entry  
derivedDataLists ccp.api.nmr.Nmr.DerivedDataList 0..* Derived Nmr data lists relevant for Entry  
entryMolecules EntryMolecule 0..* (Child link). child link to class EntryMolecule  
experiments ccp.api.nmr.Nmr.Experiment 0..* Nmr Experiments included in Entry  
laboratories ccp.api.general.Affiliation.Group 0..* Research groups originating the entry  
measurementLists ccp.api.nmr.Nmr.AbstractMeasurementList 0..* Measurement lists included in Entry  
molSystem ccp.api.molecule.MolSystem.MolSystem 0..1 MolSystem definign the entry  
nmrEntryStore NmrEntryStore 1..1 (Parent link). parent link  
nmrProbes ccp.api.general.Instrument.NmrProbe 0..* Derived. Nmr Probes used for Experiments for this entry - convenience link  
nmrSpectrometers ccp.api.general.Instrument.NmrSpectrometer 0..* Derived. Nmr Spectrometers used for experiments in this entry (convenience link)  
otherCitations ccp.api.general.Citation.Citation 0..* Other (non-primary) citations for entry  
parent NmrEntryStore 1..1 link to parent object - synonym for nmrEntryStore  
peakLists ccp.api.nmr.Nmr.PeakList 0..* Nmr.Peaklists that are part of Entry  
primaryCitation ccp.api.general.Citation.Citation 0..1 Primary citation for BMRB entry  
relatedEntries RelatedEntry 0..* (Child link). child link to class RelatedEntry  
software ccp.api.general.Method.Software 0..* software used for analysis in entry  
structureAnalyses ccp.api.nmr.Nmr.StructureAnalysis 0..* StructureAnalyses being deposited in entry.  
structureGenerations ccp.api.nmr.Nmr.StructureGeneration 0..* StructureGenerations being deposited in entry.  
structureGroups ccp.api.molecule.MolSystem.StructureGroup 0..* Groups of structures included in Entry.  
study Study 0..1 Study that Entry is part of  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
bmrbProcessing
getBmrbProcessing Text -
setBmrbProcessing - Text
details
getDetails String -
setDetails - String
entryType
getEntryType EntryType -
setEntryType - EntryType
experimentListDetails
getExperimentListDetails Text -
setExperimentListDetails - Text
keywords
getKeywords Line Tuple -
setKeywords - Line List
addKeyword - Line
removeKeyword - Line
name
getName Line -
setName - Line
title
getTitle Text -
setTitle - Text

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
authors
getAuthors ccp.api.general.Affiliation.Person Tuple -
setAuthors - ccp.api.general.Affiliation.Person List
addAuthor - ccp.api.general.Affiliation.Person
removeAuthor - ccp.api.general.Affiliation.Person
findFirstAuthor ccp.api.general.Affiliation.Person keyword=value pairs
findAllAuthors ccp.api.general.Affiliation.Person List keyword=value pairs
contactPersons
getContactPersons ccp.api.general.Affiliation.Person Set -
setContactPersons - ccp.api.general.Affiliation.Person Set
sortedContactPersons ccp.api.general.Affiliation.Person List -
addContactPerson - ccp.api.general.Affiliation.Person
removeContactPerson - ccp.api.general.Affiliation.Person
findFirstContactPerson ccp.api.general.Affiliation.Person keyword=value pairs
findAllContactPersons ccp.api.general.Affiliation.Person Set keyword=value pairs
derivedDataLists
getDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList Set -
setDerivedDataLists - ccp.api.nmr.Nmr.DerivedDataList Set
sortedDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList List -
addDerivedDataList - ccp.api.nmr.Nmr.DerivedDataList
removeDerivedDataList - ccp.api.nmr.Nmr.DerivedDataList
findFirstDerivedDataList ccp.api.nmr.Nmr.DerivedDataList keyword=value pairs
findAllDerivedDataLists ccp.api.nmr.Nmr.DerivedDataList Set keyword=value pairs
entryMolecules
getEntryMolecules EntryMolecule Set -
sortedEntryMolecules EntryMolecule List -
findFirstEntryMolecule EntryMolecule keyword=value pairs
findAllEntryMolecules EntryMolecule Set keyword=value pairs
experiments
getExperiments ccp.api.nmr.Nmr.Experiment Set -
setExperiments - ccp.api.nmr.Nmr.Experiment Set
sortedExperiments ccp.api.nmr.Nmr.Experiment List -
addExperiment - ccp.api.nmr.Nmr.Experiment
removeExperiment - ccp.api.nmr.Nmr.Experiment
findFirstExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
laboratories
getLaboratories ccp.api.general.Affiliation.Group Set -
setLaboratories - ccp.api.general.Affiliation.Group Set
sortedLaboratories ccp.api.general.Affiliation.Group List -
addLaboratory - ccp.api.general.Affiliation.Group
removeLaboratory - ccp.api.general.Affiliation.Group
findFirstLaboratory ccp.api.general.Affiliation.Group keyword=value pairs
findAllLaboratories ccp.api.general.Affiliation.Group Set keyword=value pairs
measurementLists
getMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set -
setMeasurementLists - ccp.api.nmr.Nmr.AbstractMeasurementList Set
sortedMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList List -
addMeasurementList - ccp.api.nmr.Nmr.AbstractMeasurementList
removeMeasurementList - ccp.api.nmr.Nmr.AbstractMeasurementList
findFirstMeasurementList ccp.api.nmr.Nmr.AbstractMeasurementList keyword=value pairs
findAllMeasurementLists ccp.api.nmr.Nmr.AbstractMeasurementList Set keyword=value pairs
molSystem
getMolSystem ccp.api.molecule.MolSystem.MolSystem -
setMolSystem - ccp.api.molecule.MolSystem.MolSystem
nmrEntryStore
getNmrEntryStore NmrEntryStore -
nmrProbes
getNmrProbes ccp.api.general.Instrument.NmrProbe Set - non-std.
sortedNmrProbes ccp.api.general.Instrument.NmrProbe List -
findFirstNmrProbe ccp.api.general.Instrument.NmrProbe keyword=value pairs
findAllNmrProbes ccp.api.general.Instrument.NmrProbe Set keyword=value pairs
nmrSpectrometers
getNmrSpectrometers ccp.api.general.Instrument.NmrSpectrometer Set - non-std.
sortedNmrSpectrometers ccp.api.general.Instrument.NmrSpectrometer List -
findFirstNmrSpectrometer ccp.api.general.Instrument.NmrSpectrometer keyword=value pairs
findAllNmrSpectrometers ccp.api.general.Instrument.NmrSpectrometer Set keyword=value pairs
otherCitations
getOtherCitations ccp.api.general.Citation.Citation Set -
setOtherCitations - ccp.api.general.Citation.Citation Set
sortedOtherCitations ccp.api.general.Citation.Citation List -
addOtherCitation - ccp.api.general.Citation.Citation
removeOtherCitation - ccp.api.general.Citation.Citation
findFirstOtherCitation ccp.api.general.Citation.Citation keyword=value pairs
findAllOtherCitations ccp.api.general.Citation.Citation Set keyword=value pairs
parent
getParent NmrEntryStore -
peakLists
getPeakLists ccp.api.nmr.Nmr.PeakList Set -
setPeakLists - ccp.api.nmr.Nmr.PeakList Set
sortedPeakLists ccp.api.nmr.Nmr.PeakList List -
addPeakList - ccp.api.nmr.Nmr.PeakList
removePeakList - ccp.api.nmr.Nmr.PeakList
findFirstPeakList ccp.api.nmr.Nmr.PeakList keyword=value pairs
findAllPeakLists ccp.api.nmr.Nmr.PeakList Set keyword=value pairs
primaryCitation
getPrimaryCitation ccp.api.general.Citation.Citation -
setPrimaryCitation - ccp.api.general.Citation.Citation
relatedEntries
getRelatedEntries RelatedEntry Set -
sortedRelatedEntries RelatedEntry List -
findFirstRelatedEntry RelatedEntry keyword=value pairs
findAllRelatedEntries RelatedEntry Set keyword=value pairs
software
getSoftware ccp.api.general.Method.Software Set -
setSoftware - ccp.api.general.Method.Software Set
sortedSoftware ccp.api.general.Method.Software List -
addSoftware - ccp.api.general.Method.Software
removeSoftware - ccp.api.general.Method.Software
findFirstSoftware ccp.api.general.Method.Software keyword=value pairs
findAllSoftware ccp.api.general.Method.Software Set keyword=value pairs
structureAnalyses
getStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis Set -
setStructureAnalyses - ccp.api.nmr.Nmr.StructureAnalysis Set
sortedStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis List -
addStructureAnalysis - ccp.api.nmr.Nmr.StructureAnalysis
removeStructureAnalysis - ccp.api.nmr.Nmr.StructureAnalysis
findFirstStructureAnalysis ccp.api.nmr.Nmr.StructureAnalysis keyword=value pairs
findAllStructureAnalyses ccp.api.nmr.Nmr.StructureAnalysis Set keyword=value pairs
structureGenerations
getStructureGenerations ccp.api.nmr.Nmr.StructureGeneration Set -
setStructureGenerations - ccp.api.nmr.Nmr.StructureGeneration Set
sortedStructureGenerations ccp.api.nmr.Nmr.StructureGeneration List -
addStructureGeneration - ccp.api.nmr.Nmr.StructureGeneration
removeStructureGeneration - ccp.api.nmr.Nmr.StructureGeneration
findFirstStructureGeneration ccp.api.nmr.Nmr.StructureGeneration keyword=value pairs
findAllStructureGenerations ccp.api.nmr.Nmr.StructureGeneration Set keyword=value pairs
structureGroups
getStructureGroups ccp.api.molecule.MolSystem.StructureGroup Set -
setStructureGroups - ccp.api.molecule.MolSystem.StructureGroup Set
sortedStructureGroups ccp.api.molecule.MolSystem.StructureGroup List -
addStructureGroup - ccp.api.molecule.MolSystem.StructureGroup
removeStructureGroup - ccp.api.molecule.MolSystem.StructureGroup
findFirstStructureGroup ccp.api.molecule.MolSystem.StructureGroup keyword=value pairs
findAllStructureGroups ccp.api.molecule.MolSystem.StructureGroup Set keyword=value pairs
study
getStudy Study -
setStudy - Study

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Entry memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
newEntryMolecule EntryMolecule productionMethod, molecule, ...
newRelatedEntry RelatedEntry dbCode, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:25:09_00020

isImplicit:

False

Tag

Value
repositoryId $Id: Entry.xml,v 1.53 2011-01-13 14:40:35 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:53 2013    from data model package  ccp.api.nmr.NmrEntry.Entry   revision 1.53  
  Work done by the CCPN team.
www.ccpn.ac.uk