Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31170 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

KinoSearch::Index::LexUser(Contributed Perl DocumKinoSearch::Index::Lexicon(3)

NAME
       KinoSearch::Index::Lexicon - Iterator for a field's terms.

SYNOPSIS
	   my $lex_reader = $seg_reader->obtain('KinoSearch::Index::LexiconReader');
	   my $lexicon = $lex_reader->lexicon( field => 'content' );
	   while ( $lexicon->next ) {
	      print $lexicon->get_term . "\n";
	   }

DESCRIPTION
       A Lexicon is an iterator which provides access to all the unique terms
       for a given field in sorted order.

       If an index consists of two documents with a 'content' field holding
       "three blind mice" and "three musketeers" respectively, then iterating
       through the 'content' field's lexicon would produce this list:

	   blind
	   mice
	   musketeers
	   three

ABSTRACT METHODS
   seek(target)
       Seek the Lexicon to the first iterator state which is greater than or
       equal to "target".  If "target" is undef, reset the iterator.

   next()
       Proceed to the next term.

       Returns: true until the iterator is exhausted, then false.

   get_term()
       Return the current term, or undef if the iterator is not in a valid
       state.

   reset()
       Reset the iterator.  next() must be called to proceed to the first
       element.

INHERITANCE
       KinoSearch::Index::Lexicon isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE
       Copyright 2005-2010 Marvin Humphrey

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.14.1			  2011-06-20	 KinoSearch::Index::Lexicon(3)

Vote for polarhome