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

Class: Annotation


    Annotation to store file and a description associate to it.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link annotationStore to class AnnotationStore
Main key: serial
Mandatory Attributes: path, dataUrl
Known Subclasses: None
Children: None
Constructor: newObj = Annotation( annotationStore,path=value, dataUrl=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
date DateTime 0..1 The date at which the annotation is created.  
description Text 0..1 The description of the annotation.  
details String 0..1 Details field for comments.  
name Line 0..1 The name of the annotation.  
path PathString 1..1 File name, relative to dataUrl, of data.  
serial Int 1..1 Unique identidier.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annotationStore AnnotationStore 1..1 (Parent link). parent link  
author ccp.api.general.Affiliation.Person 0..1 Author of annotation  
dataUrl ccp.api.general.DataLocation.DataUrl 1..1 DataUrl under which Annotation is stored  
experiments ccp.api.lims.Experiment.Experiment 0..* Experiments annotated by Annotation  
parent AnnotationStore 1..1 link to parent object - synonym for annotationStore  
projects ccp.api.lims.Target.Project 0..* Annotations relevant to Project.  
targetGroups ccp.api.lims.Target.TargetGroup 0..*  
targets ccp.api.lims.Target.Target 0..* Annotations relevant to Target.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
date
getDate DateTime -
setDate - DateTime
description
getDescription Text -
setDescription - Text
details
getDetails String -
setDetails - String
name
getName Line -
setName - Line
path
getPath PathString -
setPath - PathString
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annotationStore
getAnnotationStore AnnotationStore -
author
getAuthor ccp.api.general.Affiliation.Person -
setAuthor - ccp.api.general.Affiliation.Person
dataUrl
getDataUrl ccp.api.general.DataLocation.DataUrl -
setDataUrl - ccp.api.general.DataLocation.DataUrl
experiments
getExperiments ccp.api.lims.Experiment.Experiment Set -
setExperiments - ccp.api.lims.Experiment.Experiment Set
sortedExperiments ccp.api.lims.Experiment.Experiment List -
addExperiment - ccp.api.lims.Experiment.Experiment
removeExperiment - ccp.api.lims.Experiment.Experiment
findFirstExperiment ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllExperiments ccp.api.lims.Experiment.Experiment Set keyword=value pairs
parent
getParent AnnotationStore -
projects
getProjects ccp.api.lims.Target.Project Set -
setProjects - ccp.api.lims.Target.Project Set
sortedProjects ccp.api.lims.Target.Project List -
addProject - ccp.api.lims.Target.Project
removeProject - ccp.api.lims.Target.Project
findFirstProject ccp.api.lims.Target.Project keyword=value pairs
findAllProjects ccp.api.lims.Target.Project 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
checkValid - Boolean
checkAllValid - Boolean
getByKey Annotation 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
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:25:09_00026

isImplicit:

False

Tag

Value
repositoryId $Id: Annotation.xml,v 1.48 2011-01-13 14:40:32 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:58 2013    from data model package  ccp.api.general.Annotation.Annotation   revision 1.48  
  Work done by the CCPN team.
www.ccpn.ac.uk