home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _bc58b3c2789a0bbc1e514ad6e8212425 < prev    next >
Text File  |  2000-03-23  |  7KB  |  183 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>WWW::SearchResult - class for results returned from WWW::Search</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> WWW::SearchResult - class for results returned from WWW::Search</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  26.     <LI><A HREF="#required results">REQUIRED RESULTS</A></LI>
  27.     <LI><A HREF="#methods and functions">METHODS AND FUNCTIONS</A></LI>
  28.     <UL>
  29.  
  30.         <LI><A HREF="#new">new</A></LI>
  31.         <LI><A HREF="#url">url</A></LI>
  32.         <LI><A HREF="#urls">urls</A></LI>
  33.         <LI><A HREF="#add_url">add_url</A></LI>
  34.         <LI><A HREF="#related_urls, add_related_url, related_titles, add_related_title">related_urls, add_related_url, related_titles, add_related_title</A></LI>
  35.         <LI><A HREF="#title, description, score, change_date, index_date, size, raw">title, description, score, change_date, index_date, size, raw</A></LI>
  36.         <LI><A HREF="#company, location, source">company, location, source</A></LI>
  37.     </UL>
  38.  
  39. </UL>
  40. <!-- INDEX END -->
  41.  
  42. <HR>
  43. <P>
  44. <H1><A NAME="name">NAME</A></H1>
  45. <P>WWW::SearchResult - class for results returned from WWW::Search</P>
  46. <P>
  47. <HR>
  48. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  49. <UL>
  50. <LI>Linux</LI>
  51. <LI>Solaris</LI>
  52. <LI>Windows</LI>
  53. </UL>
  54. <HR>
  55. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  56. <PRE>
  57.     require WWW::Search;
  58.     require WWW::SearchResult;
  59.     $search = new WWW::Search;
  60.     $search->native_query(WWW::Search::escape_query($query));
  61.     # get first result
  62.     $result = $search->next_result();</PRE>
  63. <P>
  64. <HR>
  65. <H1><A NAME="description">DESCRIPTION</A></H1>
  66. <P>A framework for returning the results of <CODE>WWW::Search</CODE>.</P>
  67. <P>
  68. <HR>
  69. <H1><A NAME="see also">SEE ALSO</A></H1>
  70. <P><A HREF="../../../site/lib/WWW/Search.html">the WWW::Search manpage</A></P>
  71. <P>
  72. <HR>
  73. <H1><A NAME="required results">REQUIRED RESULTS</A></H1>
  74. <P>The particular fields returned in a result are backend- (search
  75. engine-) dependent.  However, all search engines are required to
  76. return a url and title.  (This list may grow in the future.)</P>
  77. <P>
  78. <HR>
  79. <H1><A NAME="methods and functions">METHODS AND FUNCTIONS</A></H1>
  80. <P>
  81. <H2><A NAME="new">new</A></H2>
  82. <P>To create a new WWW::SearchResult, call</P>
  83. <PRE>
  84.     $result = new WWW::SearchResult();</PRE>
  85. <P>
  86. <H2><A NAME="url">url</A></H2>
  87. <P>Returns the primary URL.  Note that there may be a list of urls, see
  88. also methods <CODE>urls</CODE> and <CODE>add_url</CODE>.  Nothing special is guaranteed
  89. about the primary URL other than that it is the first one returned by
  90. the back end.</P>
  91. <P>Every result is required to have at least one URL.</P>
  92. <P>
  93. <H2><A NAME="urls">urls</A></H2>
  94. <P>Return a reference to an array of urls.
  95. There is also a primary URL (<CODE>url</CODE>).
  96. See also <CODE>add_url</CODE>.</P>
  97. <P>
  98. <H2><A NAME="add_url">add_url</A></H2>
  99. <P>Add a URL to the list.</P>
  100. <P>
  101. <H2><A NAME="related_urls, add_related_url, related_titles, add_related_title">related_urls, add_related_url, related_titles, add_related_title</A></H2>
  102. <P>Analgous to urls, these functions provide lists of related URLs
  103. and their titles.  These point to things the search engine thinks
  104. you might want.</P>
  105. <P>
  106. <H2><A NAME="title, description, score, change_date, index_date, size, raw">title, description, score, change_date, index_date, size, raw</A></H2>
  107. <P>Set or get attributes of the result.</P>
  108. <P>None of these attributes is guaranteed to be provided by 
  109. a given backend.  If an attribute is not provided
  110. its method will return <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A>.</P>
  111. <P>Typical contents of these attributes:</P>
  112. <DL>
  113. <DT><STRONG><A NAME="item_title">title</A></STRONG><BR>
  114. <DD>
  115. The title of the hit result (typically that provided by the 'TITLE'
  116. HTML tag).
  117. <P></P>
  118. <DT><STRONG><A NAME="item_description">description</A></STRONG><BR>
  119. <DD>
  120. A brief description of the result, as provided (or not) by the search engine.
  121. Often the first few sentences of the document.
  122. <P></P>
  123. <DT><STRONG><A NAME="item_source">source</A></STRONG><BR>
  124. <DD>
  125. Source is either the base url for this result (as listed on the search
  126. engine's results page) or another copy of the full url path of the
  127. result.  It might also indicate the source site address where the
  128. resource was found, for example, 'http://www.cnn.com' if the search
  129. result page said ``found at CNN.com''.
  130. <P>This value is backend-specific; in fact very few backends set this
  131. value.</P>
  132. <P></P>
  133. <DT><STRONG><A NAME="item_score">score</A></STRONG><BR>
  134. <DD>
  135. A backend specific, numeric score of the search result.
  136. The exact range of scores is search-engine specific.
  137. Usually larger scores are better, but this is no longer required.
  138. See normalized_score for a backend independent score.
  139. <P></P>
  140. <DT><STRONG><A NAME="item_normalized_score">normalized_score</A></STRONG><BR>
  141. <DD>
  142. SORRY, THIS IS NOT IMPLEMENTED.
  143. <P>This is intended to be a backend-independent score of the search
  144. result.  The range of this score is between 0 and 1000.  Higher values
  145. indicate better quality results.</P>
  146. <P></P>
  147. <DT><STRONG><A NAME="item_change_date">change_date</A></STRONG><BR>
  148. <DD>
  149. When the result was last changed.
  150. <P></P>
  151. <DT><STRONG><A NAME="item_index_date">index_date</A></STRONG><BR>
  152. <DD>
  153. When the search engine indexed the result.
  154. <P></P>
  155. <DT><STRONG><A NAME="item_size">size</A></STRONG><BR>
  156. <DD>
  157. The approximate size of the result, in bytes.  This is only an
  158. approximation because search backends often report the size as
  159. ``18.4K''; the best we can do with that number is return it as the value
  160. of 18.4 * 1024.
  161. <P></P>
  162. <DT><STRONG><A NAME="item_raw">raw</A></STRONG><BR>
  163. <DD>
  164. The raw HTML for the entire result.  Raw should be exactly the raw
  165. HTML for one entry.  It should not include list or table setup
  166. commands (like ul or table tags), but it may include list item or
  167. table data commands (like li, tr, or td).  Whether raw contains a list
  168. entry, table row, br-separated lines, or plain text is search-engine
  169. dependent.  In fact, many backends do not even return it at all.
  170. <P></P></DL>
  171. <P>
  172. <H2><A NAME="company, location, source">company, location, source</A></H2>
  173. <P>More attributes of the result.</P>
  174. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  175. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  176. <STRONG><P CLASS=block> WWW::SearchResult - class for results returned from WWW::Search</P></STRONG>
  177. </TD></TR>
  178. </TABLE>
  179.  
  180. </BODY>
  181.  
  182. </HTML>
  183.