Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Search::InvertedIndex:UserrContributed Perl DocSearch::InvertedIndex::Query(3)

NAME
       Search::InvertedIndex::Query - A	query for an inverted index search.

SYNOPSIS
DESCRIPTION
       Provides	methods	for setting up a search	query to be performed by the
       search engine.

   Public API
       Inherits	'get','set','clear' and	'exists' methods from
       Class::NamedParms

   Initialization
       "new($parm_ref);"
	   Returns and optionally initializes a	new
	   Search::InvertedIndex::Query	object.

	   Examples:

	     my	$query = Search::InvertedIndex::Query->new;

	     my	$query = Search::InvertedIndex::Query->new({ -logic => 'or',
							    -weight => 0.5,
							     -nodes => \@query_nodes,
							     -leafs => \@leaf_nodes,
							    });

	   -nodes must be 'Search::InvertedIndex::Query' objects.  -leafs must
	   be 'Search::InvertedIndex::Query::Leaf' objects.  -logic applies to
	   both	-nodes (after search resolution) and -leafs.
		  If omitted, -logic is	defaults to 'and'. Allowed logic
	   values	  are 'and', 'or' and  'nand'.	-weight	is applied to
	   the _result_	of a search of the Query object	and
		   is optional (defaulted to '1' if omitted).

	   Inherits 'get/set' methods from Class::NamedParms - thus to
	   'append' use	the 'get' method on '-nodes' or	'-leafs',  'push' the
	   new thing on	the end	of the anon array return, and use the 'set'
	   method to save the updated anon array.

COPYRIGHT
       Copyright 1999-2020, Jerilyn Franz and FreeRun Technologies, Inc.
       (<URL:http://www.freeruntech.com/>).  All Rights	Reserved.

AUTHOR
       Jerilyn Franz

TODO
       Everything.

perl v5.32.1			  2020-09-27   Search::InvertedIndex::Query(3)

NAME | SYNOPSIS | DESCRIPTION | COPYRIGHT | AUTHOR | TODO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Search::InvertedIndex::Query&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help