|
|
| Line 1: |
Line 1: |
| − | <!-- Pod2Wiki=_preamble_
| |
| − | This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
| |
| − | -->{{Pod2Wiki}}{{API:Source|file=EPrints/Index.pm|package_name=EPrints::Index}}[[Category:API|Index]]<!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_name -->=NAME=
| |
| − | '''EPrints::Index''' - Methods for indexing objects for later searching.
| |
| | | | |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_description -->=DESCRIPTION=
| |
| − | This module contains methods used to add and remove information from the free-text search indexes.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_functions -->=FUNCTIONS=
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_remove -->==remove==
| |
| − |
| |
| − | EPrints::Index::remove( $session, $dataset, $objectid, $fieldid )
| |
| − |
| |
| − | Remove all indexes to the field in the specified object.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_purge_index -->==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.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_add -->==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.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_update_ordervalues -->==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
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_insert_ordervalues -->==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
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_delete_ordervalues -->==delete_ordervalues==
| |
| − |
| |
| − | EPrints::Index::delete_ordervalues( $session, $dataset, $id )
| |
| − |
| |
| − | Remove the ordervalues for item $id from the ordervalues table of $dataset.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_split_words -->==split_words==
| |
| − |
| |
| − | @words = EPrints::Index::split_words( $session, $utext )
| |
| − |
| |
| − | Splits a utf8 string into individual words.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_apply_mapping -->==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.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
| |
| − | {{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_binfile -->==binfile==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_cleanup_indexer -->==cleanup_indexer==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_do_index -->==do_index==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_do_tick -->==do_tick==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_force_start -->==force_start==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_get_last_tick -->==get_last_tick==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_get_pid -->==get_pid==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_has_stalled -->==has_stalled==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_indexlog -->==indexlog==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_is_running -->==is_running==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_logfile -->==logfile==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_pidfile -->==pidfile==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_rolllogs -->==rolllogs==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_start -->==start==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_stop -->==stop==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_suicidal -->==suicidal==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_suicidefile -->==suicidefile==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_tickfile -->==tickfile==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_write_pid -->==write_pid==
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
| |
