NAME

Search::Tools::RegExp::Keywords - access regular expressions for keywords

SYNOPSIS

my $re = Search::Tools::RegExp->new();

my $kw = $re->build('the quick brown fox');
# $kw is a S::T::R::Keywords object

for my $w ($kw->keywords)
{
   my $re = $kw->re( $w ); # $re is S::T::R::Keyword object
   
   # each of these are regular expressions ... suitable for framing
   my $h = $re->html;
   my $p = $re->plain;
}

DESCRIPTION

Search::Tools::RegExp::Keywords provides access to the regular expressions for a query keyword.

METHODS

new

Instantiate an object. This method is used internally by Search::Tools::RegExp->build().

keywords

Returns array of keywords in same order as they appeared in the original query.

re( keyword )

Returns a Search::Tools::RegExp::Keyword object corresponding to keyword.

wildcard

The wildcard character used in constructing the regular expressions. This value is inherited from S::T::RegExp.

word_characters

The regular expression class used in constructing the regular expressions. This value is inherited from S::T::RegExp.

ignore_first_char

The regular expression class used in constructing the regular expressions. This value is inherited from S::T::RegExp.

ignore_last_char

The regular expression class used in constructing the regular expressions. This value is inherited from S::T::RegExp.

kw

Get the original S::T::Keywords object from which the object is derived.

AUTHOR

Peter Karman perl@peknet.com

Based on the HTML::HiLiter regular expression building code, originally by the same author, copyright 2004 by Cray Inc.

Thanks to Atomic Learning www.atomiclearning.com for sponsoring the development of this module.

COPYRIGHT

Copyright 2006 by Peter Karman. This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

HTML::HiLiter, Search::Tools::RegExp, Search::Tools::RegExp::Keyword