Changeset 4935 for ndgCommon/trunk/ndg/common/src

Timestamp:

10/02/09 17:38:55 (12 years ago)

Author:

cbyrom

Message:

Update the models to use the new client suite + add new ndgObject var:
ASSOCIATED_ATOM_DOC_TYPE - to cope with the looking up of associated metadata.

Location:

ndgCommon/trunk/ndg/common/src/models

Files:

• Atom.py (modified) (8 diffs)
• AtomState.py (modified) (2 diffs)
• Deployment.py (modified) (1 diff)
• ndgObject.py (modified) (8 diffs)

ndgCommon/trunk/ndg/common/src/models/Atom.py

@@ -7 +7 @@
 from xml.etree import cElementTree as ET
 import csml.parser as CsmlParser
-from ndg.common.src.clients.xmldb.eXist.eXistConnector import eXistConnector
+import ndg.common.src.clients.xmldb.eXist.dbconstants as dc
 from ndg.common.src.lib.ETxmlView import et2text
 import ndg.common.src.lib.utilities as utilities
@@ -410 +410 @@
         '''
         logging.debug("Getting collection path for atom publication state")
-        collectionPath = eXistConnector.BASE_COLLECTION_PATH + self.state.collectionPath
+        collectionPath = dc.ATOM_COLLECTION_PATH + self.state.collectionPath
         logging.debug("Returning publication state collection, '%s'" %collectionPath)
         return collectionPath
@@ -424 +424 @@
         
         if self.atomTypeID == VTD.DE_TERM:
-            collectionPath += eXistConnector.DE_COLLECTION_PATH
+            collectionPath += dc.DE_COLLECTION_PATH
         elif self.atomTypeID == VTD.GRANULE_TERM:
-            collectionPath += eXistConnector.GRANULE_COLLECTION_PATH
+            collectionPath += dc.GRANULE_COLLECTION_PATH
         elif self.atomTypeID == VTD.ACTIVITY_TERM and \
             self.subtypeID == VTD.DEPLOYMENT_TERM:
-            collectionPath += eXistConnector.DEPLOYMENTS_COLLECTION_PATH
+            collectionPath += dc.DEPLOYMENTS_COLLECTION_PATH
         else:
-            collectionPath += eXistConnector.DEPLOYMENT_COLLECTION_PATH
+            collectionPath += dc.DEPLOYMENT_COLLECTION_PATH
         
         logging.debug("Returning entity collection, '%s'" %collectionPath)
@@ -1230 +1230 @@
 
 
-    def lookupAssociatedData(self, type, dr, lookupIndirectReferences=False):
+    def lookupAssociatedData(self, type, searchClient, lookupIndirectReferences=False):
         '''
         Check through the atom links and retrieve any associated data of the 
@@ -1236 +1236 @@
         @param type: type of associated data to lookup - currently VTD.DEPLOYMENT_TERM
         or VTD.DE_TERM
-        @param dr: Instance of DocumentRetrieve object - NB, this requires eXist
-        config details which are not available to the Atom object
+        @param searchClient: Client implementing the AbstractSearchXMLDBClient class
         @keyword lookupIndirectReferences: if True, the atom ID is used to search
         defined deployments to find those which reference it, otherwise only 
@@ -1263 +1262 @@
             # deployments info looked up first
             if type == VTD.DE_TERM and self.isDeployable() and not self.deployments:
-                self.lookupAssociatedData(VTD.DEPLOYMENT_TERM, dr, lookupIndirectReferences)
+                self.lookupAssociatedData(VTD.DEPLOYMENT_TERM, searchClient, 
+                                          lookupIndirectReferences = lookupIndirectReferences)
             
             logging.info("Looking up references to this atom from other %s" %type)
@@ -1279 +1279 @@
             links = []
             for url in urls:
-                doc = dr.get(type, dr.ATOM_TYPE, url, \
-                             targetCollection = eXistConnector.BASE_COLLECTION_PATH)
+                doc = searchClient.getNDGDoc(type, ndgObject.ASSOCIATED_ATOM_DOC_TYPE, url,
+                                             targetCollection = dc.ATOM_COLLECTION_PATH)
                 # now need to turn this results set into actual atoms
                 tree = ET.fromstring(doc)
@@ -1301 +1301 @@
                 else:
                     localID = link.href.split("__ATOM__")[-1]
-                    deploymentAtom = dr.get(self.ME.providerID, 'ATOM', localID, \
-                                            targetCollection = eXistConnector.BASE_COLLECTION_PATH)
+                    deploymentAtom = searchClient.getNDGDoc(self.ME.providerID, 
+                                                            'ATOM', localID, 
+                                                            targetCollection = dc.ATOM_COLLECTION_PATH)
     
                 deployment = Deployment.Deployment(Atom(xmlString=str(deploymentAtom)))

ndgCommon/trunk/ndg/common/src/models/AtomState.py

