[gnue] r9103 - trunk/gnue-forms/src/GFObjects

[reinhard]

Author: reinhard
Date: 2006-12-04 10:08:14 -0600 (Mon, 04 Dec 2006)
New Revision: 9103

Modified:
   trunk/gnue-forms/src/GFObjects/GFField.py
Log:
Function name cleanup.


Modified: trunk/gnue-forms/src/GFObjects/GFField.py
===================================================================
--- trunk/gnue-forms/src/GFObjects/GFField.py   2006-12-04 15:45:43 UTC (rev 
9102)
+++ trunk/gnue-forms/src/GFObjects/GFField.py   2006-12-04 16:08:14 UTC (rev 
9103)
@@ -108,19 +108,18 @@
             'autofillBySequence': {'function': self.triggerAutofillBySequence},
             'isEmpty'           : {'function': self.isEmpty},
             'resetForeignKey'   : {'function': self.resetForeignKey},
-            'set'               : {'function': self.setValue},
-            'get'               : {'function': self.getValue},
+            'get'               : {'function': self.__get_value},
+            'set'               : {'function': self.__set_value},
             'clear'             : {'function': self.resetToDefault},
-            'getFKDescription'  : {'function': self.getFKDescription},
-            'setFKDescription'  : {'function': self.setFKDescription},
-        }
+            'getFKDescription'  : {'function': self.get_value},
+            'setFKDescription'  : {'function': self.set_value}}
 
         self._triggerProperties = {
-            'value': {'set': self.setValue,
-                      'get': self.getValue}}
+            'value': {'get': self.get_value,
+                      'set': self.set_value}}
 
-        self._triggerSet = self.setValue
-        self._triggerGet = self.getValue
+        self._triggerGet = self.__get_value
+        self._triggerSet = self.__set_value
 
 
     # -------------------------------------------------------------------------
@@ -235,16 +234,16 @@
     # Reading and writing the user value of the field
     # -------------------------------------------------------------------------
 
-    def get_user_value(self):
+    def get_value(self):
         """
         Return the current user value of the field. For lookup fields, this is
         the foreign key description.
         """
 
         if not self.__is_lookup:
-            return self.getValue()
+            return self.__get_value()
 
-        db_value = '%s' % self.getValue()       # convert to string or unicode
+        db_value = '%s' % self.__get_value()    # convert to string or unicode
 
         if db_value in self._allowedValues:
             return self._allowedValues[db_value]
@@ -254,14 +253,18 @@
 
     # -------------------------------------------------------------------------
 
-    def set_user_value(self, value):
+    def set_value(self, value):
         """
         Set the current user value of the field. For lookup fields, this is the
         foreign key description.
         """
 
+        if not self.__is_lookup:
+            self.__set_value(value)
+            return
+
         if value in self._allowedValuesReverse:
-            self.setValue(self._allowedValuesReverse[value])
+            self.__set_value(self._allowedValuesReverse[value])
         else:
             raise InvalidFieldValueError(self.name, value)
 
@@ -269,7 +272,7 @@
     # Reading and writing the DB value of a field
     # -------------------------------------------------------------------------
 
-    def getValue(self, offset=0):
+    def __get_value(self, offset=0):
         """
         Return the current value of the field, depending on the state of the
         form and the block.
@@ -285,7 +288,7 @@
             value = datatypes.convert(value, self.datatype, self.length,
                     self.scale)
         except ValueError, datatypes.ConversionError:
-            raise DBValueError(self.name, value)
+            raise InvalidDBValueError(self.name, value)
 
         if isinstance(value, basestring):
             if self.rtrim:
@@ -297,7 +300,7 @@
 
     # -------------------------------------------------------------------------
 
-    def setValue(self, value):
+    def __set_value(self, value):
         """
         Set the current value of the field, depending on the state of the form
         and the block.
@@ -345,7 +348,7 @@
         # If the field is a foreign key, move the result set to the
         # selected value.
         if hasattr(self, '_GFField__fk_resultSet'):
-            self.__fk_resultSet.findRecord({self.fk_key: self.getValue()})
+            self.__fk_resultSet.findRecord({self.fk_key: self.__get_value()})
             # This will cause __refresh_ui_current() to be called via
             # __dsCursorMoved
         else:
@@ -423,7 +426,7 @@
         # Example: two dropdowns are bound to the same database field, when
         # changing the value of one dropdown, the other dropdown follows
         # through this method.
-        # The entry causing the fk record change has already posted a setValue
+        # The entry causing the fk record change has already posted a set_value
         # for this field; our current record already contians the correct data.
         # All we have to do is tell our UI to update.
         self.__refresh_ui_current()
@@ -455,7 +458,7 @@
 
         # And now, position the resultSet to the correct record according to
         # the current field content.
-        resultSet.findRecord({self.fk_key: self.getValue()})
+        resultSet.findRecord({self.fk_key: self.__get_value()})
 
         # Remember the resultSet for later
         self.__fk_resultSet = resultSet
@@ -480,7 +483,7 @@
         """
 
         if hasattr(self, '_GFField__fk_resultSet'):
-            self.__fk_resultSet.findRecord({self.fk_key: self.getValue()})
+            self.__fk_resultSet.findRecord({self.fk_key: self.__get_value()})
 
 
     # -------------------------------------------------------------------------
@@ -507,13 +510,13 @@
             entry.refresh_ui_choices(self._allowedValuesDescr)
 
 
-    # =========================================================================
+    # -------------------------------------------------------------------------
     # Trigger functions
-    # =========================================================================
+    # -------------------------------------------------------------------------
 
     def isEmpty(self):
 
-        return self.getValue() in ("", None)
+        return self.__get_value() in ("", None)
 
     # -------------------------------------------------------------------------
 
@@ -527,7 +530,7 @@
         else:
             default = self.__get_default()
 
-        self.setValue (default)
+        self.__set_value(default)
 
     # -------------------------------------------------------------------------
 
@@ -558,45 +561,21 @@
 
     # -------------------------------------------------------------------------
 
-    def getFKDescription(self):
-        """
-        This function returns the description of the foreign key or None if
-        there's no fk_source available.
+    def triggerAutofillBySequence(self, sequenceName):
 
-        @return: value of fk_description
-        """
+        if (not self.__get_value()) or self.__get_value() == "":
+            con = self._block._dataSourceLink._connection
+            self.__set_value(con.getSequence(sequenceName))
 
-        if self._allowedValues is None:
-            return None
 
-        return self._allowedValues.get(str(self.getValue()))
-
     # -------------------------------------------------------------------------
-
-    def setFKDescription(self, fkValue):
-        """
-        This function set's the field's value by it's foreign key description.
-
-        @param fkValue: value of fk_description
-        """
-
-        if self._allowedValues is None or self.getFKDescription() == fkValue:
-            return None
-
-        # TODO: Shall we raise an exception if an invalid value is given?  Same
-        # applies to setValue() which does *not* raise one atm too
-        self.setValue(self._allowedValuesReverse.get(fkValue))
-
-
+    # Deprecated functions (temporary until displayHandler is cleaned up)
     # -------------------------------------------------------------------------
 
-    def triggerAutofillBySequence(self, sequenceName):
+    getValue = __get_value
+    setValue = __set_value
 
-        if (not self.getValue()) or self.getValue() == "":
-            con = self._block._dataSourceLink._connection
-            self.setValue(con.getSequence(sequenceName))
 
-
 # =============================================================================
 # Exceptions
 # =============================================================================