- TYPE CLASSES
- CONFIG CLASSES
- CLI TOOLS
- BUGS AND LIMITATIONS
- LICENSE AND COPYRIGHT
String::Normal - Just another normal form string transformer.
use String::Normal; my $normalizer = String::Normal->new( type => 'business' ); print $normalizer->transform( 'Jones & Sons Bakeries' ); # bakeri jone son $normalizer = String::Normal->new( type => 'address' ); print $normalizer->transform( '123 Main Street Suite A47' ); # 123 main st $normalizer = String::Normal->new( type => 'phone' ); print $normalizer->transform( '(818) 423-7750' ); # 8184237750 $normalizer = String::Normal->new( type => 'city' ); print $normalizer->transform( 'Los Angeles' ); # los angeles $normalizer = String::Normal->new( type => 'state' ); print $normalizer->transform( 'California' ); # ca $normalizer = String::Normal->new( type => 'zip' ); print $normalizer->transform( '90292' ); # 90292
THIS MODULE IS AN ALPHA RELEASE!
Transform strings into a normal form. Performs tokenization, snowball stemming, stop word removal and complex name compression.
new( %params )
my $normalizer = String::Normal->new( %params );
Constructs object. Accepts the following named parameters:
Available types: business, address, phone, city, state, zip and title. Defaults to
my $normalizer = String::Normal->new( type => 'title' );
various configuration overides
See "TYPE CLASSES" for more information.
transform( $word )
my $scalar = $normalizer->transform( 'Alien 1979 1080p.avi' );
Normalizes word based on given type.
Consider the following values:
Bary & Sons' Bakery Bary's & Sons Bakeries Bary's and Sons' Bakeries
These are business names as potentialy found in business listings. When each of these values is passed to
transform() the return value will be "bakeri bari son." This is accomplished by a number of transformation rules, found in the respective
Rules for business name listings, such as "Bary's Bakery". Provides
my $normalizer = String::Normal->new( business_stem => '/path/to/stem.txt' );
Rules for business address listings, such as "123 Main Street Suite A". Provides
my $normalizer = String::Normal->new( type => 'address', business_stem => '/path/to/stem.txt', );
Rules for names of cities.
Rules for US and Canadian state codes.
Rules for US and Canadian zip codes.
Rules for US area and exchange phone codes. Provides
my $normalizer = String::Normal->new( type => 'phone', area_codes => '/path/to/codes.txt', );
Rules for movie, film and television show titles. Provides
my $normalizer = String::Normal->new( type => 'title', title_stop => '/path/to/stop-words.txt', );
The movitation for such transformation is to identify duplicates when combining multiple digest feeds into a master feed. This transformation (called normalization here) was designed with the need to identify and match duplicate business listings, but can be used to match duplicated from other sources as well, such as movie, film and television show titles.
Each type uses data found in a respective Config class.
Business values are first compressed, then stemmed via Lingua::Stem (with customizations) and finally stop worded.
Contains stop words to be removed from business names.
Stem words are transformed into some normal form, business types use Lingua::Stem with some customizations.
Compress words are combined into one word. Consider:
Box*Mart Box-Mart Box Mart BoxMart
These are all "compressed" into the value
boxmartby specifying the value
box-martin the compression list.
Address values are first stemmed with a simple substitution and then finally stop worded.
Contains stop words to be removed from addresses.
Transforms into some normal form, but does not use Lingua::Stem.
Title values are stop worded first, then stemmed via Lingua::Stem.
Contains stop words to be removed from titles.
Transforms into some normal form, via Lingua::Stem with no customizations.
Valide US and Canadian state codes.
Valid US area codes.
All Config classes can be overriden by specifying your own custom text files.
Quickly transform values without writing a script:
$ normalizer --value='Jones & Sons Bakeries' $ normalizer --value='Los Angeles' --type='city' $ normalizer --file=addresses.txt --type=address
<jeffa at cpan.org>
Documentation is currently light and needs to be expanded.
Please report any bugs or feature requests to either:
bug-string-normal at rt.cpan.org
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
The Github project is https://github.com/jeffa/String-Normal
You can also look for information at:
RT: CPAN's request tracker (report bugs here) http://rt.cpan.org/NoAuth/Bugs.html?Dist=String-Normal
AnnoCPAN: Annotated CPAN documentation http://annocpan.org/dist/String-Normal
CPAN Ratings http://cpanratings.perl.org/d/String-Normal
Search CPAN http://search.cpan.org/dist/String-Normal/
The following people contributed algorithms and strategies in addition to the author. Thank you very much! :)
Copyright 2017 Jeff Anderson.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.