debian man page for weather::com::finder

Weather::Com::Finder(3pm)				User Contributed Perl Documentation				 Weather::Com::Finder(3pm)

NAME
       Weather::Com::Finder - finder class to search for weather.com location's

SYNOPSIS
	 #!/usr/bin/perl -w
	 use Weather::Com::Finder;

	 # you have to fill in your ids from weather.com here
	 my $PartnerId	= 'somepartnerid';
	 my $LicenseKey = 'mylicense';

	 my %weatherargs = (
	       'partner_id' => $PartnerId,
	       'license'    => $LicenseKey,
	 );

	 my $finder = Weather::Com::Finder->new(%weatherargs);

	 # if you want an array of locations:
	 my @locations = $finder->find('Heidelberg');

	 # or if you prefer an arrayref:
	 my $locations = $finder->find('Heidelberg');

	 foreach my $location (@locations) {
	   print "Found weather for city: ", $location->name(), "
";
	   print "Current Conditions are ",
	     $location->current_conditions()->description(), "
";
	 }

DESCRIPTION
       The usual way to use the Weather::Com module would be to instantiate a Weather::Com::Finder that allows you to search for a location by
       providing a search string or postal code or any other search string that weather.com understands.

       The finder returns an arrayref or an array of locations (depending on how you call the "find()" method). Each location is an object of
       Weather::Com::Location.

CONSTRUCTOR
       new(hash or hashref)

       The constructor takes a configuration hash or hashref as described in the Weather::Com POD. Please refer to that documentation for further
       details.

METHODS
       find(search string)

       Once you've instantiated a finder object, you can perform "find()" calls to search for locations in the weather.com database.

       The "find()" method returns an array of Weather::Com::Location objects if you call it in list context, else an arrayref.

       Returns undef if no matching location could be found.

SEE ALSO
       See also documentation of Weather::Com and Weather::Com::Location.

AUTHOR
       Thomas Schnuecker, <thomas@schnuecker.de>

COPYRIGHT AND LICENSE
       Copyright (C) 2004-2007 by Thomas Schnuecker

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

       The data provided by weather.com and made accessible by this OO interface can be used for free under special terms.  Please have a look at
       the application programming guide of weather.com (http://www.weather.com/services/xmloap.html)

perl v5.8.8							    2007-07-09						 Weather::Com::Finder(3pm)