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

Class: AbstractComponent


Abstract Class

    The abstract component is used to define the details which characterise all components, these are name, any synonyms and a CAS number. There are 4 subclasses of abstract component: Molecular component (MolComponent), Cell, Substance and Composite.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link refSampleComponentStore to class RefSampleComponentStore
Main key: name
Mandatory Attributes: name
Known Subclasses: Cell, Composite, MolComponent, Substance
Children:
link componentDbRefs to class ComponentDbRef
link labels to class Label

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Detail field for comments.  
name Line 1..1 The name of the component. Unique identifier.  
synonyms Line 0..* The synonyms of the component.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
categories ccp.api.lims.Classification.SampleComponentCategory 0..* List of category associated to a component.  
componentDbRefs ComponentDbRef 0..* (Child link). child link to class ComponentDbRef  
compositeElements CompositeElement 0..* List of element where the component is part of a composite.  
labels Label 0..* (Child link). child link to class Label  
naturalSource ccp.api.general.Taxonomy.NaturalSource 0..1 The natural source of the component.  
parent RefSampleComponentStore 1..1 link to parent object - synonym for refSampleComponentStore  
refSampleComponentStore RefSampleComponentStore 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
name
getName Line -
setName - Line
synonyms
getSynonyms Line Tuple -
setSynonyms - Line List
addSynonym - Line
removeSynonym - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
categories
getCategories ccp.api.lims.Classification.SampleComponentCategory Set -
setCategories - ccp.api.lims.Classification.SampleComponentCategory Set
sortedCategories ccp.api.lims.Classification.SampleComponentCategory List -
addCategory - ccp.api.lims.Classification.SampleComponentCategory
removeCategory - ccp.api.lims.Classification.SampleComponentCategory
findFirstCategory ccp.api.lims.Classification.SampleComponentCategory keyword=value pairs
findAllCategories ccp.api.lims.Classification.SampleComponentCategory Set keyword=value pairs
componentDbRefs
getComponentDbRefs ComponentDbRef Set -
sortedComponentDbRefs ComponentDbRef List -
findFirstComponentDbRef ComponentDbRef keyword=value pairs
findAllComponentDbRefs ComponentDbRef Set keyword=value pairs
compositeElements
getCompositeElements CompositeElement Set -
setCompositeElements - CompositeElement Set
sortedCompositeElements CompositeElement List -
findFirstCompositeElement CompositeElement keyword=value pairs
findAllCompositeElements CompositeElement Set keyword=value pairs
labels
getLabels Label Set -
sortedLabels Label List -
findFirstLabel Label keyword=value pairs
findAllLabels Label Set keyword=value pairs
naturalSource
getNaturalSource ccp.api.general.Taxonomy.NaturalSource -
setNaturalSource - ccp.api.general.Taxonomy.NaturalSource
parent
getParent RefSampleComponentStore -
refSampleComponentStore
getRefSampleComponentStore RefSampleComponentStore -

Class Methods (in package)

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

Factory Methods (in package)

Go to Top
Method Return Parameters
newComponentDbRef ComponentDbRef dbRef, ...
newLabel Label labelName, labelType, ...

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:52_00057

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: ccp.api.lims.RefData.RefNmrSpectrum.refSampleComponentccp.api.lims.Sample.SampleComponent.refComponentccp.api.nmr.NmrScreen.MixtureComponent.refSampleComponentccp.api.nmr.NmrScreen.TrialHit.refSampleComponent
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:15 2014    from data model package  ccp.api.lims.RefSampleComponent.AbstractComponent   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk