Table of Contents

Class: ZCatalog Zope-2.2.1-src/lib/python/Products/ZCatalog/help/ZCatalog.py

ZCatalog object

A ZCatalog contains arbitrary index like references to Zope objects. ZCatalog's can index either Field values of object, Text values, or KeyWord values:

Indexes

Text

Text indexes index textual content. The index can be used to search for objects containing certain words.

Field

Field indexes index atomic values. The index can be used to search for objects that have certain properties.

Keyword

Keyword indexes index sequences of values. The index can be used to search for objects that match one or more of the search terms.

Meta-data

The ZCatalog can maintain a table of extra data about cataloged objects. This information can be used on search result pages to show information about a search result.

The meta-data table schema is used to build the schema for ZCatalog Result objects. The objects have the same attributes as the column of the meta-data table.

ZCatalog does not store references to the objects themselves, but rather to a unique identifier that defines how to get to the object. In Zope, this unique identifier is the object's relative path to the ZCatalog (since two Zope object's cannot have the same URL, this is an excellent unique qualifier in Zope).

Methods   
__call__
catalog_object
getobject
getpath
index_objects
indexes
schema
searchResults
uncatalog_object
uniqueValuesFor
  __call__ 
__call__ (
        self,
        REQUEST=None,
        **kw,
        )

Search the catalog, the same way as searchResults.

  catalog_object 
catalog_object (
        self,
        obj,
        uid,
        )

Catalogs the object obj with the unique identifier uid.

  getobject 
getobject (
        self,
        rid,
        REQUEST=None,
        )

Return a cataloged object given a data_record_id_

  getpath 
getpath ( self,  rid )

Return the path to a cataloged object given a data_record_id_

  index_objects 
index_objects ( self )

Returns a sequence of actual index objects.

  indexes 
indexes ( self )

Returns a sequence of names that correspond to indexes.

  schema 
schema ( self )

Returns a sequence of names that correspond to columns in the meta-data table.

  searchResults 
searchResults (
        self,
        REQUEST=None,
        **kw,
        )

Search the catalog. Search terms can be passed in the REQUEST or as keyword arguments.

XXX search grammar, how terms are combined, special search terms, format of returned results XXX

  uncatalog_object 
uncatalog_object ( self,  uid )

Uncatalogs the object with the unique identifier uid.

  uniqueValuesFor 
uniqueValuesFor ( self,  name )

returns the unique values for a given FieldIndex named name.


Table of Contents

This document was automatically generated on Mon Sep 4 07:33:06 2000 by HappyDoc version r0_6