[gnue] r7004 - trunk/gnue-common/src/datasources

[kilo]

Author: kilo
Date: 2005-02-11 07:36:42 -0600 (Fri, 11 Feb 2005)
New Revision: 7004

Modified:
   trunk/gnue-common/src/datasources/GConditions.py
Log:
Added documentation.

Modified: trunk/gnue-common/src/datasources/GConditions.py
===================================================================
--- trunk/gnue-common/src/datasources/GConditions.py    2005-02-11 13:19:44 UTC 
(rev 7003)
+++ trunk/gnue-common/src/datasources/GConditions.py    2005-02-11 13:36:42 UTC 
(rev 7004)
@@ -18,11 +18,6 @@
 #
 # Copyright 2000-2005 Free Software Foundation
 #
-# FILE:
-# GConditions.py
-#
-# DESCRIPTION:
-#
 # $Id$
 #
 
@@ -873,27 +868,30 @@
          'ParentTags':  ('conditions','and','or','not','negate','exist') },
       'cfield':       {
          'BaseClass': GCField,
+         'Description': 'Defines a database table\'s field in a condition.',
          'Attributes': {
             'name':     {
-               'Required': 1,
+               'Required': True,
                'Typecast': GTypecast.name } },
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween',
                          'upper', 'lower', 'null', 'notnull') },
       'cparam':       {
          'BaseClass': GCParam,
+         'Description': 'Defines a parameter value in a condition.',
          'Attributes': {
             'name':        {
-               'Required': 1,
-               'Unique':   1,
+               'Required': True,
+               'Unique':   True,
                'Typecast': GTypecast.name } },
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween') },
       'cconst':       {
          'BaseClass': GCConst,
+         'Description': 'Defines a constant value in a condition.',
          'Attributes': {
             'value':     {
-               'Required': 1,
+               'Required': True,
                'Typecast': GTypecast.text },
             'type':     {
                'Typecast': GTypecast.text } },
@@ -901,87 +899,115 @@
                          'div','like','notlike','between','notbetween') },
       'add':       {
          'BaseClass': GCadd,
+         'Description': 'Implements addition.',
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween') },
       'sub':       {
          'BaseClass': GCsub,
+         'Description': 'Implements subtraction.',
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween') },
       'mul':       {
          'BaseClass': GCmul,
+         'Description': 'Implements multiplication.',
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween') },
       'div':       {
          'BaseClass': GCdiv,
+         'Description': 'Implements division.',
          'ParentTags':  ('eq','ne','lt','le','gt','ge','add','sub','mul',
                          'div','like','notlike','between','notbetween') },
       'and':       {
          'BaseClass': GCand,
+         'Description': 'Implements logical AND relation.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'or':       {
          'BaseClass': GCor,
+         'Description': 'Implements logical OR relation.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'not':       {
          'BaseClass': GCnot,
+         'Description': 'Implements logical NOT relation.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'negate':       {
          'BaseClass': GCnegate,
+         'Description': 'Implements numerical negation.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'eq':       {
          'BaseClass': GCeq,
+         'Description': 'Implements a {field} = {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'ne':       {
          'BaseClass': GCne,
+         'Description': 'Implements a {field} <> {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'gt':       {
          'BaseClass': GCgt,
+         'Description': 'Implements a {field} > {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'ge':       {
          'BaseClass': GCge,
+         'Description': 'Implements a {field} >= {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'lt':       {
          'BaseClass': GClt,
+         'Description': 'Implements a {field} < {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'le':       {
          'BaseClass': GCle,
+         'Description': 'Implements a {field} <= {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'like':       {
          'BaseClass': GClike,
+         'Description': 'Implements a {field} LIKE {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'notlike':       {
          'BaseClass': GCnotlike,
+         'Description': 'Implements a {field} NOT LIKE {value} condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'between':       {
          'BaseClass': GCbetween,
+         'Description': 'Implements a {field} BETWEEN {value1} {value2} '
+                        'condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'notbetween':       {
          'BaseClass': GCnotbetween,
+         'Description': 'Implements a {field} NOT BETWEEN {value1} {value2} '
+                        'condition.',
          'ParentTags':  ('condition','and','or','not','negate') },
       'null':      {
          'BaseClass': GCnull,
+         'Description': 'Implements a {field} IS NULL condition.',
          'ParentTags': ('condition','and','or','not') },
       'notnull':      {
          'BaseClass': GCnotnull,
+         'Description': 'Implements a {field} IS NOT NULL condition.',
          'ParentTags': ('condition','and','or','not') },
       'upper':       {
          'BaseClass': GCupper,
+         'Description': 'Implements upper({value}).',
          'ParentTags':  ('eq','ne','lt','le','gt','ge',
                          'like','notlike','between','notbetween') },
       'lower':       {
          'BaseClass': GClower,
+         'Description': 'Implements lower({value}).',
          'ParentTags':  ('eq','ne','lt','le','gt','ge',
                          'like','notlike','between','notbetween') },
       'exist': {
          'BaseClass': GCexist,
+         'Description': 'Implements an exist condition.',
          'Attributes': {
             'table': {
                'Required': True,
+               'Description': 'TODO',
                'Typecast': GTypecast.name },
             'masterlink': {
                'Required': True,
+               'Description': 'TODO',
                'Typecast': GTypecast.text},
             'detaillink': {
                'Required': True,
+               'Description': 'TODO',
                'Typecast': GTypecast.text}},
          'ParentTags':  ('eq','ne','lt','le','gt','ge',
                          'like','notlike','between','notbetween') },