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

Timestamp:

12/02/09 17:32:22 (12 years ago)

Author:

cbyrom

Message:

Adjust granulite to ensure that granule atoms are validated before
they are created - and add code to properly deal with validation errors.

Location:

ndgCommon/trunk/ndg/common/src/lib

Files:

• atomvalidator.py (modified) (3 diffs)
• granulite.py (modified) (7 diffs)

ndgCommon/trunk/ndg/common/src/lib/atomvalidator.py

@@ -55 +55 @@
 
         
-    def __init__(self, atom, dbConfigFile, raiseException = True, \
-                 newLineChar= NEW_LINE, loadAllCollections = False, \
-                 isDebug = False, dbHostName = 'chinook.badc.rl.ac.uk'):
+    def __init__(self, atom, atomClient = None, 
+                 dbHostName = 'chinook.badc.rl.ac.uk',
+                 dbConfigFile = None, 
+                 raiseException = True, 
+                 newLineChar= NEW_LINE, loadAllCollections = False, 
+                 isDebug = False):
         '''
         Set up validator object - with atom to validate
         @param atom: Atom object to validate
+        @keyword atomClient: an eXist client implementing the InterfaceXMLDBAtomClient interface
         @keyword dbConfigFile: config file to use with eXist DB connection
         @keyword raiseException: if True, raise a ValidationException following a failed validation 
@@ -81 +85 @@
         
         # set up connection to eXist
-        self.__setUpEXistDBConnection(dbConfigFile, 
-                                      loadAllCollections = loadAllCollections,
-                                      dbHostName = dbHostName)
+        if atomClient:
+            self._atomClient = atomClient
+        else:
+            self.__setUpEXistDBConnection(dbConfigFile, 
+                                          loadAllCollections = loadAllCollections,
+                                          dbHostName = dbHostName)
 
         # setup the dictionary to store errors
@@ -333 +340 @@
         '''
         logging.info("Validating schema compliance")
-        atomPath = self._atom.getDefaultCollectionPath() + self._atom.atomName
+        atomPath = self._atom.getFullPath()
         try:
             errors = self._atomClient.checkAtomSchemaCompliance(atomPath, atom = self._atom,

ndgCommon/trunk/ndg/common/src/lib/granulite.py

@@ -10 +10 @@
 from ndg.common.src.models import Atom
 import ndg.common.src.lib.utilities as utilities
+from ndg.common.src.lib.atomvalidator import AtomValidator
 from ndg.common.src.models.vocabtermdata import VocabTermData as VTD
 from ndg.common.src.clients.xmldb.eXist.atomclient import AtomClient
@@ -132 +133 @@
         self._cdmlTimeAxis = timeAxis
         self._datasetID = datasetID
+        
+        # AtomValidator to use for validation - only load when needed
+        self.validator = None
             
         logging.info("Granulite data model set up")
@@ -362 +366 @@
         logging.info("Adding granule info to data entities")
         if not self._dataEntityIDs:
-            logging.info("No data entity IDs were specified in granulite - so will not add granule data to cedarmoles DB")
+            logging.info("No data entity IDs were specified in granulite - so will not add granule data to eXist DB")
             return
         
@@ -405 +409 @@
                                            providerID, 
                                            dataEntityID)
+        
+        if not doc:
+            errorMessage = "Could not find data entity, %s - please retry with valid data" %dataEntityID
+            logging.error(errorMessage)
+            raise ValueError(errorMessage)
         logging.debug("DE retrieved")
         
@@ -589 +598 @@
             
         else:
+            # validate the newly created atom - before importing it
+            self.__validateGranuleAtom()
+            
             # add the granule to eXist - if this exists already a DuplicationError
             # will be thrown if backups are not allowed
@@ -610 +622 @@
                 errorMessage = "Exception thrown whilst updating data entities - detail: " + \
                     str(e.message) + \
-                    "Will now roll back changes to granule atom to leave system in original state"
+                    "\n - will now roll back changes to granule atom to leave system in original state"
                 logging.error(errorMessage)
                 self.deleteGranuleAndDEReferences()
@@ -623 +635 @@
         return self._atom
 
+
+    def __validateGranuleAtom(self):
+        '''
+        Validate the granule atom created, using the standard AtomValidator
+        @raise atomvlaidator.ValidationError if any errors are found 
+        '''
+        if not self.validator:
+            self.validator = AtomValidator(None, 
+                                           atomClient = self._eXist,
+                                           newLineChar="<br/>")
+            
+        self.validator.setAtom(self._atom)
+        self.validator.validateAtom()
+        
 
     def deleteGranuleAndDEReferences(self):