.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Weather::Com::Finder 3pm"
.TH Weather::Com::Finder 3pm "2007-07-09" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Weather::Com::Finder \- finder class to search for \fIweather.com\fR location's
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  #!/usr/bin/perl \-w
\&  use Weather::Com::Finder;
.Ve
.PP
.Vb 3
\&  # you have to fill in your ids from weather.com here
\&  my $PartnerId  = \(aqsomepartnerid\(aq;
\&  my $LicenseKey = \(aqmylicense\(aq;
.Ve
.PP
.Vb 4
\&  my %weatherargs = (
\&        \(aqpartner_id\(aq => $PartnerId,
\&        \(aqlicense\(aq    => $LicenseKey,
\&  );
.Ve
.PP
.Vb 1
\&  my $finder = Weather::Com::Finder\->new(%weatherargs);
.Ve
.PP
.Vb 2
\&  # if you want an array of locations:
\&  my @locations = $finder\->find(\(aqHeidelberg\(aq);
.Ve
.PP
.Vb 2
\&  # or if you prefer an arrayref:
\&  my $locations = $finder\->find(\(aqHeidelberg\(aq);
.Ve
.PP
.Vb 5
\&  foreach my $location (@locations) {
\&    print "Found weather for city: ", $location\->name(), "\en";
\&    print "Current Conditions are ", 
\&      $location\->current_conditions()\->description(), "\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The usual way to use the \fIWeather::Com\fR module would be to instantiate
a \fIWeather::Com::Finder\fR that allows you to search for a location
by providing a search string or postal code or any other search string
that \fIweather.com\fR understands.
.PP
The finder returns an arrayref or an array of locations (depending on 
how you call the \f(CW\*(C`find()\*(C'\fR method). Each location is an object of
\&\fIWeather::Com::Location\fR. 
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.Sh "new(hash or hashref)"
.IX Subsection "new(hash or hashref)"
The constructor takes a configuration hash or hashref as described in
the \fIWeather::Com\fR \s-1POD\s0. Please refer to that documentation for further 
details.
.SH "METHODS"
.IX Header "METHODS"
.Sh "find(search string)"
.IX Subsection "find(search string)"
Once you've instantiated a finder object, you can perform \f(CW\*(C`find()\*(C'\fR calls 
to search for locations in the \fIweather.com\fR database.
.PP
The \f(CW\*(C`find()\*(C'\fR method returns an array of \fIWeather::Com::Location\fR objects
if you call it in list context, else an arrayref.
.PP
Returns \fIundef\fR if no matching location could be found.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See also documentation of Weather::Com and Weather::Com::Location.
.SH "AUTHOR"
.IX Header "AUTHOR"
Thomas Schnuecker, <thomas@schnuecker.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2004\-2007 by Thomas Schnuecker
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.PP
The data provided by \fIweather.com\fR and made accessible by this \s-1OO\s0
interface can be used for free under special terms. 
Please have a look at the application programming guide of
\&\fIweather.com\fR (http://www.weather.com/services/xmloap.html)