Source Code for Module bmrblib.citations.citations_v3_1

 1  ############################################################################# 
 2  #                                                                           # 
 3  # The BMRB library.                                                         # 
 4  #                                                                           # 
 5  # Copyright (C) 2009-2013 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  This file is part of the U{BMRB library<https://sourceforge.net/projects/bmrblib>}. 
26   
27  For example, see http://www.bmrb.wisc.edu/dictionary/3.1html/SaveFramePage.html#citations. 
28  """ 
29   
30  # relax module imports. 
31  from bmrblib.base_classes import BaseSaveframe, TagCategory, TagCategoryFree 
32  from bmrblib.citations.citations import CitationsSaveframe, Citations, CitationsAuthor 
33   
34   
35 -class CitationsSaveframe_v3_1(CitationsSaveframe): 
36      """The citations saveframe class.""" 
37   
38 -    def add_tag_categories(self): 
39          """Create the tag categories.""" 
40   
41          # The tag category objects. 
42          self.tag_categories.append(Citations_v3_1(self)) 
43          self.tag_categories.append(CitationsAuthor_v3_1(self)) 
44   
45   
46   
47 -class Citations_v3_1(Citations): 
48      """Base class for the Citations tag category.""" 
49   
50 -    def __init__(self, sf): 
51          """Setup the Citations tag category. 
52   
53          @param sf:  The saveframe object. 
54          @type sf:   saveframe instance 
55          """ 
56   
57          # Initialise the baseclass. 
58          super(Citations_v3_1, self).__init__(sf) 
59   
60          # The tag category label. 
61          self.tag_category_label = 'Citation' 
62   
63          # Change tag names. 
64          self['SfCategory'].tag_name = 'Sf_category' 
65          self['SfFramecode'].tag_name = 'Sf_framecode' 
66   
67          # Change variables. 
68          self['SfFramecode'].tag_name = 'citation_label' 
69   
70   
71   
72   
73 -class CitationsAuthor_v3_1(CitationsAuthor): 
74      """Base class for the CitationsAuthor tag category.""" 
75   
76 -    def __init__(self, sf): 
77          """Setup the CitationsAuthor tag category. 
78   
79          @param sf:  The saveframe object. 
80          @type sf:   saveframe instance 
81          """ 
82   
83          # Initialise the baseclass. 
84          super(CitationsAuthor_v3_1, self).__init__(sf) 
85   
86          # The tag category label. 
87          self.tag_category_label = 'Citation_author' 
88