Apache::Wyrd::Interfaces::Indexable - Pass metadata to Wyrd Index service

NAME

Apache::Wyrd::Interfaces::Indexable - Pass metadata to Wyrd Index service

SYNOPSIS

NONE

DESCRIPTION

Indexable provides the minimum methods required by an object to be indexed using the Apache::Wyrd::Services::Index object. An indexable object can be inserted into the index via the update_entry method of the index.

METHODS

(format: (returns) name (arguments after self))

(scalar) no_index (void)

Returns true if the item should not be indexed. Traditionally supplied via the noindex flag attribute of a Wyrd.

(scalar) force_update (void)

Tells the index to ignore timestamp and digest arguments, and always update the entry for this object even if there is no apparent change

(scalar) index_foo (void)

Where foo is at a minimum of name, timestamp, digest, data, title, and description. Any attributes specified in the attributes option of the Apache::Wyrd::Services::Index object will also need to be implemented in an indexable object. If the attribute is a map, it needs only to return a string of tokens separated by whitespace, punctuation optional.

Because the assumption is that the indexable item will probably be a web page, the path to the file from the server root is the traditional ``name'' of the item. As such, when the results of a search are returned by the Index, the href attribute of a link to the page is created from the name attribute.

Also in this tradition, the default map for searching uses the tokens provided by index_data as the basis for the index' word_search.

AUTHOR

Barry King <wyrd@nospam.wyrdwright.com>

LICENSE

See LICENSE under the documentation for Apache::Wyrd.