added setorderprop() and setlabelprop() to Class (lots of patches)

Richard Jones · Richard Jones · commit 57da1e5009a5 · 2006-01-20T02:40:56.000Z
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -17,6 +17,7 @@ Feature:
 - allow preselection of values in templating menu()s (sf patch 1396085)
 - display the query name in the header (sf feature 1298535 / patch 1349387)
 - classhelp works with Link properties now (sf bug 1410290)
+- added setorderprop() and setlabelprop() to Class (lots of patches)
 
 Fixed:
 - MySQL now creates String columns using the TEXT column type
diff --git a/doc/customizing.txt b/doc/customizing.txt
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.188 $
+:Version: $Revision: 1.189 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -352,8 +352,10 @@ The ``schema.py`` module contains two functions:
 The "classic" schema
 --------------------
 
-The "classic" schema looks like this (see below for the meaning
-of ``'setkey'``)::
+The "classic" schema looks like this (see section `setkey(property)`_
+below for the meaning of ``'setkey'`` -- you may also want to look into
+the sections `setlabelprop(property)`_ and `setorderprop(property)`_ for
+specifying (default) labelling and ordering of classes.)::
 
     pri = Class(db, "priority", name=String(), order=String())
     pri.setkey("name")
@@ -548,12 +550,37 @@ or::
 
 Note, the same thing can be done in the web and e-mail interfaces. 
 
-If a class does not have an "order" property, the key is also used to
-sort instances of the class when it is rendered in the user interface.
-(If a class has no "order" property, sorting is by the labelproperty of
-the class. This is computed, in order of precedence, as the key, the
-"name", the "title", or the first property alphabetically.)
+setlabelprop(property)
+~~~~~~~~~~~~~~~~~~~~~~
+
+Select a property of the class to be the label property. The label
+property is used whereever an item should be uniquely identified, e.g.,
+when displaying a link to an item. If setlabelprop is not specified for
+a class, the following values are tried for the label: 
+
+ * the key of the class (see the `setkey(property)`_ section above)
+ * the "name" property
+ * the "title" property
+ * the first property from the sorted property name list
+
+So in most cases you can get away without specifying setlabelprop
+explicitly.
+
+setorderprop(property)
+~~~~~~~~~~~~~~~~~~~~~~
+
+Select a property of the class to be the order property. The order
+property is used whenever using a default sort order for the class,
+e.g., when grouping or sorting class A by a link to class B in the user
+interface, the order property of class B is used for sorting.  If
+setorderprop is not specified for a class, the following values are tried
+for the order property:
+
+ * the property named "order"
+ * the label property (see `setlabelprop(property)`_ above)
 
+So in most cases you can get away without specifying setorderprop
+explicitly.
 
 create(information)
 ~~~~~~~~~~~~~~~~~~~
diff --git a/roundup/backends/back_anydbm.py b/roundup/backends/back_anydbm.py
@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-#$Id: back_anydbm.py,v 1.191 2006-01-13 00:05:46 richard Exp $
+#$Id: back_anydbm.py,v 1.192 2006-01-20 02:40:56 richard Exp $
 '''This module defines a backend that saves the hyperdatabase in a
 database chosen by anydbm. It is guaranteed to always be available in python
 versions >2.1.1 (the dumbdbm fallback in 2.1.1 and earlier has several
@@ -1380,31 +1380,6 @@ def getkey(self):
         '''Return the name of the key property for this class or None.'''
         return self.key
 
-    def labelprop(self, default_to_id=0):
-        '''Return the property name for a label for the given node.
-
-        This method attempts to generate a consistent label for the node.
-        It tries the following in order:
-
-        1. key property
-        2. "name" property
-        3. "title" property
-        4. first property from the sorted property name list
-        '''
-        k = self.getkey()
-        if  k:
-            return k
-        props = self.getprops()
-        if props.has_key('name'):
-            return 'name'
-        elif props.has_key('title'):
-            return 'title'
-        if default_to_id:
-            return 'id'
-        props = props.keys()
-        props.sort()
-        return props[0]
-
     # TODO: set up a separate index db file for this? profile?
     def lookup(self, keyvalue):
         '''Locate a particular node by its key property and return its id.
