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

Class: NameMapping


    This class groups all mappings between an external file format and the data model. It is used by the FormatConverter software.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link nameMappingStore to class NameMappingStore
Main key: serial
Mandatory Attributes: formatName, namingSystem
Known Subclasses: None
Children:
link atomMappings to class AtomMapping
link chainMappings to class ChainMapping
link moleculeMappings to class MoleculeMapping
link resLinkMappings to class ResonanceLinkMapping
link resStatusMappings to class ResonanceStatusMapping
Constructor: newObj = NameMapping( nameMappingStore,formatName=value, namingSystem=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
formatName Line 1..1 The name of the external format (e.g. XEASY, NmrView, ..)  
isOriginalImport Boolean 1..1 Flag that has to be set when this mapping was created when importing a file.  
namingSystem Line 1..1 The naming system used in this particular mapping (e.g. IUPAC, PDB, ...). This can be different from the formatName - for example an NMR-STAR file might contain only X-PLOR author names in some cases.  
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  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomMappings AtomMapping 0..* (Child link). child link to class AtomMapping  
chainMappings ChainMapping 0..* (Child link). child link to class ChainMapping  
moleculeMappings MoleculeMapping 0..* (Child link). child link to class MoleculeMapping  
nameMappingStore NameMappingStore 1..1 (Parent link). parent link  
parent NameMappingStore 1..1 link to parent object - synonym for nameMappingStore  
resLinkMappings ResonanceLinkMapping 0..* (Child link). child link to class ResonanceLinkMapping  
resStatusMappings ResonanceStatusMapping 0..* (Child link). child link to class ResonanceStatusMapping  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
formatName
getFormatName Line -
setFormatName - Line
isOriginalImport
getIsOriginalImport Boolean -
setIsOriginalImport - Boolean
namingSystem
getNamingSystem Line -
setNamingSystem - Line
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomMappings
getAtomMappings AtomMapping Set -
sortedAtomMappings AtomMapping List -
findFirstAtomMapping AtomMapping keyword=value pairs
findAllAtomMappings AtomMapping Set keyword=value pairs
chainMappings
getChainMappings ChainMapping Set -
sortedChainMappings ChainMapping List -
findFirstChainMapping ChainMapping keyword=value pairs
findAllChainMappings ChainMapping Set keyword=value pairs
moleculeMappings
getMoleculeMappings MoleculeMapping Set -
sortedMoleculeMappings MoleculeMapping List -
findFirstMoleculeMapping MoleculeMapping keyword=value pairs
findAllMoleculeMappings MoleculeMapping Set keyword=value pairs
nameMappingStore
getNameMappingStore NameMappingStore -
parent
getParent NameMappingStore -
resLinkMappings
getResLinkMappings ResonanceLinkMapping Set -
sortedResLinkMappings ResonanceLinkMapping List -
findFirstResLinkMapping ResonanceLinkMapping keyword=value pairs
findAllResLinkMappings ResonanceLinkMapping Set keyword=value pairs
resStatusMappings
getResStatusMappings ResonanceStatusMapping Set -
sortedResStatusMappings ResonanceStatusMapping List -
findFirstResStatusMapping ResonanceStatusMapping keyword=value pairs
findAllResStatusMappings ResonanceStatusMapping Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NameMapping 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
newAtomMapping AtomMapping formatName, name, ...
newChainMapping ChainMapping chainCode, formatChainCode, formatFirstSeqCode, ...
newMoleculeMapping MoleculeMapping formatName, name, ...
newResonanceLinkMapping ResonanceLinkMapping resonanceName, ...
newResonanceStatusMapping ResonanceStatusMapping resonanceName, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-17-14:16:23_00005

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:12 2014    from data model package  ccpnmr.api.NameMapping.NameMapping   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk