Aranea::XML::PageEntry

CONTENTS


NAME

Aranea::XML::PageEntry - object representing the <page_entry> of an Aranea XML object


SYNOPSIS


  my $page_list = $Aranea->candidate_list();
  my $entries = $page_list->entries();
 
  for my $entry ( @$entries ) {
     # do stuff...
  }


DESCRIPTION

The PageEntry object represents a single entry inside the page_list section of an Aranea XML object. Here is an example:


  <entry>
    <id>0</id>
    <page_summary>here is some text</page_summary>
    <page_cache_url> http://www.foo.com/cache.html </page_cache_url>
    <page_title>Sample</page_title>
    <page_paragraph>This is a pragraph and here is some text in that paragraph that was returned as a summary.</page_paragraph>
    <page_url> http://www.foo.com/sample.html </page_url>
  </entry>

The PageList object serves as a container for a collection of PageEntrys.


METHODS

new()
Constructs an empty PageEntry.

id([$scalar])
Accesses or mutates the id. This value identifies the request from which this PageEntry derives.

page_url([$scalar])
Accesses or mutates the page URL.

page_title([$scalar])
Accesses or mutates the page title.

page_summary([$scalar])
Accesses or mutates the page summary.

page_paragraph([$scalar])
Accesses or mutates the page paragraph.

page_category([$scalar])
Accesses or mutates the page category. Google cross indexes its search results with Yahoo categories.

page_url_cache([$scalar])
Accesses or mutates the URL of the cached page.

write_xml($writer)
Writes the XML representation of this CandidateList; takes an XML::Writer as its only argument. Note that this method is rarely invoked manually; under typical usage patterns, the write_xml method of Aranea::XML::Aranea will call this method automatically.