Commit 3bdab66c authored by Casey Duncan's avatar Casey Duncan

Updated ZCatalog interface to include new index info and document deprecated argument

parent 418efcd0
...@@ -16,9 +16,7 @@ def manage_addZCatalog(id, title, vocab_id=None): ...@@ -16,9 +16,7 @@ def manage_addZCatalog(id, title, vocab_id=None):
Add a ZCatalog object. Add a ZCatalog object.
'vocab_id' is the name of a Vocabulary object this catalog should 'vocab_id' -- this argument is deprecated and ignored.
use. A value of None will cause the Catalog to create its own
private vocabulary.
""" """
...@@ -31,11 +29,10 @@ class ZCatalog: ...@@ -31,11 +29,10 @@ class ZCatalog:
ZCatalog object ZCatalog object
A ZCatalog contains arbitrary index like references to Zope A ZCatalog contains arbitrary index like references to Zope
objects. ZCatalog's can index either 'Field' values of object, objects. ZCatalog's can index object attribute using a variety
'Text' values, or 'KeyWord' values: of "plug-in" index types.
ZCatalogs have three types of Several index types are included, and others may be added.
indexes:
Text -- Text indexes index textual content. The index can be Text -- Text indexes index textual content. The index can be
used to search for objects containing certain words. used to search for objects containing certain words.
...@@ -46,6 +43,20 @@ class ZCatalog: ...@@ -46,6 +43,20 @@ class ZCatalog:
Keyword -- Keyword indexes index sequences of values. The index Keyword -- Keyword indexes index sequences of values. The index
can be used to search for objects that match one or more of the can be used to search for objects that match one or more of the
search terms. search terms.
Path -- Path indexes index URI paths. They allow you to find objects
based on their placement in a hierarchy.
Date -- Date indexes index date and type data. They are a type of field
index specifically optimized for indexing dates.
Date Range -- Date range indexes index time intervals. They are designed
for efficient searching of dates falling between two boundaries
(such as effective / expiration dates).
Topic -- Topic indexes store prefiltered sets of documents. They are used
to optimize complex queries into a single fast query by prefiltering
documents by an expression
The ZCatalog can maintain a table of extra data about cataloged The ZCatalog can maintain a table of extra data about cataloged
objects. This information can be used on search result pages to objects. This information can be used on search result pages to
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment