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

Class: Citation


Abstract Class

    Citation (litterature reference).
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link citationStore to class CitationStore
Main key: serial
Mandatory Attributes: None
Known Subclasses: BookCitation, ConferenceCitation, JournalCitation, ThesisCitation
Children: None

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
casAbstractCode Line 0..1 Chemical Abstracts abstracting service (CAS) code  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
doi Text 0..1 DOI identifier of citation  
firstPage Line 0..1 First page number (not an integer, as it might be e.g. '235A')  
keywords Line 0..* Keywords characterising Citation  
lastPage Line 0..1 Last page number (not an integer, as it might be e.g. '238A')  
medlineUiCode Line 0..1 Medline UI index code  
pubMedId Line 0..1 pubMed ID  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
status CitationStatus 0..1 E.g. 'published', 'in press','to be published' ?  
title SingleLine 0..1 Citation (article) Title  
year Int 0..1 Year of publication  

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 Citation  
citationStore CitationStore 1..1 (Parent link). parent link  
dataLists ccp.api.nmr.Nmr.DataList 0..* Nmr Generic Measurement Lists citing Citation.  
editors ccp.api.general.Affiliation.Person 0..* People who are editors of Citation  
experiments ccp.api.nmr.Nmr.Experiment 0..* Nmr Experiments referring to Citation  
methods ccp.api.general.Method.Method 0..* Methods described by Citation  
molSystems ccp.api.molecule.MolSystem.MolSystem 0..* MolSystems described by Citation  
molecules ccp.api.molecule.Molecule.Molecule 0..* Molecules described by Citation  
nmrEntries ccp.api.nmr.NmrEntry.Entry 0..* BioMagResBank entries that cite Citatoin as non-primary reference  
nmrEntriesPrimary ccp.api.nmr.NmrEntry.Entry 0..* NMR entries that have this as their primary citation  
nmrProbes ccp.api.general.Instrument.NmrProbe 0..* Nmr probes that use this Citation  
nmrSpectrometers ccp.api.general.Instrument.NmrSpectrometer 0..* Nmr Spectrometers citing this Citation  
parent CitationStore 1..1 link to parent object - synonym for citationStore  
protocols ccp.api.lims.Protocol.Protocol 0..* Protocol where Citation refers to.  
ratioShiftReferences ccp.api.nmr.Nmr.ShiftReference 0..* Shift reference indirect shift ratio references.  
sampleConditionSets ccp.api.nmr.Nmr.SampleConditionSet 0..* SampleConditionSets quoting Citation  
shiftReferences ccp.api.nmr.Nmr.ShiftReference 0..* Shift References citing CItation.  
software ccp.api.general.Method.Software 0..* Software described by Citation  
targetGroups ccp.api.lims.Target.TargetGroup 0..*  
targets ccp.api.lims.Target.Target 0..* Targets described by Citation.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
casAbstractCode
getCasAbstractCode Line -
setCasAbstractCode - Line
details
getDetails Text -
setDetails - Text
doi
getDoi Text -
setDoi - Text
firstPage
getFirstPage Line -
setFirstPage - Line
keywords
getKeywords Line Tuple -
setKeywords - Line List
addKeyword - Line
removeKeyword - Line
lastPage
getLastPage Line -
setLastPage - Line
medlineUiCode
getMedlineUiCode Line -
setMedlineUiCode - Line
pubMedId
getPubMedId Line -
setPubMedId - Line
serial
getSerial Int -
setSerial - Int
status
getStatus CitationStatus -
setStatus - CitationStatus
title
getTitle SingleLine -
setTitle - SingleLine
year
getYear Int -
setYear - Int

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
citationStore
getCitationStore CitationStore -
dataLists
getDataLists ccp.api.nmr.Nmr.DataList Set -
setDataLists - ccp.api.nmr.Nmr.DataList Set
sortedDataLists ccp.api.nmr.Nmr.DataList List -
findFirstDataList ccp.api.nmr.Nmr.DataList keyword=value pairs
findAllDataLists ccp.api.nmr.Nmr.DataList Set keyword=value pairs
editors
getEditors ccp.api.general.Affiliation.Person Tuple -
setEditors - ccp.api.general.Affiliation.Person List
addEditor - ccp.api.general.Affiliation.Person
removeEditor - ccp.api.general.Affiliation.Person
findFirstEditor ccp.api.general.Affiliation.Person keyword=value pairs
findAllEditors ccp.api.general.Affiliation.Person List 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 -
findFirstExperiment ccp.api.nmr.Nmr.Experiment keyword=value pairs
findAllExperiments ccp.api.nmr.Nmr.Experiment Set keyword=value pairs
methods
getMethods ccp.api.general.Method.Method Set -
setMethods - ccp.api.general.Method.Method Set
sortedMethods ccp.api.general.Method.Method List -
findFirstMethod ccp.api.general.Method.Method keyword=value pairs
findAllMethods ccp.api.general.Method.Method Set keyword=value pairs
molSystems
getMolSystems ccp.api.molecule.MolSystem.MolSystem Set -
setMolSystems - ccp.api.molecule.MolSystem.MolSystem Set
sortedMolSystems ccp.api.molecule.MolSystem.MolSystem List -
addMolSystem - ccp.api.molecule.MolSystem.MolSystem
removeMolSystem - ccp.api.molecule.MolSystem.MolSystem
findFirstMolSystem ccp.api.molecule.MolSystem.MolSystem keyword=value pairs
findAllMolSystems ccp.api.molecule.MolSystem.MolSystem Set keyword=value pairs
molecules
getMolecules ccp.api.molecule.Molecule.Molecule Set -
setMolecules - ccp.api.molecule.Molecule.Molecule Set
sortedMolecules ccp.api.molecule.Molecule.Molecule List -
findFirstMolecule ccp.api.molecule.Molecule.Molecule keyword=value pairs
findAllMolecules ccp.api.molecule.Molecule.Molecule Set keyword=value pairs
nmrEntries
getNmrEntries ccp.api.nmr.NmrEntry.Entry Set -
setNmrEntries - ccp.api.nmr.NmrEntry.Entry Set
sortedNmrEntries ccp.api.nmr.NmrEntry.Entry List -
addNmrEntry - ccp.api.nmr.NmrEntry.Entry
removeNmrEntry - ccp.api.nmr.NmrEntry.Entry
findFirstNmrEntry ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllNmrEntries ccp.api.nmr.NmrEntry.Entry Set keyword=value pairs
nmrEntriesPrimary
getNmrEntriesPrimary ccp.api.nmr.NmrEntry.Entry Tuple -
setNmrEntriesPrimary - ccp.api.nmr.NmrEntry.Entry List
addNmrEntryPrimary - ccp.api.nmr.NmrEntry.Entry
removeNmrEntryPrimary - ccp.api.nmr.NmrEntry.Entry
findFirstNmrEntryPrimary ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllNmrEntriesPrimary ccp.api.nmr.NmrEntry.Entry List keyword=value pairs
nmrProbes
getNmrProbes ccp.api.general.Instrument.NmrProbe Set -
setNmrProbes - ccp.api.general.Instrument.NmrProbe Set
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 -
setNmrSpectrometers - ccp.api.general.Instrument.NmrSpectrometer Set
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
parent
getParent CitationStore -
protocols
getProtocols ccp.api.lims.Protocol.Protocol Set -
setProtocols - ccp.api.lims.Protocol.Protocol Set
sortedProtocols ccp.api.lims.Protocol.Protocol List -
addProtocol - ccp.api.lims.Protocol.Protocol
removeProtocol - ccp.api.lims.Protocol.Protocol
findFirstProtocol ccp.api.lims.Protocol.Protocol keyword=value pairs
findAllProtocols ccp.api.lims.Protocol.Protocol Set keyword=value pairs
ratioShiftReferences
getRatioShiftReferences ccp.api.nmr.Nmr.ShiftReference Set -
setRatioShiftReferences - ccp.api.nmr.Nmr.ShiftReference Set
sortedRatioShiftReferences ccp.api.nmr.Nmr.ShiftReference List -
findFirstRatioShiftReference ccp.api.nmr.Nmr.ShiftReference keyword=value pairs
findAllRatioShiftReferences ccp.api.nmr.Nmr.ShiftReference Set keyword=value pairs
sampleConditionSets
getSampleConditionSets ccp.api.nmr.Nmr.SampleConditionSet Set -
setSampleConditionSets - ccp.api.nmr.Nmr.SampleConditionSet Set
sortedSampleConditionSets ccp.api.nmr.Nmr.SampleConditionSet List -
findFirstSampleConditionSet ccp.api.nmr.Nmr.SampleConditionSet keyword=value pairs
findAllSampleConditionSets ccp.api.nmr.Nmr.SampleConditionSet Set keyword=value pairs
shiftReferences
getShiftReferences ccp.api.nmr.Nmr.ShiftReference Set -
setShiftReferences - ccp.api.nmr.Nmr.ShiftReference Set
sortedShiftReferences ccp.api.nmr.Nmr.ShiftReference List -
addShiftReference - ccp.api.nmr.Nmr.ShiftReference
removeShiftReference - ccp.api.nmr.Nmr.ShiftReference
findFirstShiftReference ccp.api.nmr.Nmr.ShiftReference keyword=value pairs
findAllShiftReferences ccp.api.nmr.Nmr.ShiftReference 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 -
findFirstSoftware ccp.api.general.Method.Software keyword=value pairs
findAllSoftware ccp.api.general.Method.Software Set keyword=value pairs
targetGroups
getTargetGroups ccp.api.lims.Target.TargetGroup Set -
setTargetGroups - ccp.api.lims.Target.TargetGroup Set
sortedTargetGroups ccp.api.lims.Target.TargetGroup List -
addTargetGroup - ccp.api.lims.Target.TargetGroup
removeTargetGroup - ccp.api.lims.Target.TargetGroup
findFirstTargetGroup ccp.api.lims.Target.TargetGroup keyword=value pairs
findAllTargetGroups ccp.api.lims.Target.TargetGroup Set keyword=value pairs
targets
getTargets ccp.api.lims.Target.Target Set -
setTargets - ccp.api.lims.Target.Target Set
sortedTargets ccp.api.lims.Target.Target List -
addTarget - ccp.api.lims.Target.Target
removeTarget - ccp.api.lims.Target.Target
findFirstTarget ccp.api.lims.Target.Target keyword=value pairs
findAllTargets ccp.api.lims.Target.Target Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
getByKey Citation memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -

Factory Methods (in package)

Go to Top
Method Return Parameters
None

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:22:55_00011

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:05 2014    from data model package  ccp.api.general.Citation.Citation   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk