Constructor

new

Create a new instance from a hash of options

  $paper = new Astro::ADS::Result::Paper( Bibcode   => $bibcode,
                                          Title     => $title,
                                          Authors   => \@authors,
                                          Affil     => \@affil,
                                          Journal   => $journal_refernce,
                                          Published => $published,
                                          Keywords  => \@keywords,
                                          Origin    => $journal,
                                          Links     => \@outbound_links,
                                          URL       => $abstract_url,
                                          Abstract  => \@abstract,
                                          Object    => $object,
                                          Score     => $score );
    

returns a reference to an ADS paper object.

Accessor Methods

bibcode

Return (or set) the bibcode for the paper

   $bibcode = $paper->bibcode();
   $paper->bibcode( $bibcode );
    

title

Return (or set) the title for the paper

   $title = $paper->title();
   $paper->title( $title );
    

Authors

Return (or set) the authors for the paper

   @authors = $paper->authors();
   $first_author = $paper->authors();
   $paper->authors( \@authors );
    

if called in a scalar context it will return the first author.

affil

Return (or set) the affiliation of each author for the paper

   @institutions = $paper->affil();
   $first_author_inst = $paper->affil();
   $paper->affil( \@institutions );
    

if called in a scalar context it will return the affiliation of the first author.

Journal

Return (or set) the journal reference for the paper

   $journal_ref = $paper->journal();
   $paper->journal( $journal_ref );
    

Published

Return (or set) the month and year when the paper was published.

   $published = $paper->published();
   $paper->published( $published );
    

keywords

Return (or set) the different keywords the paper is indexed by, could include such keys as ACCRETION DISCS, WHITE DWARFS, etc.

   @keywords = $paper->keywords();
   $paper->keywords( \@keywords );
    

if called in a scalar context it will return the number of keywords.

origin

Return (or set) the origin of the paper in the ADS archive, this is not necessarily the journal in which the paper was published, but could be set to AUTHOR, ADS or SIMBAD for instance.

   $source = $paper->origin();
   $paper->origin( $source );
    

links

Return (or set) the different type of outbounds links offered by ADS for this paper, examples include ABSTRACT, EJOURNAL, ARTICLE, REFERENCES, CITATIONS, SIMBAD objects etc.

   @outbound_links = $paper->links();
   $paper->links( \@outbound_links );
    

if called in a scalar context it will return the number of outbound links available.

url

Return (or set) the URL pointing to the paper at the ADS

   $adsurl = $paper->url();
   $paper->url( $adsurl );
    

abstract

Return (or set) the abstract of the paper, this may be either the full text of the abstract, or a URL pointing to the scanned abstract at the ADS.

   @abstract = $paper->abstract();
   $paper->abstract( @abstract );
    

if called in a scalar context it will return the number of lines of text in the abstract.

object

Return (or set) the object tag for the paper.

   $object = $paper->object();
   $paper->object( $object );
    

score

Return (or set) the score for the paper generated by the weightings of the different query criteria.

   $score = $paper->score();
   $paper->score( $score );
    

Followup Queries

references

Returns an Astro::ADS::Result object containing the references for the paper.

   $result = $paper->references();
    

returns undef if this external link type is not available for this paper.

citations

Returns an Astro::ADS::Result object containing the citations for the paper.

   $result = $paper->citations();
    

returns undef if this external link type is not available for this paper.

alsoread

Returns an Astro::ADS::Result object containing papers which were `also read' along with this paper.

   $result = $paper->alsoread();
    

returns undef if this external link type is not available for this paper.

tableofcontents

Returns an Astro::ADS::Result object containing the table of contents of the journal or proceedings.

   $result = $paper->tableofcontents();
    

returns undef if this external link type is not available for this paper.

General Methods

configure

Configures the object from multiple pieces of information.

  $paper->configure( %options );
    

Takes a hash as argument with the following keywords:

summary

Return a summary of the paper in either XML or ASCII tabular format.

  $summary = $paper->summary( format => "XML" );
    

Takes a hash as argument. The following keys are supported:

stringify

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