##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Text catalog indexes
"""
import zope.index.text
import zope.index.text.interfaces
import zope.interface
import zope.catalog.attribute
import zope.catalog.interfaces
import zope.container.contained
from zope.i18nmessageid import ZopeMessageFactory as _
[docs]class ITextIndex(zope.catalog.interfaces.IAttributeIndex,
zope.catalog.interfaces.ICatalogIndex):
"""
Interface-based catalog text index.
We redefine the fields that :class:`zope.catalog.interfaces.IAttributeIndex`
defines in order to change their defaults.
"""
interface = zope.schema.Choice(
title=_(u"Interface"),
description=_(u"Objects will be adapted to this interface. "
u"The default is :class:`zope.index.text.interfaces.ISearchableText`"),
vocabulary=_("Interfaces"),
required=False,
default=zope.index.text.interfaces.ISearchableText,
)
field_name = zope.schema.NativeStringLine(
title=_(u"Field Name"),
description=_(u"Name of the field to index. Defaults to ``getSearchableText``."),
default="getSearchableText"
)
field_callable = zope.schema.Bool(
title=_(u"Field Callable"),
description=_(u"If true (the default), then the field should be called to get the "
u"value to be indexed"),
default=True,
)
[docs]@zope.interface.implementer(ITextIndex)
class TextIndex(zope.catalog.attribute.AttributeIndex,
zope.index.text.TextIndex,
zope.container.contained.Contained):
"""
Default implementation of :class:`ITextIndex`.
"""