Source Code for Module bmrblib.citations.citations_v3_1

 1  ############################################################################# 
 2  #                                                                           # 
 3  # The BMRB library.                                                         # 
 4  #                                                                           # 
 5  # Copyright (C) 2009-2011 Edward d'Auvergne                                 # 
 6  #                                                                           # 
 7  # This program is free software: you can redistribute it and/or modify      # 
 8  # it under the terms of the GNU General Public License as published by      # 
 9  # the Free Software Foundation, either version 3 of the License, or         # 
10  # (at your option) any later version.                                       # 
11  #                                                                           # 
12  # This program is distributed in the hope that it will be useful,           # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of            # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             # 
15  # GNU General Public License for more details.                              # 
16  #                                                                           # 
17  # You should have received a copy of the GNU General Public License         # 
18  # along with this program.  If not, see <http://www.gnu.org/licenses/>.     # 
19  #                                                                           # 
20  ############################################################################# 
21   
22  # Module docstring. 
23  """The citations saveframe category. 
24   
25  For example, see http://www.bmrb.wisc.edu/dictionary/3.1html/SaveFramePage.html#citations. 
26  """ 
27   
28  # relax module imports. 
29  from bmrblib.base_classes import BaseSaveframe, TagCategory, TagCategoryFree 
30  from bmrblib.citations.citations import CitationsSaveframe, Citations, CitationsAuthor 
31   
32   
33 -class CitationsSaveframe_v3_1(CitationsSaveframe): 
34      """The citations saveframe class.""" 
35   
36 -    def add_tag_categories(self): 
37          """Create the tag categories.""" 
38   
39          # The tag category objects. 
40          self.tag_categories.append(Citations_v3_1(self)) 
41          self.tag_categories.append(CitationsAuthor_v3_1(self)) 
42   
43   
44   
45 -class Citations_v3_1(Citations): 
46      """Base class for the Citations tag category.""" 
47   
48 -    def __init__(self, sf): 
49          """Setup the Citations tag category. 
50   
51          @param sf:  The saveframe object. 
52          @type sf:   saveframe instance 
53          """ 
54   
55          # Initialise the baseclass. 
56          super(Citations_v3_1, self).__init__(sf) 
57   
58          # The tag category label. 
59          self.tag_category_label = 'Citation' 
60   
61          # Change tag names. 
62          self['SfCategory'].tag_name = 'Sf_category' 
63          self['SfFramecode'].tag_name = 'Sf_framecode' 
64   
65          # Change variables. 
66          self['SfFramecode'].tag_name = 'citation_label' 
67   
68   
69   
70   
71 -class CitationsAuthor_v3_1(CitationsAuthor): 
72      """Base class for the CitationsAuthor tag category.""" 
73   
74 -    def __init__(self, sf): 
75          """Setup the CitationsAuthor tag category. 
76   
77          @param sf:  The saveframe object. 
78          @type sf:   saveframe instance 
79          """ 
80   
81          # Initialise the baseclass. 
82          super(CitationsAuthor_v3_1, self).__init__(sf) 
83   
84          # The tag category label. 
85          self.tag_category_label = 'Citation_author' 
86