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

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/ndgCommon/trunk/ndg/common/src/lib/ndgresources.py@4933
Revision 4933, 4.8 KB checked in by cbyrom, 11 years ago (diff)

Replace ndgXqueries with more generic ndgresources.

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='common/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 'common/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        self.knownQueries={no.DIF_DOC_TYPE:'moles2dif',
30                           no.DC_DOC_TYPE:'moles2DC',
31                           no.ISO_DOC_TYPE:'moles2iso19139',
32                           no.NDGB0_DOC_TYPE:'moles',
33                           no.NDGB1_DOC_TYPE:'molesObjectType',
34                           no.MDIP_DOC_TYPE:'moles2mdip', 
35                           no.NDGA0_DOC_TYPE:'csml',
36                           no.NUMSIM_DOC_TYPE:'numsim', 
37                           no.ATOM_DOC_TYPE:'atom', 
38                           no.ATOM_BACKUP_DOC_TYPE:'atom', 
39                           no.ASSOCIATED_ATOM_DOC_TYPE:'atomTypeList',
40                           no.BROWSE_DIF_DOC_TYPE:'dif'}
41        logging.debug("ndgResources initialised")
42
43
44    def __loadResources(self, directory):
45        '''
46        Load the various resources
47        @keyword directory: root directory from which to retrieve docs from.
48        '''
49        xqueryDir = directory + 'xquery'
50        files=pkg_resources.resource_listdir('ndg', xqueryDir)
51        # this next bit to get rid of .svn and anything else in testing
52        self.xq = {}
53        for f in files:
54            if f.endswith('.xq'):
55                self.xq[re.sub('.xq\Z','',f)] = \
56                    pkg_resources.resource_string('ndg','%s/%s'%(xqueryDir,f))
57
58        schemaDir = directory + 'schema'
59        files=pkg_resources.resource_listdir('ndg', schemaDir)
60        self.xsd = {}
61        for f in files:
62            if f.endswith('.xsd'):
63                self.xsd[re.sub('.xsd\Z','',f)] = \
64                    pkg_resources.resource_string('ndg','%s/%s'%(schemaDir, f))
65                         
66        # add the various xquery libraries, too
67        self.xqlib = {}
68        for dir in ['Vocabs', 'Utilities', 'StubB']:
69            xqueryLibDir = xqueryDir + '/lib/' + dir
70            files = pkg_resources.resource_listdir('ndg', xqueryLibDir)
71            for f in files:
72                if f.endswith('.xquery'): 
73                    fullPath = '%s/%s'%(xqueryLibDir,f)
74                    partPath = '/%s/%s' %(dir, f)
75                    self.xqlib[partPath] = pkg_resources.resource_string('ndg', fullPath)
76       
77        # also add the organisation data files - NB, this class should be generalised
78        # to make more sense...
79        resourceDir = directory + 'resources'
80        files = pkg_resources.resource_listdir('ndg', resourceDir)
81        self.resources = {}
82        for f in files:
83            if f.endswith('.xml'): 
84                self.resources[f] = \
85                    pkg_resources.resource_string('ndg','%s/%s' %(resourceDir, f))
86
87        # lastly, add the indexes
88        self.indexes = {}
89        for dir in ['eXist']:
90            indexDir = directory + 'indexing' + '/' + dir
91            files = pkg_resources.resource_listdir('ndg', indexDir)
92            for f in files:
93                if f.endswith('.xconf'): 
94                    self.indexes[f] = \
95                        pkg_resources.resource_string('ndg','%s/%s'%(indexDir,f))
96       
97       
98    def createXQuery(self, key, targetCollection, repositoryID, localID):
99        '''
100        Return an actual xquery targetted for a specific localID, repositoryID and
101        targetCollection
102        @param key: name of xquery to use
103        @param targetCollection: target collection to use with xquery
104        @param repositoryID: ID of the repository to use with the xquery
105        @param localID: local ID of doc to lookup with xquery
106        @raise ValueError: if key is not a valid xquery
107        @return xquery as a string
108        '''
109        logging.debug("Setting up %s xquery" %key)
110        if not self.xq.has_key(key):
111            raise ValueError("Unrecognised xquery type: '%s'" %key)
112       
113        xq=self.xq[key]
114        xq=xq.replace('RepositoryID',repositoryID)
115        xq=xq.replace('LocalID',localID)
116        xq=xq.replace('TargetCollection',targetCollection)
117        logging.debug("Xquery set up - returning")
118        return xq
Note: See TracBrowser for help on using the repository browser.