@@ -5 +5 @@
 '''
 import logging
-from ndg.common.src.clients.xmldb.eXist.eXistConnector import eXistConnector as ec
+import ndg.common.src.clients.xmldb.eXist.dbconstants as dc
 
 # flags to specify published state of atom
@@ -61 +61 @@
         return False
 
-OLD_STATE = AtomState(OLD_STATE_FLAG, 'Old', ec.OLD_COLLECTION_PATH)
-WORKING_STATE = AtomState(WORKING_STATE_FLAG, 'Working', ec.WORKING_COLLECTION_PATH)
+OLD_STATE = AtomState(OLD_STATE_FLAG, 'Old', dc.OLD_COLLECTION_PATH)
+WORKING_STATE = AtomState(WORKING_STATE_FLAG, 'Working', dc.WORKING_COLLECTION_PATH)
 SMALL_P_PUBLISHED_STATE = AtomState(SMALL_P_PUBLISHED_STATE_FLAG, 'published', 
-                                    ec.SMALL_P_PUBLISHED_COLLECTION_PATH)
+                                    dc.SMALL_P_PUBLISHED_COLLECTION_PATH)
 PUBLISHED_STATE = AtomState(PUBLISHED_STATE_FLAG, 'Published',
-                            ec.PUBLISHED_COLLECTION_PATH)
+                            dc.PUBLISHED_COLLECTION_PATH)

ndgCommon/trunk/ndg/common/src/models/Deployment.py

@@ -51 +51 @@
         else:
             logging.debug("Not a valid deployment type (%s) - ignoring" \
-                          %deploymentLink.vocabUrl)
+                          %deploymentLink.rel)
             return
 

ndgCommon/trunk/ndg/common/src/models/ndgObject.py

@@ -5 +5 @@
                 (2) a printable xml representation 
 '''
-from ndg.common.src.lib import xmlHandler2
 import logging
 
@@ -26 +25 @@
     ATOM_DOC_TYPE = 'ATOM'
     ATOM_BACKUP_DOC_TYPE = 'ATOM-BACKUP'
+    # NB, this is used to look up associated atoms - e.g. when the type is Deployment,
+    # the lookup will return all deployment data atoms listed in the deployment
+    ASSOCIATED_ATOM_DOC_TYPE = 'ASSOCIATED-ATOM'
     
     # NB, DIF records are stored in local eXist DB to allow feeds to serve them
@@ -46 +48 @@
                       NUMSIM_DOC_TYPE, ATOM_DOC_TYPE, \
                       ATOM_BACKUP_DOC_TYPE, BROWSE_DIF_DOC_TYPE]
+
+    discoveryURL = None
+    baseURL = None
+    xmlURL = None
+    printableURL = None
+    useDiscoveryService = 1
+    BURL=None
     
-    def __init__(self,uri,config=None):
-        ''' Parse the uri and prepare for obtaining the actual content'''
+    def __init__(self, uri, config=None):
+        ''' 
+        Parse the uri and prepare for obtaining the actual content
+        @param uri: ndgURI to set up object with
+        @keyword config: config object to use for retrieving the underlying doc
+        '''
         logging.debug("Initialising ndgObject with uri: '%s'" %uri)
         #Dom had problem with unicode coming in here ... dunno why @@@@
@@ -89 +102 @@
         self.setConfig(config)
 
-    def setDefaultProperties(self):
-        '''
-        Set default properties for object
-        '''
-        self.discoveryURL,self.baseURL,self.xmlURL,\
-            self.printableURL =None,None,None,None
-        self.useDiscoveryService = 1
-        self.BURL=None
-
-        
+
     def setConfig(self, config):
         ''' 
@@ -105 +109 @@
         logging.debug("Setting up configuration for retrieving document")
         self.config=config
-        if config is None:
-            self.setDefaultProperties()
+        if not config:
             return
+        
 
         self.server=self.config.get('DISCOVERY','default')
@@ -122 +126 @@
         logging.info("Default discovery format set to: %s" %fmt)
             
-        self.BURL=None
         # We'll build the following even if it can't be used (as would be the case for
         # a non data entity B record or an A record) because it's a useful template.
@@ -159 +162 @@
             #currently we don't know how to get this one
             self.URL='unknown'
-            self.setDefaultProperties()
+            self.discoveryURL = None
 
         logging.debug("Set up URL: '%s', discoveryURL: '%s'" %(self.URL, self.discoveryURL))
@@ -187 +190 @@
             return None
         from ndg.common.src.dal.ndgRetrieve import ndgRetrieve
-        status,xmlh = ndgRetrieve(self,self.config, \
-                                            discovery = self.useDiscoveryService)
+        status,xmlh = ndgRetrieve(self, self.config, 
+                                  discovery = self.useDiscoveryService)
         if status:
-            x=xmlHandler2.xmlHandler(xmlh,string=1)
-            return x.xmls
+            return xmlh
         else:
             return status