@@ -1786,12 +1761,8 @@ def filter(self, search_matches, filterspec, sort=(None,None),
                         elif isinstance(propclass, hyperdb.Link):
                             lcn = propclass.classname
                             link = self.db.classes[lcn]
-                            key = None
-                            if link.getprops().has_key('order'):
-                                key = 'order'
-                            elif link.getkey():
-                                key = link.getkey()
-                            if key:
+                            key = link.orderprop()
+                            if key!='id':
                                 if not lcache.has_key(v):
                                     # open the link class db if it's not already
                                     if lcldb is None:
diff --git a/roundup/backends/back_metakit.py b/roundup/backends/back_metakit.py
@@ -1,4 +1,4 @@
-# $Id: back_metakit.py,v 1.98 2005-10-07 05:35:04 richard Exp $
+# $Id: back_metakit.py,v 1.99 2006-01-20 02:40:56 richard Exp $
 '''Metakit backend for Roundup, originally by Gordon McMillan.
 
 Known Current Bugs:
@@ -1386,11 +1386,7 @@ def ff(row, r=regexes):
                     lv = linkclass.getview()
                     lv = lv.rename('id', propname)
                     v = v.join(lv, prop, 1)
-                    if linkclass.getprops().has_key('order'):
-                        propname = 'order'
-                    else:
-                        propname = linkclass.labelprop()
-                    prop = getattr(v, propname)
+                    prop = getattr(v, linkclass.orderprop())
                 if isreversed:
                     rev.append(prop)
                 sortspec.append(prop)
@@ -1415,31 +1411,6 @@ def hasnode(self, nodeid):
         '''
         return int(nodeid) < self.maxid
 
-    def labelprop(self, default_to_id=0):
-        '''Return the property name for a label for the given node.
-
-        This method attempts to generate a consistent label for the node.
-        It tries the following in order:
-
-        1. key property
-        2. "name" property
-        3. "title" property
-        4. first property from the sorted property name list
-        '''
-        k = self.getkey()
-        if  k:
-            return k
-        props = self.getprops()
-        if props.has_key('name'):
-            return 'name'
-        elif props.has_key('title'):
-            return 'title'
-        if default_to_id:
-            return 'id'
-        props = props.keys()
-        props.sort()
-        return props[0]
-
     def stringFind(self, **requirements):
         '''Locate a particular node by matching a set of its String
         properties in a caseless search.
diff --git a/roundup/backends/back_mysql.py b/roundup/backends/back_mysql.py
@@ -1,4 +1,4 @@
-#$Id: back_mysql.py,v 1.63 2006-01-13 01:21:14 richard Exp $
+#$Id: back_mysql.py,v 1.64 2006-01-20 02:40:56 richard Exp $
 #
 # Copyright (c) 2003 Martynas Sklyzmantas, Andrey Lebedev <andrey@micro.lt>
 #
@@ -738,14 +738,13 @@ def filter(self, search_matches, filterspec, sort=(None,None),
                     lcn = props[prop].classname
                     link = self.db.classes[lcn]
                     o = '_%s._%s'%(cn, prop)
-                    if link.getprops().has_key('order'):
+                    op = link.orderprop ()
+                    if op != 'id':
                         tn = '_' + lcn
                         loj.append('LEFT OUTER JOIN %s on %s=%s.id'%(tn,
                             o, tn))
-                        ordercols.append(tn + '._order')
-                        o = tn + '._order'
-                    else:
-                        ordercols.append(o)
+                        o = tn + '._%s'%op
+                    ordercols.append(o)
                 elif prop == 'id':
                     o = '_%s.id'%cn
                 else:
diff --git a/roundup/backends/rdbms_common.py b/roundup/backends/rdbms_common.py
@@ -1,4 +1,4 @@
-# $Id: rdbms_common.py,v 1.160 2006-01-13 00:05:46 richard Exp $
+# $Id: rdbms_common.py,v 1.161 2006-01-20 02:40:56 richard Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -1848,31 +1848,6 @@ def getkey(self):
         '''Return the name of the key property for this class or None.'''
         return self.key
 
-    def labelprop(self, default_to_id=0):
-        '''Return the property name for a label for the given node.
-
-        This method attempts to generate a consistent label for the node.
-        It tries the following in order:
-
-        1. key property
-        2. "name" property
-        3. "title" property
-        4. first property from the sorted property name list
-        '''
-        k = self.getkey()
-        if  k:
-            return k
-        props = self.getprops()
-        if props.has_key('name'):
-            return 'name'
-        elif props.has_key('title'):
-            return 'title'
-        if default_to_id:
-            return 'id'
-        props = props.keys()
-        props.sort()
-        return props[0]
-
     def lookup(self, keyvalue):
         '''Locate a particular node by its key property and return its id.
 
@@ -2224,14 +2199,13 @@ def filter(self, search_matches, filterspec, sort=(None,None),
                     lcn = props[prop].classname
                     link = self.db.classes[lcn]
                     o = '_%s._%s'%(cn, prop)
-                    if link.getprops().has_key('order'):
+                    op = link.orderprop()
+                    if op != 'id':
                         tn = '_' + lcn
                         loj.append('LEFT OUTER JOIN %s on %s=%s.id'%(tn,
                             o, tn))
-                        ordercols.append(tn + '._order')
-                        o = tn + '._order'
-                    else:
-                        ordercols.append(o)
+                        o = tn + '._%s'%op
+                    ordercols.append(o)
                 elif prop == 'id':
                     o = '_%s.id'%cn
                 else:
diff --git a/roundup/hyperdb.py b/roundup/hyperdb.py
@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: hyperdb.py,v 1.112 2006-01-13 00:05:46 richard Exp $
+# $Id: hyperdb.py,v 1.113 2006-01-20 02:40:56 richard Exp $
 
 """Hyperdatabase implementation, especially field types.
 """
@@ -591,6 +591,22 @@ def setkey(self, propname):
         """
         raise NotImplementedError
 
+    def setlabelprop (self, labelprop):
+        """Set the label property. Used for override of labelprop
+           resolution order.
+        """
+        if labelprop not in self.getprops () :
+            raise ValueError, "Not a property name: %s" % labelprop
+        self._labelprop = labelprop
+
+    def setorderprop (self, orderprop):
+        """Set the order property. Used for override of orderprop
+           resolution order
+        """
+        if orderprop not in self.getprops () :
+            raise ValueError, "Not a property name: %s" % orderprop
+        self._orderprop = orderprop
+
     def getkey(self):
         """Return the name of the key property for this class or None."""
         raise NotImplementedError
@@ -601,12 +617,45 @@ def labelprop(self, default_to_id=0):
         This method attempts to generate a consistent label for the node.
         It tries the following in order:
 
+        0. self._labelprop if set
         1. key property
         2. "name" property
         3. "title" property
         4. first property from the sorted property name list
         """
-        raise NotImplementedError
+        if hasattr (self, '_labelprop') :
+            return self._labelprop
+        k = self.getkey()
+        if  k:
+            return k
+        props = self.getprops()
+        if props.has_key('name'):
+            return 'name'
+        elif props.has_key('title'):
+            return 'title'
+        if default_to_id:
+            return 'id'
+        props = props.keys()
+        props.sort()
+        return props[0]
+
+    def orderprop (self):
+        """Return the property name to use for sorting for the given node.
+
+        This method computes the property for sorting. 
+        It tries the following in order:
+
+        0. self._orderprop if set
+        1. "order" property
+        2. self.labelprop ()
+        """
+
+        if hasattr (self, '_orderprop') :
+            return self._orderprop
+        props = self.getprops ()
+        if props.has_key ('order'):
+            return 'order'
+        return self.labelprop ()
 
     def lookup(self, keyvalue):
         """Locate a particular node by its key property and return its id.
