Query.py 2.74 KB
Newer Older
Ivan Tyagov's avatar
Ivan Tyagov committed
1 2
##############################################################################
#
3 4 5 6
# Copyright (c) 2002-2006 Nexedi SARL and Contributors. All Rights Reserved.
# Copyright (c) 2007-2009 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#                    Vincent Pelletier <vincent@nexedi.com>
Ivan Tyagov's avatar
Ivan Tyagov committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

31
from Products.ZSQLCatalog.interfaces.query import IQuery
32 33
from zope.interface.verify import verifyClass
from zope.interface import implements
Jérome Perrin's avatar
Jérome Perrin committed
34

35
class Query(object):
Ivan Tyagov's avatar
Ivan Tyagov committed
36
  """
37 38
    This is the base class of all kind of queries. Its only purpose is to be
    able to distinguish any kind of value from a query.
Ivan Tyagov's avatar
Ivan Tyagov committed
39
  """
40

41
  implements(IQuery)
42
  __allow_access_to_unprotected_subobjects__ = 1
43

44
  def asSQLExpression(self, sql_catalog, column_map, only_group_columns):
Ivan Tyagov's avatar
Ivan Tyagov committed
45
    """
46
      To enable SQL rendering, overload this method in a subclass.
Ivan Tyagov's avatar
Ivan Tyagov committed
47
    """
Aurel's avatar
Aurel committed
48
    raise TypeError('A %s cannot be rendered as an SQL expression.' % (self.__class__.__name__, ))
Ivan Tyagov's avatar
Ivan Tyagov committed
49

50
  def _asSearchTextExpression(self, sql_catalog, column=None):
Ivan Tyagov's avatar
Ivan Tyagov committed
51
    """
52
      To enable Search Text rendering, overload this method in a subclass.
Ivan Tyagov's avatar
Ivan Tyagov committed
53
    """
Aurel's avatar
Aurel committed
54
    raise TypeError('A %s cannot be rendered as a SearchText expression.' % (self.__class__.__name__, ))
Ivan Tyagov's avatar
Ivan Tyagov committed
55

56 57 58
  def asSearchTextExpression(self, sql_catalog, column=None):
    return self._asSearchTextExpression(sql_catalog, column=column)[1]

59
  def registerColumnMap(self, sql_catalog, column_map):
Ivan Tyagov's avatar
Ivan Tyagov committed
60
    """
61
      This method must always be overloaded by subclasses.
Ivan Tyagov's avatar
Ivan Tyagov committed
62
    """
Aurel's avatar
Aurel committed
63
    raise NotImplementedError('%s is incompletely implemented.' % (self.__class__.__name__, ))
Ivan Tyagov's avatar
Ivan Tyagov committed
64

65
verifyClass(IQuery, Query)
Ivan Tyagov's avatar
Ivan Tyagov committed
66