GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ASTRO::ADS::RESULT (3)

.ds Aq ’

NAME

Astro::ADS::Result - Results from an ADS Query

CONTENTS

SYNOPSIS



  $result = new Astro::ADS::Result( Papers => \@papers );



DESCRIPTION

Stores the results returned from an ADS search as an array of Astro::ADS::Result::Paper objects.

REVISION

$Id: Result.pm,v 1.14 2001/12/03 03:41:45 aa Exp $

METHODS

    Constructor

<B>newB> Create a new instance from a hash of options



  $result = new Astro::ADS::Result( Papers => \@papers );



returns a reference to an ADS Result object.

    Accessor Methods

<B>sizeofB> Return the number of papers in the Astro::ADS::Result object.



   $paper = $result->sizeof();



<B>pushpaperB> Push a new paper onto the end of the Astro::ADS::Result object



   $result->pushpaper( $paper );



returns the number of papers now in the Result object.

<B>poppaperB> Pop a paper from the end of the Astro::ADS::Result object



   $paper = $result->poppaper();



the method deletes the paper and returns the deleted paper object.

<B>papersB> Return a list of all the Astro::ADS::Result::Paper objects stored in the results object.



  @papers = $result->papers;



<B>paperbyindexB> Return the Astro::ADS::Result::Paper object at index $index



   $paper = $result->paperbyindex( $index );



the first paper is at index 0 (not 1). Returns undef if no arguements are provided.

    General Methods

<B>configureB> Configures the object, takes an options hash as argument



  $result->configure( %options );



Takes a hash as argument with the following keywords:
<B>PapersB> An reference to an array of Astro::ADS::Result::Paper objects.

Does nothing if these keys are not supplied.

<B>summaryB> Return a summary of the object as either plain text table or in XML. Simply invokes the summary method of each paper in turn and combines the results as a single string.

The arguments are passed through to the summary method unchanged.

<B>stringifyB> Method called automatically when the object is printed in a string context. Simple invokes the summary() method with default arguments.

COPYRIGHT

Copyright (C) 2001 University of Exeter. All Rights Reserved.

This program was written as part of the eSTAR project and is free software; you can redistribute it and/or modify it under the terms of the GNU Public License.

AUTHORS

Alasdair Allan <aa@astro.ex.ac.uk>,
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 RESULT (3) 2014-06-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.