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

Class: TopObject


Abstract Class

    Superclass for TopObjects (except for MemopsRoot). The attributes and operations are different in File and Db implementations
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class MemopsRoot
Main key: n/a
Mandatory Attributes: None
Partitions Children: True
Known Subclasses: cambridge.api.Dangle.DangleStore, cambridge.api.Wms.WmsSegment, cambridge.api.WmsProtocol.WmsProtocol, cambridge.api.WmsQuery.WmsQueryStore, ccp.api.general.Affiliation.AffiliationStore, ccp.api.general.Annotation.AnnotationStore, ccp.api.general.Citation.CitationStore, ccp.api.general.DataLocation.DataLocationStore, ccp.api.general.DbRef.Database, ccp.api.general.Instrument.InstrumentStore, ccp.api.general.KeywordDefinition.KeywordDefinitionStore, ccp.api.general.Method.MethodStore, ccp.api.general.Taxonomy.Taxonomy, ccp.api.lims.Classification.Classification, ccp.api.lims.Crystallization.CrystallizationStore, ccp.api.lims.ExpBlueprint.ExpBlueprintStore, ccp.api.lims.Experiment.ExperimentStore, ccp.api.lims.Holder.HolderStore, ccp.api.lims.Location.LocationStore, ccp.api.lims.Protocol.ProtocolStore, ccp.api.lims.RefData.RefDataStore, ccp.api.lims.RefSampleComponent.RefSampleComponentStore, ccp.api.lims.Sample.SampleStore, ccp.api.lims.Target.TargetStore, ccp.api.molecule.ChemComp.ChemComp, ccp.api.molecule.ChemCompCharge.ChemCompCharge, ccp.api.molecule.ChemCompCoord.ChemCompCoord, ccp.api.molecule.ChemCompLabel.LabelingScheme, ccp.api.molecule.ChemElement.ChemElementStore, ccp.api.molecule.LabeledMolecule.LabeledMolecule, ccp.api.molecule.MolStructure.StructureEnsemble, ccp.api.molecule.MolSystem.MolSystem, ccp.api.molecule.Molecule.Molecule, ccp.api.molecule.Stereochemistry.StereochemistryStore, ccp.api.molecule.Validation.ValidationStore, ccp.api.nmr.Nmr.NmrProject, ccp.api.nmr.NmrCalc.NmrCalcStore, ccp.api.nmr.NmrConstraint.NmrConstraintStore, ccp.api.nmr.NmrEntry.NmrEntryStore, ccp.api.nmr.NmrExpPrototype.NmrExpPrototype, ccp.api.nmr.NmrReference.NmrReferenceStore, ccp.api.nmr.NmrScreen.NmrScreen, ccpnmr.api.Analysis.AnalysisProject, ccpnmr.api.AnalysisLayout.Layout, ccpnmr.api.AnalysisProfile.AnalysisProfile, ccpnmr.api.AnalysisV3.AnalysisProjectV3, ccpnmr.api.AnalysisWindow.AnalysisWindowStore, ccpnmr.api.NameMapping.NameMappingStore, memops.api.AccessControl.AccessControlStore, molsim.api.AnnealProtocol.AnnealProtocolStore, molsim.api.Symmetry.MolSystemSymmetrySet, utrecht.api.Haddock.HaddockProject
Children: None

Attributes

Go to Top
Attribute Type Multiplicity Description
createdBy Word 1..1 user who created TopObject.  
guid GuidString 1..1 global unique identifier - set by implementation.  
isLoaded Boolean 1..1 Implementation attribute, set automatically. True if the data in the Storage are loaded into memory. As data are loaded automatically, this attribute should be of interest only for the implementation.  
isModifiable Boolean 1..1 True if the data corresponding to the storage may be modified. If isModifiable is false for a given package, attemps to modify the data will raise an error. Note that isModifiable can be set to true even if the corresponding file is read-only. For a Project, this atribute defines whether the Implementation package (not the entire project contents) can be modified. If the Implementation package is Read-Only, this will prohibit many changes in the other packages as well. This parameter can be freely modified by users, so it is not a security feature, but rather a protection against accidental changes.  
isModified Boolean 1..1 Implementation attribute. True if the data corresponding to the Storage have been modified since being loaded. Serves to indicate which data need to be saved.  
isReading Boolean 1..1 Implementation attribute, set automatically. True if the data corresponding to the Storage are in the process of being read. As data loading is handled automatically, this attribute should be relevant only for the implementation, or possibly for programmers of multithreaded programs. Serves to suppress notifiers and validity checking during reading. Note that objects are not valid until the data loading is completed.  
lastUnlockedBy Word 0..1 User who last set TopObject.isModifiable to True. Used to track if data have been modified. Provided data have isModifiable set to False, any modification in the underlying data will show up on lastUnlockedBy.  

Inherited Attributes: applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes

Go to Top
Attribute Type Multiplicity Description
activeRepositories Repository 0..* Repositories on package search path that contains a copy of TopObject  
memopsRoot MemopsRoot 1..1 (Parent link). parent link  
packageLocator PackageLocator 1..1 Derived. Package locator relevant for TopObject  

Inherited Attributes: accessactiveAccessroottopObject

Attribute Methods (in class)

Go to Top
Attribute Method Return Parameters Comment
createdBy
getCreatedBy Word -
setCreatedBy - Word
guid
getGuid GuidString -
setGuid - GuidString
isLoaded
getIsLoaded Boolean -
isModifiable
getIsModifiable Boolean -
setIsModifiable - Boolean non-std.
isModified
getIsModified Boolean -
isReading
getIsReading Boolean -
lastUnlockedBy
getLastUnlockedBy Word -
setLastUnlockedBy - Word

Link Attribute Methods (in class)

Go to Top
Attribute Method Return Parameters Comment
activeRepositories
getActiveRepositories Repository Tuple -
findFirstActiveRepository Repository keyword=value pairs
findAllActiveRepositories Repository List keyword=value pairs
memopsRoot
getMemopsRoot MemopsRoot -
packageLocator
getPackageLocator PackageLocator - non-std.

Class Methods (in class)

Go to Top
Method Return Parameters Comment
None

Factory Methods (in class)

Go to Top
Method Return Parameters
None

Other Methods (in class)

Go to Top
Method Return Parameters Comment
backup - - non-std. back up TopObject to current backup location
load - - non-std. Load data corresponding to TopObject
loadFrom - Repository non-std. Load TopObject from specific Repository
removeFrom - Repository non-std. Remove data from specified repository. Will remove from disk. NB This operation is marked as a query because this means it may be executed on a deleted object. It does have the lasting side effect of changing the contents of the repository.
restore - - non-std. restore data from current backup location
save - - non-std. Save data corresponding to TopObject
saveTo - Repository non-std. Save topObject to specified repository
touch - - non-std. Set storage.isModified to True, so that the storage is saved at the next saveModified command. Fails if the storage is not loaded or not modifiable.

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-09-14-16:28:57_00002

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: memops.api.Implementation.DataObject.topObjectmemops.api.Implementation.MemopsRoot.topObjects
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:24 2015    from data model package  memops.api.Implementation.TopObject   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk