Zope 3 apidoc

Base interfaces

Attributes/Fields

__parent__ * - Field (default = None)
field_callable * - Bool (default = True)

Field Callable

If true, then the field should be called to get the value to be indexed
field_name * - BytesLine (default = 'searchableText')

Field Name

Name of the field to index
interface - Choice (default = <InterfaceClass zope.index.text.interfaces.ISearchableText>)

Interface

Objects will be adapted to this interface

* = required

Methods

apply(query)
Apply an index to the given query

The type if the query is index specific.

TODO This is somewhat problemetic. It means that application code that calls apply has to be aware of the expected query type. This isn't too much of a problem now, as we have no more general query language nor do we have any sort of automatic query-form generation.
It would be nice to have a system later for having query-form generation or, perhaps, sme sort of query language. At that point, we'll need some sort of way to determine query types, presumably through introspection of the index objects.

A result is returned that is:
- An IFBTree or an IFBucket mapping document ids to floating-point scores for document ids of documents that match the query,
- An IFSet or IFTreeSet containing document ids of documents that match the query, or
- None, indicating that the index could not use the query and that the result should have no impact on determining a final result.
index_doc(docid, value)

Add a document to the index.

docid: int, identifying the document

value: the value to be indexed

return: None

This can also be used to reindex documents.
clear()

Unindex all documents indexed by the index
unindex_doc(docid)

Remove a document from the index.

docid: int, identifying the document

return: None

This call is a no-op if the docid isn't in the index, however, after this call, the index should have no references to the docid.

Adapters for objects providing this interface:

Specific Adapters

There are no specific adapters registered for this interface.

Extended Adapters

zope.app.catalog.catalog.indexAdded

registered: Zope3/zope.app.catalog-3.5.1-py2.4.egg/zope/app/catalog/subscribers.zcml (line 7)

requires: zope.app.catalog.interfaces.ICatalogIndex , zope.app.container.interfaces.IObjectAddedEvent

provides: No interface provided.

Generic Adapters

Views

Other Information

Factories

A list of factories that create objects implementing this interface.

BrowserAdd__zope.app.catalog.text.TextIndex

Classes

A list of classes that implement this interface. This might duplicate the entries in Utilities.

zope.app.catalog.text.TextIndex

Interface
zope.app.catalog.text.ITextIndex

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Factories

Classes

Interface zope.app.catalog.text.ITextIndex

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Factories

Classes

Interface
zope.app.catalog.text.ITextIndex