source: ndgCommon/trunk/ndg/common/src/lib/ndgresources.py @ 7735

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/ndgCommon/trunk/ndg/common/src/lib/ndgresources.py
Revision 7735, 5.3 KB checked in by sdonegan, 9 years ago (diff)

Update to allow feedclient to work with iso recs

Line 
1'''
2Utility class providing access to various static resource files - e.g.
3xqueries and xsd schema docs
4
5 @author: C Byrom, Tessella, Feb 09
6'''
7import pkg_resources
8import re, logging
9from ndg.common.src.models.ndgObject import ndgObject as no
10
11# these are the different schemas needed to validate atom docs - NB, the main
12# one is molesAtom1.0 - this imports the others
13ATOM_MOLES_SCHEMA = "molesAtom1.0"
14MOLES_SCHEMA = "moles2.0"
15ATOM_SCHEMA = "atom1.0"
16
17class ndgResources(object):
18   
19    def __init__(self, directory='xmldb/'):
20        '''
21        Loads up resources from the internal package directory
22        @keyword directory: root directory from which to retrieve docs from.
23        Default is 'xmldb/'
24        '''
25        logging.debug("Initialising ndgResources")
26        self.__loadResources(directory)
27
28        # provide mapping between ndgObject URI doc type name and xquery name
29        # TODO: if we're going to replace the old moles1.3 entirely with the
30        # atom based format, will need to implement atom2dif, atom2dc and atom2iso
31        # queries
32               
33        self.knownQueries={no.DIF_DOC_TYPE:'moles2dif',
34                           no.DC_DOC_TYPE:'moles2DC',
35                           no.ISO_DOC_TYPE:'moles2iso19139',
36                           no.NDGB0_DOC_TYPE:'moles',
37                           no.NDGB1_DOC_TYPE:'molesObjectType',
38                           no.MDIP_DOC_TYPE:'moles2mdip', 
39                           no.NDGA0_DOC_TYPE:'csml',
40                           no.NUMSIM_DOC_TYPE:'numsim', 
41                           no.ATOM_DOC_TYPE:'atom', 
42                           no.ATOM_BACKUP_DOC_TYPE:'atom', 
43                           no.ASSOCIATED_ATOM_DOC_TYPE:'atomTypeList',
44                           no.BROWSE_DC_DOC_TYPE:'DIF2DC',
45                           no.BROWSE_DIF_DOC_TYPE:'dif',
46                           no.BROWSE_ISO_DOC_TYPE:'iso',
47                           no.DIF2stubISO:'dif2stubISO',
48                           no.ISO2DIF:'ISO2DIF',
49                           no.ISO2DC:'ISO2DC'}
50
51        logging.debug("ndgResources initialised")
52
53
54    def __loadResources(self, directory):
55        '''
56        Load the various resources
57        @keyword directory: root directory from which to retrieve docs from.
58        '''
59        xqueryDir = directory + 'xquery'
60        files=pkg_resources.resource_listdir('ndg.common', xqueryDir)
61        # this next bit to get rid of .svn and anything else in testing
62        self.xq = {}
63        for f in files:
64            if f.endswith('.xq'):
65                self.xq[re.sub('.xq\Z','',f)] = \
66                    pkg_resources.resource_string('ndg.common','%s/%s'%(xqueryDir,f))
67
68        schemaDir = directory + 'schema'
69        files=pkg_resources.resource_listdir('ndg.common', schemaDir)
70        self.xsd = {}
71        for f in files:
72            if f.endswith('.xsd'):
73                self.xsd[re.sub('.xsd\Z','',f)] = \
74                    pkg_resources.resource_string('ndg.common','%s/%s'%(schemaDir, f))
75                         
76        # add the various xquery libraries, too
77        self.xqlib = {}
78        for dir in ['Vocabs', 'Utilities', 'StubB']:
79            xqueryLibDir = xqueryDir + '/lib/' + dir
80            files = pkg_resources.resource_listdir('ndg.common', xqueryLibDir)
81            for f in files:
82                if f.endswith('.xquery'): 
83                    fullPath = '%s/%s'%(xqueryLibDir,f)
84                    partPath = '/%s/%s' %(dir, f)
85                    self.xqlib[partPath] = pkg_resources.resource_string('ndg.common', fullPath)
86       
87        # also add the organisation data files - NB, this class should be generalised
88        # to make more sense...
89        resourceDir = directory + 'resources'
90        files = pkg_resources.resource_listdir('ndg.common', resourceDir)
91        self.resources = {}
92        for f in files:
93            if f.endswith('.xml'): 
94                self.resources[f] = \
95                    pkg_resources.resource_string('ndg.common','%s/%s' %(resourceDir, f))
96
97        # lastly, add the indexes
98        self.indexes = {}
99        for dir in ['eXist']:
100            indexDir = directory + 'indexing' + '/' + dir
101            files = pkg_resources.resource_listdir('ndg.common', indexDir)
102            for f in files:
103                if f.endswith('.xconf'): 
104                    self.indexes[f] = \
105                        pkg_resources.resource_string('ndg.common','%s/%s'%(indexDir,f))
106       
107       
108    def createXQuery(self, key, targetCollection, repositoryID, localID):
109        '''
110        Return an actual xquery targetted for a specific localID, repositoryID and
111        targetCollection
112        @param key: name of xquery to use
113        @param targetCollection: target collection to use with xquery
114        @param repositoryID: ID of the repository to use with the xquery
115        @param localID: local ID of doc to lookup with xquery
116        @raise ValueError: if key is not a valid xquery
117        @return xquery as a string
118        '''
119        logging.debug("Setting up %s xquery" %key)
120        if not self.xq.has_key(key):
121            raise ValueError("Unrecognised xquery type: '%s'" %key)
122       
123        xq=self.xq[key]
124        xq=xq.replace('RepositoryID',repositoryID)
125        xq=xq.replace('LocalID',localID)
126        xq=xq.replace('TargetCollection',targetCollection)
127        logging.debug("Xquery set up - returning")
128        return xq
Note: See TracBrowser for help on using the repository browser.