PLC/AddressTypes.py

   1 #
   2 # Functions for interacting with the address_types table in the database
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7
   8 from PLC.Faults import *
   9 from PLC.Parameter import Parameter
  10 from PLC.Filter import Filter
  11 from PLC.Table import Row, Table
  12
  13 class AddressType(Row):
  14     """
  15     Representation of a row in the address_types table. To use,
  16     instantiate with a dict of values.
  17     """
  18
  19     table_name = 'address_types'
  20     primary_key = 'address_type_id'
  21     join_tables = ['address_address_type']
  22     fields = {
  23         'address_type_id': Parameter(int, "Address type identifier"),
  24         'name': Parameter(str, "Address type", max = 20),
  25         'description': Parameter(str, "Address type description", max = 254),
  26         }
  27
  28     def validate_name(self, name):
  29         # Make sure name is not blank
  30         if not len(name):
  31             raise PLCInvalidArgument("Address type must be specified")
  32
  33         # Make sure address type does not already exist
  34         conflicts = AddressTypes(self.api, [name])
  35         for address_type_id in conflicts:
  36             if 'address_type_id' not in self or self['address_type_id'] != address_type_id:
  37                 raise PLCInvalidArgument("Address type name already in use")
  38
  39         return name
  40
  41 class AddressTypes(Table):
  42     """
  43     Representation of the address_types table in the database.
  44     """
  45
  46     def __init__(self, api, address_type_filter = None, columns = None):
  47         Table.__init__(self, api, AddressType, columns)
  48
  49         sql = "SELECT %s FROM address_types WHERE True" % \
  50               ", ".join(self.columns)
  51
  52         if address_type_filter is not None:
  53             if isinstance(address_type_filter, (list, tuple, set)):
  54                 # Separate the list into integers and strings
  55                 ints = [x for x in address_type_filter if isinstance(x, int)]
  56                 strs = [x for x in address_type_filter if isinstance(x, str)]
  57                 address_type_filter = Filter(AddressType.fields, {'address_type_id': ints, 'name': strs})
  58                 sql += " AND (%s) %s" % address_type_filter.sql(api, "OR")
  59             elif isinstance(address_type_filter, dict):
  60                 address_type_filter = Filter(AddressType.fields, address_type_filter)
  61                 sql += " AND (%s) %s" % address_type_filter.sql(api, "AND")
  62             elif isinstance(address_type_filter, int):
  63                 address_type_filter = Filter(AddressType.fields, {'address_type_id': address_type_filter})
  64                 sql += " AND (%s) %s" % address_type_filter.sql(api, "AND")
  65             elif isinstance(address_type_filter, str):
  66                 address_type_filter = Filter(AddressType.fields, {'name': address_type_filter})
  67                 sql += " AND (%s) %s" % address_type_filter.sql(api, "AND")
  68             else:
  69                 raise PLCInvalidArgument("Wrong address type filter %r"%address_type_filter)
  70
  71         self.selectall(sql)