1 | ## |
---|
2 | ## uniquefield.py |
---|
3 | ## Login : <uli@pu.smp.net> |
---|
4 | ## Started on Sat May 28 13:39:15 2011 Uli Fouquet |
---|
5 | ## $Id$ |
---|
6 | ## |
---|
7 | ## Copyright (C) 2011 Uli Fouquet |
---|
8 | ## This program is free software; you can redistribute it and/or modify |
---|
9 | ## it under the terms of the GNU General Public License as published by |
---|
10 | ## the Free Software Foundation; either version 2 of the License, or |
---|
11 | ## (at your option) any later version. |
---|
12 | ## |
---|
13 | ## This program is distributed in the hope that it will be useful, |
---|
14 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
15 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
16 | ## GNU General Public License for more details. |
---|
17 | ## |
---|
18 | ## You should have received a copy of the GNU General Public License |
---|
19 | ## along with this program; if not, write to the Free Software |
---|
20 | ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
---|
21 | ## |
---|
22 | """ |
---|
23 | Unique field indexes. |
---|
24 | """ |
---|
25 | from grok.index import IndexDefinition |
---|
26 | from zope.catalog.field import FieldIndex |
---|
27 | from zope.index.field import FieldIndex as RawFieldIndex |
---|
28 | from zope.interface import implements |
---|
29 | from waeup.sirp.index.interfaces import IUniqueFieldIndex, IUnique |
---|
30 | |
---|
31 | class RawUniqueFieldIndex(RawFieldIndex): |
---|
32 | """Unique field index. |
---|
33 | """ |
---|
34 | implements(IUnique) |
---|
35 | |
---|
36 | def index_doc(self, docid, value): |
---|
37 | """Index some doc. |
---|
38 | """ |
---|
39 | entries = self._fwd_index.get(value, ()) |
---|
40 | if len(entries) > 0 and docid not in entries: |
---|
41 | # Accept already existing entries if docid matches |
---|
42 | # ('reindex' use case). If docid is not contained already, |
---|
43 | # we have a unique-constraint violation. |
---|
44 | raise KeyError( |
---|
45 | 'The value already exists in catalog: %s' % value,) |
---|
46 | return super(RawUniqueFieldIndex, self).index_doc(docid, value) |
---|
47 | |
---|
48 | class UniqueFieldIndex(FieldIndex): |
---|
49 | implements(IUniqueFieldIndex) |
---|
50 | |
---|
51 | class UniqueField(IndexDefinition): |
---|
52 | """A :class:`grok.Indexes` index that matches against an entire field. |
---|
53 | |
---|
54 | Contrary to :class:`grok.index.Field` this index only accepts |
---|
55 | unique values. |
---|
56 | """ |
---|
57 | index_class = UniqueFieldIndex |
---|