API:EPrints/Index

From EPrints Documentation
Revision as of 18:29, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Index - Methods for indexing objects for later searching.

DESCRIPTION

This module contains methods used to add and remove information from the free-text search indexes.

FUNCTIONS

remove

 EPrints::Index::remove( $session, $dataset, $objectid, $fieldid )

Remove all indexes to the field in the specified object.

purge_index

 EPrints::Index::purge_index( $session, $dataset )

Remove all the current index information for the given dataset. Only really useful if used in conjunction with rebuilding the indexes.

add

 EPrints::Index::add( $session, $dataset, $objectid, $fieldid, $value )

Add indexes to the field in the specified object. The index keys will be taken from value.

update_ordervalues

 EPrints::Index::update_ordervalues( $session, $dataset, $data )

Update the order values for an object. $data is a structure returned by $dataobj->get_data

insert_ordervalues

 EPrints::Index::insert_ordervalues( $session, $dataset, $data )

Create the order values for an object. $data is a structure returned by $dataobj->get_data

delete_ordervalues

 EPrints::Index::delete_ordervalues( $session, $dataset, $id )

Remove the ordervalues for item $id from the ordervalues table of $dataset.

split_words

 @words = EPrints::Index::split_words( $session, $utext )

Splits a utf8 string into individual words.

apply_mapping

 $utext2 = EPrints::Index::apply_mapping( $session, $utext )

Replaces certain unicode characters with ASCII equivalents and returns the new string.

This is used before indexing words so that things like umlauts will be ignored when searching.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

binfile

cleanup_indexer

do_index

do_tick

force_start

get_last_tick

get_pid

has_stalled

indexlog

is_running

logfile

pidfile

rolllogs

start

stop

suicidal

suicidefile

tickfile

write_pid